Package com.vladsch.plugin.util.ui.highlight

Class WordHighlightProviderBase<T>

java.lang.Object

com.vladsch.plugin.util.ui.highlight.HighlightProviderBase<T>

com.vladsch.plugin.util.ui.highlight.TypedRangeHighlightProviderBase<java.lang.String,T>

com.vladsch.plugin.util.ui.highlight.WordHighlightProviderBase<T>

All Implemented Interfaces:

com.intellij.openapi.Disposable, HighlightProvider<T>, TypedRangeHighlightProvider<java.lang.String,T>, WordHighlightProvider<T>

public abstract class WordHighlightProviderBase<T>
extends TypedRangeHighlightProviderBase<java.lang.String,T>
implements WordHighlightProvider<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

com.intellij.openapi.Disposable.Parent

Nested classes/interfaces inherited from interface com.vladsch.plugin.util.ui.highlight.TypedRangeHighlightProvider

TypedRangeHighlightProvider.Flags, TypedRangeHighlightProvider.IdeHighlight

Nested classes/interfaces inherited from interface com.vladsch.plugin.util.ui.highlight.WordHighlightProvider

WordHighlightProvider.CaseSensitivity, WordHighlightProvider.Flags

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String[]	EMPTY_STRINGS

Fields inherited from class com.vladsch.plugin.util.ui.highlight.HighlightProviderBase

myDelayedRunner, myHighlightColorRepeatIndex, myHighlightColors, myHighlightsMode, myInUpdateRegion, myLafManagerListener, myPendingChanged, mySettings

Fields inherited from interface com.vladsch.plugin.util.ui.highlight.TypedRangeHighlightProvider

ERROR_ATTRIBUTES_KEY, F_IDE_ERROR, F_IDE_HIGHLIGHT, F_IDE_IGNORED, F_IDE_WARNING, F_NONE, IDE_HIGHLIGHT, IGNORED_ATTRIBUTES_KEY, TYPO_ATTRIBUTES_KEY, WARNING_ATTRIBUTES_KEY

Fields inherited from interface com.vladsch.plugin.util.ui.highlight.WordHighlightProvider

BEGIN_WORD, CASE_SENSITIVITY, END_WORD, F_BEGIN_WORD, F_CASE_INSENSITIVE, F_CASE_SENSITIVE, F_CASE_SENSITIVITY, F_END_WORD, F_WORD

Constructor Summary

Constructors

Constructor	Description
WordHighlightProviderBase(T settings)

Method Summary

Modifier and Type	Method	Description
int	addHighlightRange(java.lang.String range, int flags, int originalIndex)	Add highlight range
void	clearHighlights()
void	clearHighlightsRaw()
void	disposeComponent()
@NotNull java.lang.String	getAdjustedRange(@NotNull java.lang.String range)	Used to adjust for things like case sensitivity otherwise in case insensitive mode the lookup in the map will fail
WordHighlighter<T>	getHighlighter(@NotNull com.intellij.openapi.editor.Editor editor)
@Nullable java.util.regex.Pattern	getHighlightPattern()
int	getHighlightRangeIndex(java.lang.String range)	Must call getHighlightPattern() before calling this function for the first time to ensure the cached structures are updated.
protected @Nullable java.util.HashMap<java.lang.String,com.vladsch.flexmark.util.misc.Pair<java.lang.Integer,java.lang.Integer>>	getHighlightState()
protected void	highlightRangeAdded(java.lang.String range, int flags, int originalOrderIndex)
protected void	highlightRangeRemoved(java.lang.String range)
boolean	isHighlightCaseSensitive()
boolean	isHighlightWordsMatchBoundary()
boolean	isRangeHighlighted(java.lang.String range)
void	removeHighlightRange(java.lang.String range)	NOTE: does not call getAdjustedRange() because the subclass needs to take care of all adjustments here
void	setHighlightCaseSensitive(boolean highlightCaseSensitive)
protected void	setHighlightState(@NotNull java.util.Map<java.lang.String,com.vladsch.flexmark.util.misc.Pair<java.lang.Integer,java.lang.Integer>> state)	Restore highlight state
void	setHighlightWordsMatchBoundary(boolean highlightWordsMatchBoundary)
void	updateHighlightPattern()

