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>
-
-
Field Summary
Fields Modifier and Type Field Description protected @Nullable java.util.Map<java.lang.Integer,java.lang.Integer>myHighlightLinesprotected intmyOriginalOrderIndex-
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddHighlightLine(int line)voidaddHighlightLine(int line, boolean replaceExisting)voidclearHighlights()@Nullable com.intellij.openapi.editor.markup.TextAttributesgetHighlightAttributes(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 intgetHighlightIndex()intgetHighlightLineIndex(int line)@Nullable java.util.Map<java.lang.Integer,java.lang.Integer>getHighlightLines()booleanhaveHighlights()booleanisLineHighlighted(int line)booleanisShowHighlights()voidremoveHighlightLine(int line)protected voidsetHighlightIndex(int index)protected voidskipHighlightSets(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.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
-
-
-
-
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:
getHighlighterin interfaceHighlightProvider<T>- Specified by:
getHighlighterin interfaceLineHighlightProvider<T>
-
clearHighlights
public void clearHighlights()
- Specified by:
clearHighlightsin interfaceHighlightProvider<T>
-
isLineHighlighted
public boolean isLineHighlighted(int line)
- Specified by:
isLineHighlightedin interfaceLineHighlightProvider<T>
-
getHighlightLines
@Nullable public @Nullable java.util.Map<java.lang.Integer,java.lang.Integer> getHighlightLines()
-
haveHighlights
public boolean haveHighlights()
- Specified by:
haveHighlightsin interfaceHighlightProvider<T>
-
isShowHighlights
public boolean isShowHighlights()
- Specified by:
isShowHighlightsin interfaceHighlightProvider<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:
getHighlightAttributesin interfaceHighlightProvider<T>- Parameters:
index- highlighted line numberflags- not usedstartOffset- start offset in editorendOffset- end offset in editor- Returns:
- text attributes to use for highlight or null if not highlighted
-
getHighlightLineIndex
public int getHighlightLineIndex(int line)
- Specified by:
getHighlightLineIndexin interfaceLineHighlightProvider<T>
-
addHighlightLine
public void addHighlightLine(int line)
- Specified by:
addHighlightLinein interfaceLineHighlightProvider<T>
-
addHighlightLine
public void addHighlightLine(int line, boolean replaceExisting)- Specified by:
addHighlightLinein interfaceLineHighlightProvider<T>
-
skipHighlightSets
protected void skipHighlightSets(int skipSets)
- Specified by:
skipHighlightSetsin classHighlightProviderBase<T>
-
setHighlightIndex
protected void setHighlightIndex(int index)
- Specified by:
setHighlightIndexin classHighlightProviderBase<T>
-
getHighlightIndex
protected int getHighlightIndex()
- Specified by:
getHighlightIndexin classHighlightProviderBase<T>
-
removeHighlightLine
public void removeHighlightLine(int line)
- Specified by:
removeHighlightLinein interfaceLineHighlightProvider<T>
-
-