Package com.intellij.usages.impl

Class UsageAdapter

java.lang.Object

com.intellij.usages.impl.UsageAdapter

All Implemented Interfaces:

Navigatable, Usage

Direct Known Subclasses:

NullUsage, UnknownUsagesInUnloadedModules

public class UsageAdapter
extends java.lang.Object
implements Usage

Field Summary

Fields inherited from interface com.intellij.usages.Usage

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
UsageAdapter()

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).
FileEditorLocation	getLocation()
UsagePresentation	getPresentation()
void	highlightInEditor()
boolean	isReadOnly()
boolean	isValid()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
void	selectInEditor()

Methods inherited from class java.lang.Object

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

Constructor Detail

UsageAdapter

public UsageAdapter()

Method Detail

getPresentation

public UsagePresentation getPresentation()

Specified by:

getPresentation in interface Usage

isValid

public boolean isValid()

Specified by:

isValid in interface Usage

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Usage

getLocation

public FileEditorLocation getLocation()

Specified by:

getLocation in interface Usage

selectInEditor

public void selectInEditor()

Specified by:

selectInEditor in interface Usage

highlightInEditor

public void highlightInEditor()

Specified by:

highlightInEditor in interface Usage

navigate

public void navigate(boolean requestFocus)

Description copied from interface: Navigatable

Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package

Specified by:

navigate in interface Navigatable

Parameters:

requestFocus - true if focus requesting is necessary

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.