Methods inherited from class com.vladsch.plugin.util.ui.highlight.TypedRangeHighlightProviderBase

getHighlightAttributes, getHighlightIndex, getHighlightRangeFlags, getHighlightRangeIndices, getIdeAttributes, getMaxHighlightRangeIndex, getOriginalIndexMap, getOriginalOrderIndex, haveHighlights, isShowHighlights, setHighlightIndex, skipHighlightSets

Methods inherited from class com.vladsch.plugin.util.ui.highlight.HighlightProviderBase

addHighlightListener, dispose, endHighlightSet, enterUpdateRegion, fireHighlightsChanged, fireHighlightsUpdated, getCancellableJobScheduler, getColors, getDelayedRunner, getHighlightColorRepeatIndex, getHighlightColors, initComponent, isHighlightsMode, isInHighlightSet, leaveUpdateRegion, removeHighlightListener, restartHighlightSet, setHighlightsMode, settingsChanged, startHighlightSet, startHighlightSet, subscribeSettingsChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Methods inherited from interface com.vladsch.plugin.util.ui.highlight.HighlightProvider

addHighlightListener, endHighlightSet, enterUpdateRegion, fireHighlightsChanged, fireHighlightsUpdated, getHighlightAttributes, haveHighlights, highlightSet, highlightSet, initComponent, isHighlightsMode, isShowHighlights, leaveUpdateRegion, removeHighlightListener, restartHighlightSet, setHighlightsMode, settingsChanged, startHighlightSet, startHighlightSet

Methods inherited from interface com.vladsch.plugin.util.ui.highlight.TypedRangeHighlightProvider

addHighlightRange, getHighlightRangeFlags, getHighlightRangeIndices, getMaxHighlightRangeIndex

Methods inherited from interface com.vladsch.plugin.util.ui.highlight.WordHighlightProvider

addHighlightRange, addHighlightRange, encodeFlags, encodeFlags

Field Detail

EMPTY_STRINGS

public static final java.lang.String[] EMPTY_STRINGS

Constructor Detail

WordHighlightProviderBase

public WordHighlightProviderBase(@NotNull
                                 T settings)

Method Detail

getHighlighter

public WordHighlighter<T> getHighlighter(@NotNull
                                         @NotNull com.intellij.openapi.editor.Editor editor)

Specified by:

getHighlighter in interface HighlightProvider<T>

Specified by:

getHighlighter in interface TypedRangeHighlightProvider<java.lang.String,T>

getHighlightState

@Nullable
protected @Nullable java.util.HashMap<java.lang.String,com.vladsch.flexmark.util.misc.Pair<java.lang.Integer,java.lang.Integer>> getHighlightState()

Overrides:

getHighlightState in class TypedRangeHighlightProviderBase<java.lang.String,T>

setHighlightState

protected void setHighlightState(@NotNull
                                 @NotNull java.util.Map<java.lang.String,com.vladsch.flexmark.util.misc.Pair<java.lang.Integer,java.lang.Integer>> state)

Description copied from class: TypedRangeHighlightProviderBase

Restore highlight state

Overrides:

setHighlightState in class TypedRangeHighlightProviderBase<java.lang.String,T>

Parameters:

state - highlight state previously returned by TypedRangeHighlightProviderBase.getHighlightState()

disposeComponent

public void disposeComponent()

Specified by:

disposeComponent in interface HighlightProvider<T>

Overrides:

disposeComponent in class TypedRangeHighlightProviderBase<java.lang.String,T>

clearHighlightsRaw

public void clearHighlightsRaw()

Overrides:

clearHighlightsRaw in class TypedRangeHighlightProviderBase<java.lang.String,T>

