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

Interface HighlightProvider<T>

All Superinterfaces:

com.intellij.openapi.Disposable

All Known Subinterfaces:

LineHighlightProvider<T>, LineRangeHighlightProvider<T>, TextRangeHighlightProvider<T>, TypedRangeHighlightProvider<R,T>, WordHighlightProvider<T>

All Known Implementing Classes:

HighlightProviderBase, LineHighlightProviderBase, LineRangeHighlightProviderBase, TextRangeHighlightProviderBase, TypedRangeHighlightProviderBase, WordHighlightProviderBase

public interface HighlightProvider<T>
extends com.intellij.openapi.Disposable

Nested Class Summary

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

com.intellij.openapi.Disposable.Parent

Method Summary

Modifier and Type	Method	Description
void	addHighlightListener(@NotNull HighlightListener highlightListener, @NotNull com.intellij.openapi.Disposable parent)
void	clearHighlights()
void	disposeComponent()
void	endHighlightSet()
void	enterUpdateRegion()
void	fireHighlightsChanged()
void	fireHighlightsUpdated()
@Nullable com.intellij.openapi.editor.markup.TextAttributes	getHighlightAttributes(int index, int flags, int startOffset, int endOffset, @Nullable java.awt.Color foregroundColor, @Nullable java.awt.Color effectColor, @Nullable com.intellij.openapi.editor.markup.EffectType effectType, int fontType)
Highlighter<T>	getHighlighter(@NotNull com.intellij.openapi.editor.Editor editor)
boolean	haveHighlights()
default void	highlightSet(int skipSets, @NotNull java.lang.Runnable runnable)
default void	highlightSet(@NotNull java.lang.Runnable runnable)
void	initComponent()
boolean	isHighlightsMode()
boolean	isShowHighlights()
void	leaveUpdateRegion()
void	removeHighlightListener(HighlightListener highlightListener)
void	restartHighlightSet(int index)	Provide an index, if > than last will change last to this value
void	setHighlightsMode(boolean highlightsMode)
void	settingsChanged(ColorIterable colors, T settings)
default void	startHighlightSet()
void	startHighlightSet(int skipSets)

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Method Detail

settingsChanged

void settingsChanged(ColorIterable colors,
                     T settings)

clearHighlights

void clearHighlights()

haveHighlights

boolean haveHighlights()

isHighlightsMode

boolean isHighlightsMode()

setHighlightsMode

void setHighlightsMode(boolean highlightsMode)

isShowHighlights

boolean isShowHighlights()

initComponent

void initComponent()

disposeComponent

void disposeComponent()

enterUpdateRegion

void enterUpdateRegion()

leaveUpdateRegion

void leaveUpdateRegion()

addHighlightListener

void addHighlightListener(@NotNull
                          @NotNull HighlightListener highlightListener,
                          @NotNull
                          @NotNull com.intellij.openapi.Disposable parent)

removeHighlightListener

void removeHighlightListener(HighlightListener highlightListener)

fireHighlightsChanged

void fireHighlightsChanged()

fireHighlightsUpdated

void fireHighlightsUpdated()

getHighlightAttributes

@Nullable
@Nullable com.intellij.openapi.editor.markup.TextAttributes getHighlightAttributes(int index,
                                                                                   int flags,
                                                                                   int startOffset,
                                                                                   int endOffset,
                                                                                   @Nullable
                                                                                   @Nullable java.awt.Color foregroundColor,
                                                                                   @Nullable
                                                                                   @Nullable java.awt.Color effectColor,
                                                                                   @Nullable
                                                                                   @Nullable com.intellij.openapi.editor.markup.EffectType effectType,
                                                                                   int fontType)

getHighlighter

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

startHighlightSet

default void startHighlightSet()

startHighlightSet

void startHighlightSet(int skipSets)

restartHighlightSet

void restartHighlightSet(int index)

Provide an index, if > than last will change last to this value

Parameters:

index - color index

endHighlightSet

void endHighlightSet()

highlightSet

default void highlightSet(@NotNull
                          @NotNull java.lang.Runnable runnable)

highlightSet

default void highlightSet(int skipSets,
                          @NotNull
                          @NotNull java.lang.Runnable runnable)