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

Class HighlightProviderBase<T>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LineHighlightProviderBase, LineRangeHighlightProviderBase, TypedRangeHighlightProviderBase

public abstract class HighlightProviderBase<T>
extends java.lang.Object
implements HighlightProvider<T>, com.intellij.openapi.Disposable

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 @NotNull DelayedRunner	myDelayedRunner
protected int	myHighlightColorRepeatIndex
protected java.awt.Color[]	myHighlightColors
protected boolean	myHighlightsMode
protected int	myInUpdateRegion
protected com.intellij.ide.ui.LafManagerListener	myLafManagerListener
protected boolean	myPendingChanged
protected T	mySettings

Constructor Summary

Constructors

Constructor	Description
HighlightProviderBase(T settings)

Method Summary

Modifier and Type	Method	Description
void	addHighlightListener(@NotNull HighlightListener highlightListener, @NotNull com.intellij.openapi.Disposable parent)
void	dispose()
void	disposeComponent()
void	endHighlightSet()
void	enterUpdateRegion()
void	fireHighlightsChanged()
void	fireHighlightsUpdated()
protected abstract @Nullable CancelableJobScheduler	getCancellableJobScheduler()
protected abstract @NotNull ColorIterable	getColors(T settings)
@NotNull DelayedRunner	getDelayedRunner()
int	getHighlightColorRepeatIndex()
java.awt.Color[]	getHighlightColors()
protected abstract int	getHighlightIndex()
void	initComponent()
boolean	isHighlightsMode()
boolean	isInHighlightSet()
void	leaveUpdateRegion()
void	removeHighlightListener(@NotNull HighlightListener highlightListener)
void	restartHighlightSet(int index)	Provide an index, if > than last will change last to this value
protected abstract void	setHighlightIndex(int index)
void	setHighlightsMode(boolean highlightsMode)
void	settingsChanged(ColorIterable colors, T settings)
protected abstract void	skipHighlightSets(int skipSets)
void	startHighlightSet()
void	startHighlightSet(int skipSets)
protected abstract void	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

clearHighlights, getHighlightAttributes, getHighlighter, haveHighlights, highlightSet, highlightSet, isShowHighlights

Field Detail

myLafManagerListener

protected final com.intellij.ide.ui.LafManagerListener myLafManagerListener

myHighlightColors

protected java.awt.Color[] myHighlightColors

myHighlightColorRepeatIndex

protected int myHighlightColorRepeatIndex

myDelayedRunner

@NotNull
protected final @NotNull DelayedRunner myDelayedRunner

myHighlightsMode

protected boolean myHighlightsMode

myInUpdateRegion

protected int myInUpdateRegion

myPendingChanged

protected boolean myPendingChanged

mySettings

@NotNull
protected T mySettings

Constructor Detail

HighlightProviderBase

public HighlightProviderBase(@NotNull
                             T settings)

Method Detail

getDelayedRunner

@NotNull
public @NotNull DelayedRunner getDelayedRunner()

getCancellableJobScheduler

@Nullable
protected abstract @Nullable CancelableJobScheduler getCancellableJobScheduler()

subscribeSettingsChanged

protected abstract void subscribeSettingsChanged()

getColors

@NotNull
protected abstract @NotNull ColorIterable getColors(@NotNull
                                                    T settings)

initComponent

public void initComponent()

Specified by:

initComponent in interface HighlightProvider<T>

disposeComponent

public void disposeComponent()

Specified by:

disposeComponent in interface HighlightProvider<T>

dispose

public void dispose()

Specified by:

dispose in interface com.intellij.openapi.Disposable

settingsChanged

public void settingsChanged(ColorIterable colors,
                            T settings)

Specified by:

settingsChanged in interface HighlightProvider<T>

addHighlightListener

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

Specified by:

addHighlightListener in interface HighlightProvider<T>

removeHighlightListener

public void removeHighlightListener(@NotNull
                                    @NotNull HighlightListener highlightListener)

Specified by:

removeHighlightListener in interface HighlightProvider<T>

startHighlightSet

public void startHighlightSet()

Specified by:

startHighlightSet in interface HighlightProvider<T>

skipHighlightSets

protected abstract void skipHighlightSets(int skipSets)

setHighlightIndex

protected abstract void setHighlightIndex(int index)

getHighlightIndex

protected abstract int getHighlightIndex()

isInHighlightSet

public boolean isInHighlightSet()

startHighlightSet

public void startHighlightSet(int skipSets)

Specified by:

startHighlightSet in interface HighlightProvider<T>

restartHighlightSet

public void restartHighlightSet(int index)

Description copied from interface: HighlightProvider

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

Specified by:

restartHighlightSet in interface HighlightProvider<T>

Parameters:

index - color index

endHighlightSet

public void endHighlightSet()

Specified by:

endHighlightSet in interface HighlightProvider<T>

enterUpdateRegion

public void enterUpdateRegion()

Specified by:

enterUpdateRegion in interface HighlightProvider<T>

leaveUpdateRegion

public void leaveUpdateRegion()

Specified by:

leaveUpdateRegion in interface HighlightProvider<T>

fireHighlightsChanged

public void fireHighlightsChanged()

Specified by:

fireHighlightsChanged in interface HighlightProvider<T>

fireHighlightsUpdated

public void fireHighlightsUpdated()

Specified by:

fireHighlightsUpdated in interface HighlightProvider<T>

getHighlightColorRepeatIndex

public int getHighlightColorRepeatIndex()

getHighlightColors

public java.awt.Color[] getHighlightColors()

isHighlightsMode

public boolean isHighlightsMode()

Specified by:

isHighlightsMode in interface HighlightProvider<T>

setHighlightsMode

public void setHighlightsMode(boolean highlightsMode)

Specified by:

setHighlightsMode in interface HighlightProvider<T>