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

Class LineRangeHighlightProviderBase<T>

java.lang.Object

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

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

All Implemented Interfaces:

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

public abstract class LineRangeHighlightProviderBase<T>
extends HighlightProviderBase<T>
implements LineRangeHighlightProvider<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.BitSet	myHighlightLines
protected boolean	myInvertedHighlights

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

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

Constructor Summary

Constructors

Constructor	Description
LineRangeHighlightProviderBase(T settings)

Method Summary

Modifier and Type	Method	Description
void	addHighlightLine(int line)
@Nullable java.util.BitSet	addHighlightLines(int startLine, int endLine)
@Nullable java.util.BitSet	addHighlightLines(@Nullable java.util.BitSet bitSet)
void	clearHighlights()
abstract @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.
LineRangeHighlighter<T>	getHighlighter(@NotNull com.intellij.openapi.editor.Editor editor)
protected int	getHighlightIndex()
int	getHighlightLineIndex(int line)
@Nullable java.util.BitSet	getHighlightLines()
boolean	haveHighlights()
boolean	isInvertedHighlights()
boolean	isLineHighlighted(int line)
boolean	isShowHighlights()
void	removeHighlightLine(int line)
@Nullable java.util.BitSet	removeHighlightLines(int startLine, int endLine)
@Nullable java.util.BitSet	removeHighlightLines(@Nullable java.util.BitSet bitSet)
protected void	setHighlightIndex(int index)
void	setHighlightLines(java.util.BitSet bitSet, java.lang.Boolean highlightMode)
void	setInvertedHighlights(boolean invertedHighlights)
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

addHighlightLine, addHighlightLines, addHighlightLines, addHighlightLines

Field Detail

myHighlightLines

@Nullable
protected @Nullable java.util.BitSet myHighlightLines

myInvertedHighlights

protected boolean myInvertedHighlights

Constructor Detail

LineRangeHighlightProviderBase

public LineRangeHighlightProviderBase(@NotNull
                                      T settings)

Method Detail

isInvertedHighlights

public boolean isInvertedHighlights()

Specified by:

isInvertedHighlights in interface LineRangeHighlightProvider<T>

setInvertedHighlights

public void setInvertedHighlights(boolean invertedHighlights)

Specified by:

setInvertedHighlights in interface LineRangeHighlightProvider<T>

getHighlighter

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

Specified by:

getHighlighter in interface HighlightProvider<T>

Specified by:

getHighlighter in interface LineHighlightProvider<T>

Specified by:

getHighlighter in interface LineRangeHighlightProvider<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>

Specified by:

isLineHighlighted in interface LineRangeHighlightProvider<T>

haveHighlights

public boolean haveHighlights()

Specified by:

haveHighlights in interface HighlightProvider<T>

isShowHighlights

public boolean isShowHighlights()

Specified by:

isShowHighlights in interface HighlightProvider<T>

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>

removeHighlightLine

public void removeHighlightLine(int line)

Specified by:

removeHighlightLine in interface LineHighlightProvider<T>

getHighlightLines

@Nullable
public @Nullable java.util.BitSet getHighlightLines()

Specified by:

getHighlightLines in interface LineRangeHighlightProvider<T>

setHighlightLines

public void setHighlightLines(java.util.BitSet bitSet,
                              java.lang.Boolean highlightMode)

Specified by:

setHighlightLines in interface LineRangeHighlightProvider<T>

addHighlightLines

@Nullable
public @Nullable java.util.BitSet addHighlightLines(int startLine,
                                                    int endLine)

Specified by:

addHighlightLines in interface LineRangeHighlightProvider<T>

addHighlightLines

@Nullable
public @Nullable java.util.BitSet addHighlightLines(@Nullable
                                                    @Nullable java.util.BitSet bitSet)

Specified by:

addHighlightLines in interface LineRangeHighlightProvider<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>

removeHighlightLines

@Nullable
public @Nullable java.util.BitSet removeHighlightLines(@Nullable
                                                       @Nullable java.util.BitSet bitSet)

Specified by:

removeHighlightLines in interface LineRangeHighlightProvider<T>

removeHighlightLines

@Nullable
public @Nullable java.util.BitSet removeHighlightLines(int startLine,
                                                       int endLine)

Specified by:

removeHighlightLines in interface LineRangeHighlightProvider<T>

getHighlightAttributes

@Nullable
public abstract @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 - text attribute flags

startOffset - start offset in editor

endOffset - end offset in editor

Returns:

text attributes to use for highlight or null if not highlighted