Package com.intellij.find.findUsages

Class PsiElement2UsageTargetAdapter

java.lang.Object

com.intellij.find.findUsages.PsiElement2UsageTargetAdapter

All Implemented Interfaces:

ItemPresentation, NavigationItem, PsiElementNavigationItem, TypeSafeDataProvider, Navigatable, ConfigurableUsageTarget, PsiElementUsageTarget, UsageTarget

public class PsiElement2UsageTargetAdapter
extends java.lang.Object
implements PsiElementUsageTarget, TypeSafeDataProvider, PsiElementNavigationItem, ItemPresentation, ConfigurableUsageTarget

Field Summary

Fields

Modifier and Type	Field and Description
protected FindUsagesOptions	myOptions

Fields inherited from interface com.intellij.usages.UsageTarget

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiElement2UsageTargetAdapter(PsiElement element)
PsiElement2UsageTargetAdapter(PsiElement element, FindUsagesOptions options)

Method Summary

Modifier and Type	Method and Description
void	calcData(DataKey key, DataSink sink)
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 PsiElement2UsageTargetAdapter []	convert(PsiElement [] psiElements)
void	findUsages() Should open usage view and look for usages
void	findUsagesInEditor(FileEditor editor) Should look for usages in one specific editor.
PsiElement	getElement()
VirtualFile[]	getFiles()
javax.swing.Icon	getIcon(boolean open) Returns the icon representing the object.
java.lang.String	getLocationString() Returns the location of the object (for example, the package of a class).
java.lang.String	getLongDescriptiveName()
java.lang.String	getName()
java.lang.String	getPresentableText() Returns the name of the object to be presented in most renderers across the program.
ItemPresentation	getPresentation()
Project	getProject()
KeyboardShortcut	getShortcut()
PsiElement	getTargetElement()
void	highlightUsages(PsiFile file, Editor editor, boolean clearHighlights)
boolean	isReadOnly()
boolean	isValid()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
void	showSettings()
java.lang.String	toString()
void	update()

Methods inherited from class java.lang.Object

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

Field Detail

myOptions

protected final FindUsagesOptions myOptions

Constructor Detail

PsiElement2UsageTargetAdapter

public PsiElement2UsageTargetAdapter(PsiElement element,
                                     FindUsagesOptions options)

PsiElement2UsageTargetAdapter

public PsiElement2UsageTargetAdapter(PsiElement element)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface NavigationItem

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

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.

getTargetElement

public PsiElement getTargetElement()

Specified by:

getTargetElement in interface PsiElementNavigationItem

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

findUsages

public void findUsages()

Description copied from interface: UsageTarget

Should open usage view and look for usages

Specified by:

findUsages in interface UsageTarget

getElement

public PsiElement getElement()

Specified by:

getElement in interface PsiElementUsageTarget

findUsagesInEditor

public void findUsagesInEditor(FileEditor editor)

Description copied from interface: UsageTarget

Should look for usages in one specific editor. This typicaly shows other kind of dialog and doesn't result in usage view display.

Specified by:

findUsagesInEditor in interface UsageTarget

highlightUsages

public void highlightUsages(PsiFile file,
                            Editor editor,
                            boolean clearHighlights)

Specified by:

highlightUsages in interface UsageTarget

isValid

public boolean isValid()

Specified by:

isValid in interface UsageTarget

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface UsageTarget

getFiles

public VirtualFile[] getFiles()

Specified by:

getFiles in interface UsageTarget

Returns:

the files this usage target is in. Might be null if usage target is not file-based

convert

public static PsiElement2UsageTargetAdapter [] convert(PsiElement [] psiElements)

calcData

public void calcData(DataKey key,
                     DataSink sink)

Specified by:

calcData in interface TypeSafeDataProvider

getShortcut

public KeyboardShortcut getShortcut()

Specified by:

getShortcut in interface ConfigurableUsageTarget

getLongDescriptiveName

public java.lang.String getLongDescriptiveName()

Specified by:

getLongDescriptiveName in interface ConfigurableUsageTarget

showSettings

public void showSettings()

Specified by:

showSettings in interface ConfigurableUsageTarget

update

public void update()

Specified by:

update in interface UsageTarget

getPresentableText

public java.lang.String getPresentableText()

Description copied from interface: ItemPresentation

Returns the name of the object to be presented in most renderers across the program.

Specified by:

getPresentableText in interface ItemPresentation

Returns:

the object name.

getLocationString

public java.lang.String getLocationString()

Description copied from interface: ItemPresentation

Returns the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

Specified by:

getLocationString in interface ItemPresentation

Returns:

the location description, or null if none is applicable.

getIcon

public javax.swing.Icon getIcon(boolean open)

Description copied from interface: ItemPresentation

Returns the icon representing the object.

Specified by:

getIcon in interface ItemPresentation

Parameters:

open - Used to mean if open/close icons for tree renderer. No longer in use. The parameter is only there for API compatibility reason.

getProject

public Project getProject()