Package com.intellij.find.findUsages

Class FindUsagesHandlerBase

java.lang.Object

com.intellij.find.findUsages.FindUsagesHandlerBase

Direct Known Subclasses:

FindUsagesHandler, PyFindUsagesHandler

public class FindUsagesHandlerBase
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected PsiElement	myPsiElement

Constructor Summary

Constructors

Constructor and Description
FindUsagesHandlerBase(PsiElement psiElement)

Method Summary

Modifier and Type	Method and Description
static FindUsagesOptions	createFindUsagesOptions(Project project, DataContext dataContext)
protected ReferencesSearch.SearchParameters	createSearchParameters(PsiElement target, SearchScope searchScope, FindUsagesOptions findUsagesOptions) Returns the parameters for references search of specified PSI element.
java.util.Collection<PsiReference>	findReferencesToHighlight(PsiElement target, SearchScope searchScope)
FindUsagesOptions	getFindUsagesOptions()
FindUsagesOptions	getFindUsagesOptions(DataContext dataContext)
PsiElement []	getPrimaryElements()
Project	getProject()
PsiElement	getPsiElement()
PsiElement []	getSecondaryElements()
protected java.util.Collection<java.lang.String>	getStringsToSearch(PsiElement element)
protected boolean	isSearchForTextOccurencesAvailable(PsiElement psiElement, boolean isSingleFile) Deprecated. use/override isSearchForTextOccurrencesAvailable(PsiElement, boolean) instead
protected boolean	isSearchForTextOccurrencesAvailable(PsiElement psiElement, boolean isSingleFile)
boolean	processElementUsages(PsiElement element, Processor<? super UsageInfo> processor, FindUsagesOptions options)
boolean	processUsagesInText(PsiElement element, Processor<? super UsageInfo> processor, GlobalSearchScope searchScope)

Methods inherited from class java.lang.Object

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

Field Detail

myPsiElement

protected final PsiElement myPsiElement

Constructor Detail

FindUsagesHandlerBase

public FindUsagesHandlerBase(PsiElement psiElement)

Method Detail

getPsiElement

public final PsiElement getPsiElement()

getProject

public final Project getProject()

getPrimaryElements

public PsiElement [] getPrimaryElements()

getSecondaryElements

public PsiElement [] getSecondaryElements()

getFindUsagesOptions

public FindUsagesOptions getFindUsagesOptions()

getFindUsagesOptions

public FindUsagesOptions getFindUsagesOptions(DataContext dataContext)

processElementUsages

public boolean processElementUsages(PsiElement element,
                                    Processor<? super UsageInfo> processor,
                                    FindUsagesOptions options)

processUsagesInText

public boolean processUsagesInText(PsiElement element,
                                   Processor<? super UsageInfo> processor,
                                   GlobalSearchScope searchScope)

getStringsToSearch

protected java.util.Collection<java.lang.String> getStringsToSearch(PsiElement element)

isSearchForTextOccurrencesAvailable

protected boolean isSearchForTextOccurrencesAvailable(PsiElement psiElement,
                                                      boolean isSingleFile)

isSearchForTextOccurencesAvailable

@Deprecated
protected boolean isSearchForTextOccurencesAvailable(PsiElement psiElement,
                                                     boolean isSingleFile)

Deprecated. use/override isSearchForTextOccurrencesAvailable(PsiElement, boolean) instead

findReferencesToHighlight

public java.util.Collection<PsiReference> findReferencesToHighlight(PsiElement target,
                                                                    SearchScope searchScope)

createSearchParameters

protected ReferencesSearch.SearchParameters createSearchParameters(PsiElement target,
                                                                   SearchScope searchScope,
                                                                   FindUsagesOptions findUsagesOptions)

Returns the parameters for references search of specified PSI element. `findUsagesOptions` parameter is null for a call from highlighting pass and not null for a call from `Find Usages` action. The default implementation suggests transferring `findUsagesOptions.fastTrack` value to search parameters. Based on return value the language `referencesSearch`-extensions can add references from declarations and pre-declarations to reference search result, that is forbidden by default.

Parameters:

target - the specified PSI element

searchScope - the scope to search in

findUsagesOptions - the options to search

createFindUsagesOptions

public static FindUsagesOptions createFindUsagesOptions(Project project,
                                                        DataContext dataContext)