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

Class LineHighlightProviderBase<T>

java.lang.Object

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

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

All Implemented Interfaces:

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

public abstract class LineHighlightProviderBase<T>
extends HighlightProviderBase<T>
implements LineHighlightProvider<T>

Nested Class Summary

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

com.intellij.openapi.Disposable.Parent

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable java.util.Map<java.lang.Integer,java.lang.Integer>	myHighlightLines
protected int	myOriginalOrderIndex

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

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

Constructor Summary

Constructors

Constructor	Description
LineHighlightProviderBase(T settings)

Method Summary

Modifier and Type	Method	Description
void	addHighlightLine(int line)
void	addHighlightLine(int line, boolean replaceExisting)
void	clearHighlights()
@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)	Must call getHighlightPattern() before calling this function for the first time to ensure the cached structures are updated.
LineHighlighter<T>	getHighlighter(@NotNull com.intellij.openapi.editor.Editor editor)
protected int	getHighlightIndex()
int	getHighlightLineIndex(int line)
@Nullable java.util.Map<java.lang.Integer,java.lang.Integer>	getHighlightLines()
boolean	haveHighlights()
boolean	isLineHighlighted(int line)
boolean	isShowHighlights()
void	removeHighlightLine(int line)
protected void	setHighlightIndex(int index)
protected void	skipHighlightSets(int skipSets)

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

addHighlightListener, dispose, disposeComponent, 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, disposeComponent, endHighlightSet, enterUpdateRegion, fireHighlightsChanged, fireHighlightsUpdated, highlightSet, highlightSet, initComponent, isHighlightsMode, leaveUpdateRegion, removeHighlightListener, restartHighlightSet, setHighlightsMode, settingsChanged, startHighlightSet, startHighlightSet

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

addHighlightLines, addHighlightLines, addHighlightLines

Field Detail

myHighlightLines

@Nullable
protected @Nullable java.util.Map<java.lang.Integer,java.lang.Integer> myHighlightLines

myOriginalOrderIndex

protected int myOriginalOrderIndex

Constructor Detail

LineHighlightProviderBase

public LineHighlightProviderBase(@NotNull
                                 T settings)

Method Detail

getHighlighter

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

Specified by:

getHighlighter in interface HighlightProvider<T>

Specified by:

getHighlighter in interface LineHighlightProvider<T>

clearHighlights

public void clearHighlights()

Specified by:

clearHighlights in interface HighlightProvider<T>

isLineHighlighted

public boolean isLineHighlighted(int line)

Specified by:

isLineHighlighted in interface LineHighlightProvider<T>

getHighlightLines

@Nullable
public @Nullable java.util.Map<java.lang.Integer,java.lang.Integer> getHighlightLines()

haveHighlights

public boolean haveHighlights()

Specified by:

haveHighlights in interface HighlightProvider<T>

isShowHighlights

public boolean isShowHighlights()

Specified by:

isShowHighlights in interface HighlightProvider<T>

getHighlightAttributes

@Nullable
public @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)

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

Specified by:

getHighlightAttributes in interface HighlightProvider<T>

Parameters:

index - highlighted line number

flags - not used

startOffset - start offset in editor

endOffset - end offset in editor

Returns:

text attributes to use for highlight or null if not highlighted

getHighlightLineIndex

public int getHighlightLineIndex(int line)

Specified by:

getHighlightLineIndex in interface LineHighlightProvider<T>

addHighlightLine

public void addHighlightLine(int line)

Specified by:

addHighlightLine in interface LineHighlightProvider<T>

addHighlightLine

public void addHighlightLine(int line,
                             boolean replaceExisting)

Specified by:

addHighlightLine in interface LineHighlightProvider<T>

skipHighlightSets

protected void skipHighlightSets(int skipSets)

Specified by:

skipHighlightSets in class HighlightProviderBase<T>

setHighlightIndex

protected void setHighlightIndex(int index)

Specified by:

setHighlightIndex in class HighlightProviderBase<T>

getHighlightIndex

protected int getHighlightIndex()

Specified by:

getHighlightIndex in class HighlightProviderBase<T>

removeHighlightLine

public void removeHighlightLine(int line)

Specified by:

removeHighlightLine in interface LineHighlightProvider<T>