Package com.intellij.find.impl

Class FindInProjectUtil.StringUsageTarget

java.lang.Object

com.intellij.find.impl.FindInProjectUtil.StringUsageTarget

All Implemented Interfaces:

ItemPresentation, NavigationItem, TypeSafeDataProvider, Navigatable, ConfigurableUsageTarget, UsageTarget

Enclosing class:

FindInProjectUtil

public static class FindInProjectUtil.StringUsageTarget
extends java.lang.Object
implements ConfigurableUsageTarget, ItemPresentation, TypeSafeDataProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected FindModel	myFindModel
protected Project	myProject

Fields inherited from interface com.intellij.usages.UsageTarget

EMPTY_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
StringUsageTarget(Project project, FindModel findModel)

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).
void	findUsages() Should open usage view and look for usages
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()
KeyboardShortcut	getShortcut()
boolean	isValid()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
void	showSettings()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.usages.UsageTarget

findUsagesInEditor, getFiles, highlightUsages, isReadOnly, update

Field Detail

myProject

protected final Project myProject

myFindModel

protected final FindModel myFindModel

Constructor Detail

StringUsageTarget

public StringUsageTarget(Project project,
                         FindModel findModel)

Method Detail

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.

getLongDescriptiveName

public java.lang.String getLongDescriptiveName()

Specified by:

getLongDescriptiveName in interface ConfigurableUsageTarget

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.

findUsages

public void findUsages()

Description copied from interface: UsageTarget

Should open usage view and look for usages

Specified by:

findUsages in interface UsageTarget

isValid

public boolean isValid()

Specified by:

isValid in interface UsageTarget

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.

showSettings

public void showSettings()

Specified by:

showSettings in interface ConfigurableUsageTarget

getShortcut

public KeyboardShortcut getShortcut()

Specified by:

getShortcut in interface ConfigurableUsageTarget

calcData

public void calcData(DataKey key,
                     DataSink sink)

Specified by:

calcData in interface TypeSafeDataProvider