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

Interface WordHighlightProvider<T>

All Superinterfaces:

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

All Known Implementing Classes:

WordHighlightProviderBase

public interface WordHighlightProvider<T>
extends TypedRangeHighlightProvider<java.lang.String,T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WordHighlightProvider.CaseSensitivity
static class	WordHighlightProvider.Flags

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.IdeHighlight

Field Summary

Fields

Modifier and Type	Field	Description
static WordHighlightProvider.Flags	BEGIN_WORD
static WordHighlightProvider.Flags	CASE_SENSITIVITY
static WordHighlightProvider.Flags	END_WORD
static int	F_BEGIN_WORD
static int	F_CASE_INSENSITIVE
static int	F_CASE_SENSITIVE
static int	F_CASE_SENSITIVITY
static int	F_END_WORD
static int	F_WORD

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

Method Summary

Modifier and Type	Method	Description
default int	addHighlightRange(java.lang.String range, boolean beginWord, boolean endWord, int ideHighlight, @Nullable java.lang.Boolean caseSensitive)
default int	addHighlightRange(java.lang.String range, int orderIndex, boolean beginWord, boolean endWord, int ideHighlight, @Nullable java.lang.Boolean caseSensitive)
default int	encodeFlags(boolean beginWord, boolean endWord, int ideHighlight, @Nullable java.lang.Boolean caseSensitive)
default int	encodeFlags(int ideHighlight)
java.util.regex.Pattern	getHighlightPattern()
boolean	isHighlightCaseSensitive()
boolean	isHighlightWordsMatchBoundary()
void	setHighlightCaseSensitive(boolean highlightCaseSensitive)
void	setHighlightWordsMatchBoundary(boolean highlightWordsMatchBoundary)
void	updateHighlightPattern()

Methods inherited from interface com.intellij.openapi.Disposable

dispose

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

addHighlightListener, clearHighlights, disposeComponent, 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, addHighlightRange, getAdjustedRange, getHighlighter, getHighlightRangeFlags, getHighlightRangeIndex, getHighlightRangeIndices, getMaxHighlightRangeIndex, isRangeHighlighted, removeHighlightRange

Field Detail

BEGIN_WORD

static final WordHighlightProvider.Flags BEGIN_WORD

END_WORD

static final WordHighlightProvider.Flags END_WORD

CASE_SENSITIVITY

static final WordHighlightProvider.Flags CASE_SENSITIVITY

F_BEGIN_WORD

static final int F_BEGIN_WORD

F_END_WORD

static final int F_END_WORD

F_WORD

static final int F_WORD

F_CASE_SENSITIVITY

static final int F_CASE_SENSITIVITY

F_CASE_SENSITIVE

static final int F_CASE_SENSITIVE

F_CASE_INSENSITIVE

static final int F_CASE_INSENSITIVE

Method Detail

encodeFlags

default int encodeFlags(boolean beginWord,
                        boolean endWord,
                        int ideHighlight,
                        @Nullable
                        @Nullable java.lang.Boolean caseSensitive)

encodeFlags

default int encodeFlags(int ideHighlight)

addHighlightRange

default int addHighlightRange(java.lang.String range,
                              boolean beginWord,
                              boolean endWord,
                              int ideHighlight,
                              @Nullable
                              @Nullable java.lang.Boolean caseSensitive)

addHighlightRange

default int addHighlightRange(java.lang.String range,
                              int orderIndex,
                              boolean beginWord,
                              boolean endWord,
                              int ideHighlight,
                              @Nullable
                              @Nullable java.lang.Boolean caseSensitive)

getHighlightPattern

java.util.regex.Pattern getHighlightPattern()

updateHighlightPattern

void updateHighlightPattern()

isHighlightCaseSensitive

boolean isHighlightCaseSensitive()

setHighlightCaseSensitive

void setHighlightCaseSensitive(boolean highlightCaseSensitive)

isHighlightWordsMatchBoundary

boolean isHighlightWordsMatchBoundary()

setHighlightWordsMatchBoundary

void setHighlightWordsMatchBoundary(boolean highlightWordsMatchBoundary)