Package com.intellij.util

Class OpenSourceUtil

java.lang.Object

com.intellij.util.OpenSourceUtil

public class OpenSourceUtil
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static boolean	canNavigate(java.lang.Object object)
static boolean	canNavigateToSource(java.lang.Object object)
static boolean	navigate(boolean requestFocus, boolean tryNotToScroll, java.lang.Iterable<? extends Navigatable> navigatables) Navigates to all available sources or to the first navigatable that represents non-source navigation.
static void	navigate(boolean requestFocus, boolean tryNotToScroll, Navigatable... navigatables) Invokes navigate(boolean, boolean, Iterable) if at least one navigatable exists
static void	navigate(boolean requestFocus, Navigatable... navigatables) Invokes navigate(boolean, boolean, Navigatable...) that does not try to preserve a state of a corresponding editor.
static void	navigate(Navigatable... navigatables) Invokes navigate(boolean, Navigatable...) that always requests focus.
static boolean	navigateToSource(boolean requestFocus, boolean tryNotToScroll, java.lang.Iterable<? extends Navigatable> navigatables) Navigates to all available sources of the specified navigatables.
static boolean	navigateToSource(boolean requestFocus, boolean tryNotToScroll, Navigatable navigatable) Navigates to source of the specified navigatable.
static void	openSourcesFrom(DataContext context, boolean requestFocus)
static void	openSourcesFrom(DataProvider context, boolean requestFocus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

openSourcesFrom

public static void openSourcesFrom(DataContext context,
                                   boolean requestFocus)

openSourcesFrom

public static void openSourcesFrom(DataProvider context,
                                   boolean requestFocus)

canNavigate

public static boolean canNavigate(java.lang.Object object)

Returns:

true if the specified object is Navigatable and supports navigation

canNavigateToSource

public static boolean canNavigateToSource(java.lang.Object object)

Returns:

true if the specified object is Navigatable and supports navigation to source

navigate

public static void navigate(Navigatable... navigatables)

Invokes navigate(boolean, Navigatable...) that always requests focus.

navigate

public static void navigate(boolean requestFocus,
                            Navigatable... navigatables)

Invokes navigate(boolean, boolean, Navigatable...) that does not try to preserve a state of a corresponding editor.

navigate

public static void navigate(boolean requestFocus,
                            boolean tryNotToScroll,
                            Navigatable... navigatables)

Invokes navigate(boolean, boolean, Iterable) if at least one navigatable exists

navigate

public static boolean navigate(boolean requestFocus,
                               boolean tryNotToScroll,
                               java.lang.Iterable<? extends Navigatable> navigatables)

Navigates to all available sources or to the first navigatable that represents non-source navigation.

Parameters:

requestFocus - specifies whether a focus should be requested or not

tryNotToScroll - specifies whether a corresponding editor should preserve its state if it is possible

navigatables - an iterable collection of navigatables

Returns:

true if at least one navigatable was processed, false otherwise

navigateToSource

public static boolean navigateToSource(boolean requestFocus,
                                       boolean tryNotToScroll,
                                       java.lang.Iterable<? extends Navigatable> navigatables)

Navigates to all available sources of the specified navigatables.

Parameters:

requestFocus - specifies whether a focus should be requested or not

tryNotToScroll - specifies whether a corresponding editor should preserve its state if it is possible

navigatables - an iterable collection of navigatables

Returns:

true if at least one navigatable was processed, false otherwise

navigateToSource

public static boolean navigateToSource(boolean requestFocus,
                                       boolean tryNotToScroll,
                                       Navigatable navigatable)

Navigates to source of the specified navigatable.

Parameters:

requestFocus - specifies whether a focus should be requested or not

tryNotToScroll - specifies whether a corresponding editor should preserve its state if it is possible

Returns:

true if navigation is done, false otherwise