Package com.intellij.pom

Class NavigatableAdapter

java.lang.Object

com.intellij.pom.NavigatableAdapter

All Implemented Interfaces:

Navigatable

public abstract class NavigatableAdapter
extends java.lang.Object
implements Navigatable

Very often both methods canNavigate and canNavigateToSource return true. This adapter class lets focus on navigation routine only.

Constructor Summary

Constructors

Constructor and Description
NavigatableAdapter()

Method Summary

Modifier and Type	Method and Description
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canNavigateToSource() Indicates whether this instance supports navigation to source (that means some kind of editor).
static void	navigate(Project project, VirtualFile file, boolean requestFocus)
static void	navigate(Project project, VirtualFile file, int offset, boolean requestFocus)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.pom.Navigatable

navigate

Constructor Detail

NavigatableAdapter

public NavigatableAdapter()

Method Detail

canNavigate

public boolean canNavigate()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.

Specified by:

canNavigate in interface Navigatable

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.

Specified by:

canNavigateToSource in interface Navigatable

Returns:

false if navigation to source is not possible for any reason.

navigate

public static void navigate(Project project,
                            VirtualFile file,
                            boolean requestFocus)

navigate

public static void navigate(Project project,
                            VirtualFile file,
                            int offset,
                            boolean requestFocus)