clearHighlights

public void clearHighlights()

Specified by:

clearHighlights in interface HighlightProvider<T>

Overrides:

clearHighlights in class TypedRangeHighlightProviderBase<java.lang.String,T>

getHighlightPattern

@Nullable
public @Nullable java.util.regex.Pattern getHighlightPattern()

Specified by:

getHighlightPattern in interface WordHighlightProvider<T>

isRangeHighlighted

public final boolean isRangeHighlighted(java.lang.String range)

Specified by:

isRangeHighlighted in interface TypedRangeHighlightProvider<java.lang.String,T>

Overrides:

isRangeHighlighted in class TypedRangeHighlightProviderBase<java.lang.String,T>

getHighlightRangeIndex

public int getHighlightRangeIndex(java.lang.String range)

Must call getHighlightPattern() before calling this function for the first time to ensure the cached structures are updated.

Specified by:

getHighlightRangeIndex in interface TypedRangeHighlightProvider<java.lang.String,T>

Overrides:

getHighlightRangeIndex in class TypedRangeHighlightProviderBase<java.lang.String,T>

Parameters:

range - highlighted word

Returns:

original index of word

isHighlightCaseSensitive

public boolean isHighlightCaseSensitive()

Specified by:

isHighlightCaseSensitive in interface WordHighlightProvider<T>

setHighlightCaseSensitive

public void setHighlightCaseSensitive(boolean highlightCaseSensitive)

Specified by:

setHighlightCaseSensitive in interface WordHighlightProvider<T>

isHighlightWordsMatchBoundary

public boolean isHighlightWordsMatchBoundary()

Specified by:

isHighlightWordsMatchBoundary in interface WordHighlightProvider<T>

setHighlightWordsMatchBoundary

public void setHighlightWordsMatchBoundary(boolean highlightWordsMatchBoundary)

Specified by:

setHighlightWordsMatchBoundary in interface WordHighlightProvider<T>

getAdjustedRange

@NotNull
public @NotNull java.lang.String getAdjustedRange(@NotNull
                                                  @NotNull java.lang.String range)

Description copied from interface: TypedRangeHighlightProvider

Used to adjust for things like case sensitivity otherwise in case insensitive mode the lookup in the map will fail

Specified by:

getAdjustedRange in interface TypedRangeHighlightProvider<java.lang.String,T>

Parameters:

range - range to look up

Returns:

adjusted range

addHighlightRange

public int addHighlightRange(java.lang.String range,
                             int flags,
                             int originalIndex)

Description copied from interface: TypedRangeHighlightProvider

Add highlight range

Specified by:

addHighlightRange in interface TypedRangeHighlightProvider<java.lang.String,T>

Overrides:

addHighlightRange in class TypedRangeHighlightProviderBase<java.lang.String,T>

Parameters:

range - range object for highlight

flags - flags for the highlight

originalIndex - index to use if >0, else use next index

Returns:

order index used for the highlight

removeHighlightRange

public final void removeHighlightRange(java.lang.String range)

Description copied from class: TypedRangeHighlightProviderBase

NOTE: does not call getAdjustedRange() because the subclass needs to take care of all adjustments here

Specified by:

removeHighlightRange in interface TypedRangeHighlightProvider<java.lang.String,T>

Overrides:

removeHighlightRange in class TypedRangeHighlightProviderBase<java.lang.String,T>

Parameters:

range - range to remove

highlightRangeAdded

protected void highlightRangeAdded(java.lang.String range,
                                   int flags,
                                   int originalOrderIndex)

Specified by:

highlightRangeAdded in class TypedRangeHighlightProviderBase<java.lang.String,T>

highlightRangeRemoved

protected void highlightRangeRemoved(java.lang.String range)

Specified by:

highlightRangeRemoved in class TypedRangeHighlightProviderBase<java.lang.String,T>

updateHighlightPattern

public void updateHighlightPattern()

Specified by:

updateHighlightPattern in interface WordHighlightProvider<T>