Package com.intellij.usages

Interface UsageTarget

All Superinterfaces:

Navigatable, NavigationItem

All Known Subinterfaces:

ConfigurableUsageTarget, PsiElementUsageTarget

All Known Implementing Classes:

FindInProjectUtil.StringUsageTarget, PsiElement2UsageTargetAdapter, XPathEvalAction.MyUsageTarget

public interface UsageTarget
extends NavigationItem

Field Summary

Fields

Modifier and Type	Field and Description
static UsageTarget[]	EMPTY_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Method Summary

Modifier and Type	Method and Description
void	findUsages() Should open usage view and look for usages
default void	findUsagesInEditor(FileEditor editor) Should look for usages in one specific editor.
default VirtualFile []	getFiles()
default void	highlightUsages(PsiFile file, Editor editor, boolean clearHighlights)
default boolean	isReadOnly()
boolean	isValid()
default void	update()

Methods inherited from interface com.intellij.navigation.NavigationItem

getName, getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Field Detail

EMPTY_ARRAY

static final UsageTarget[] EMPTY_ARRAY

Method Detail

isValid

boolean isValid()

findUsages

void findUsages()

Should open usage view and look for usages

findUsagesInEditor

default void findUsagesInEditor(FileEditor editor)

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

highlightUsages

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

isReadOnly

default boolean isReadOnly()

getFiles

default VirtualFile [] getFiles()

Returns:

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

update

default void update()