Package com.intellij.codeInsight.highlighting

Class HighlightUsagesHandlerBase<T extends PsiElement>

java.lang.Object

com.intellij.codeInsight.highlighting.HighlightUsagesHandlerBase<T>

Direct Known Subclasses:

GrHighlightExitPointHandler, HighlightBreakOutsHandler, HighlightExitPointsHandler, HighlightImportedElementsHandler, HighlightOverridingMethodsHandler, PyHighlightExitPointsHandler, ShOccurrencesHighlightUsagesHandler

public abstract class HighlightUsagesHandlerBase<T extends PsiElement>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Editor	myEditor
protected PsiFile	myFile
protected java.lang.String	myHintText
protected java.util.List<TextRange>	myReadUsages
protected java.lang.String	myStatusText
protected java.util.List<TextRange>	myWriteUsages

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HighlightUsagesHandlerBase(Editor editor, PsiFile file)

Method Summary

Modifier and Type	Method and Description
protected void	addOccurrence(PsiElement element)
protected void	buildStatusText(java.lang.String elementName, int refCount)
abstract void	computeUsages(java.util.List<? extends T> targets)
java.lang.String	getFeatureId()
java.util.List<TextRange>	getReadUsages()
abstract java.util.List<T>	getTargets()
java.util.List<TextRange>	getWriteUsages()
boolean	highlightReferences() In case of egoistic handler (highlightReferences = false) IdentifierHighlighterPass applies information only from this particular handler.
void	highlightUsages()
protected abstract void	selectTargets(java.util.List<? extends T> targets, Consumer<? super java.util.List<? extends T>> selectionConsumer)

Methods inherited from class java.lang.Object

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

Field Detail

myEditor

protected final Editor myEditor

myFile

protected final PsiFile myFile

myReadUsages

protected java.util.List<TextRange> myReadUsages

myWriteUsages

protected java.util.List<TextRange> myWriteUsages

myStatusText

protected java.lang.String myStatusText

myHintText

protected java.lang.String myHintText

Constructor Detail

HighlightUsagesHandlerBase

protected HighlightUsagesHandlerBase(Editor editor,
                                     PsiFile file)

Method Detail

highlightUsages

public void highlightUsages()

buildStatusText

protected void buildStatusText(java.lang.String elementName,
                               int refCount)

getTargets

public abstract java.util.List<T> getTargets()

getFeatureId

public java.lang.String getFeatureId()

selectTargets

protected abstract void selectTargets(java.util.List<? extends T> targets,
                                      Consumer<? super java.util.List<? extends T>> selectionConsumer)

computeUsages

public abstract void computeUsages(java.util.List<? extends T> targets)

addOccurrence

protected void addOccurrence(PsiElement element)

getReadUsages

public java.util.List<TextRange> getReadUsages()

getWriteUsages

public java.util.List<TextRange> getWriteUsages()

highlightReferences

public boolean highlightReferences()

In case of egoistic handler (highlightReferences = false) IdentifierHighlighterPass applies information only from this particular handler. Otherwise additional information would be collected from reference search as well.