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

Interface TypedRangeHighlightProvider<R,T>

All Superinterfaces:

com.intellij.openapi.Disposable, HighlightProvider<T>

All Known Subinterfaces:

TextRangeHighlightProvider<T>, WordHighlightProvider<T>

All Known Implementing Classes:

TextRangeHighlightProviderBase, TypedRangeHighlightProviderBase, WordHighlightProviderBase

public interface TypedRangeHighlightProvider<R,T>
extends HighlightProvider<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TypedRangeHighlightProvider.Flags
static class	TypedRangeHighlightProvider.IdeHighlight

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

com.intellij.openapi.Disposable.Parent

Field Summary

Fields

Modifier and Type	Field	Description
static com.intellij.openapi.editor.colors.TextAttributesKey	ERROR_ATTRIBUTES_KEY
static int	F_IDE_ERROR
static int	F_IDE_HIGHLIGHT
static int	F_IDE_IGNORED
static int	F_IDE_WARNING
static int	F_NONE
static TypedRangeHighlightProvider.Flags	IDE_HIGHLIGHT
static com.intellij.openapi.editor.colors.TextAttributesKey	IGNORED_ATTRIBUTES_KEY
static com.intellij.openapi.editor.colors.TextAttributesKey	TYPO_ATTRIBUTES_KEY
static com.intellij.openapi.editor.colors.TextAttributesKey	WARNING_ATTRIBUTES_KEY

Method Summary

Modifier and Type	Method	Description
default int	addHighlightRange(R range, int flags)
int	addHighlightRange(R range, int flags, int orderIndex)	Add highlight range
R	getAdjustedRange(R range)	Used to adjust for things like case sensitivity otherwise in case insensitive mode the lookup in the map will fail
TypedRangeHighlighter<R,T>	getHighlighter(@NotNull com.intellij.openapi.editor.Editor editor)
@Nullable java.util.Map<R,java.lang.Integer>	getHighlightRangeFlags()	CAUTION: Do Not Use range value get flags for highlighting because implementors are free to modify the range before lookup, like change case NOTE: for lookup use value returned by getAdjustedRange()
int	getHighlightRangeIndex(R range)
@Nullable java.util.Map<R,java.lang.Integer>	getHighlightRangeIndices()	CAUTION: Do Not Use range value get flags for highlighting because implementors are free to modify the range before lookup, like change case NOTE: for lookup use value returned by getAdjustedRange()
int	getMaxHighlightRangeIndex()
boolean	isRangeHighlighted(R range)
void	removeHighlightRange(R range)

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

Field Detail

TYPO_ATTRIBUTES_KEY

static final com.intellij.openapi.editor.colors.TextAttributesKey TYPO_ATTRIBUTES_KEY

ERROR_ATTRIBUTES_KEY

static final com.intellij.openapi.editor.colors.TextAttributesKey ERROR_ATTRIBUTES_KEY

WARNING_ATTRIBUTES_KEY

static final com.intellij.openapi.editor.colors.TextAttributesKey WARNING_ATTRIBUTES_KEY

IGNORED_ATTRIBUTES_KEY

static final com.intellij.openapi.editor.colors.TextAttributesKey IGNORED_ATTRIBUTES_KEY

IDE_HIGHLIGHT

static final TypedRangeHighlightProvider.Flags IDE_HIGHLIGHT

F_IDE_HIGHLIGHT

static final int F_IDE_HIGHLIGHT

F_NONE

static final int F_NONE

F_IDE_WARNING

static final int F_IDE_WARNING

F_IDE_ERROR

static final int F_IDE_ERROR

F_IDE_IGNORED

static final int F_IDE_IGNORED

Method Detail

addHighlightRange

default int addHighlightRange(R range,
                              int flags)

addHighlightRange

int addHighlightRange(R range,
                      int flags,
                      int orderIndex)

Add highlight range

Parameters:

range - range object for highlight

flags - flags for the highlight

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

Returns:

order index used for the highlight

getHighlighter

TypedRangeHighlighter<R,T> getHighlighter(@NotNull
                                                @NotNull com.intellij.openapi.editor.Editor editor)

Specified by:

getHighlighter in interface HighlightProvider<R>

isRangeHighlighted

boolean isRangeHighlighted(R range)

getMaxHighlightRangeIndex

int getMaxHighlightRangeIndex()

getHighlightRangeIndex

int getHighlightRangeIndex(R range)

removeHighlightRange

void removeHighlightRange(R range)

getHighlightRangeFlags

@Nullable
@Nullable java.util.Map<R,java.lang.Integer> getHighlightRangeFlags()

CAUTION: Do Not Use range value get flags for highlighting because implementors are free to modify the range before lookup, like change case NOTE: for lookup use value returned by getAdjustedRange()

Returns:

map of range to highlight flags

getHighlightRangeIndices

@Nullable
@Nullable java.util.Map<R,java.lang.Integer> getHighlightRangeIndices()

CAUTION: Do Not Use range value get flags for highlighting because implementors are free to modify the range before lookup, like change case NOTE: for lookup use value returned by getAdjustedRange()

Returns:

map of range to highlight flags

getAdjustedRange

@NotNull
R getAdjustedRange(@NotNull
                   R range)

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

Parameters:

range - range to look up

Returns:

adjusted range