org.jdesktop.swingx.decorator
Class HighlighterPipeline

java.lang.Object
  org.jdesktop.swingx.decorator.HighlighterPipeline

All Implemented Interfaces:

Highlighter.UIHighlighter

public class HighlighterPipeline
extends Object
implements Highlighter.UIHighlighter

A class which manages the lists of highlighters.

See Also:

Highlighter

Field Summary

protected ChangeEvent	changeEvent
protected List<Highlighter>	highlighters
protected EventListenerList	listenerList

Constructor Summary

HighlighterPipeline()

HighlighterPipeline(Highlighter[] inList)

Method Summary

void	addChangeListener(ChangeListener l) Adds a ChangeListener.
void	addHighlighter(Highlighter hl) Appends a highlighter to the pipeline.
void	addHighlighter(Highlighter hl, boolean prepend) Adds a highlighter to the pipeline.
Component	apply(Component stamp, ComponentAdapter adapter) Applies all the highlighters to the components.
protected void	fireStateChanged() Runs each ChangeListener's stateChanged method.
ChangeListener[]	getChangeListeners() Returns an array of all the change listeners registered on this DefaultBoundedRangeModel.
Highlighter[]	getHighlighters()
void	removeChangeListener(ChangeListener l) Removes a ChangeListener.
void	removeHighlighter(Highlighter hl) Removes a highlighter from the pipeline.
void	updateUI()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changeEvent

protected transient ChangeEvent changeEvent

listenerList

protected EventListenerList listenerList

highlighters

protected List<Highlighter> highlighters

Constructor Detail

HighlighterPipeline

public HighlighterPipeline()

HighlighterPipeline

public HighlighterPipeline(Highlighter[] inList)

Parameters:

inList - the array of highlighters to initially add to this.

Throws:

NullPointerException - if array is null of array contains null values.

Method Detail

addHighlighter

public void addHighlighter(Highlighter hl)

Appends a highlighter to the pipeline.

Parameters:

hl - highlighter to add

Throws:

NullPointerException - if highlighter is null.

addHighlighter

public void addHighlighter(Highlighter hl,
                           boolean prepend)

Adds a highlighter to the pipeline. PENDING: Duplicate inserts?

Parameters:

hl - highlighter to add

prepend - prepend the highlighter if true; false will append

Throws:

NullPointerException - if highlighter is null.

removeHighlighter

public void removeHighlighter(Highlighter hl)

Removes a highlighter from the pipeline.

Parameters:

hl - highlighter to remove

getHighlighters

public Highlighter[] getHighlighters()

apply

public Component apply(Component stamp,
                       ComponentAdapter adapter)

Applies all the highlighters to the components.

Throws:

NullPointerException - if either stamp or adapter is null.

updateUI

public void updateUI()

Specified by:

updateUI in interface Highlighter.UIHighlighter

addChangeListener

public void addChangeListener(ChangeListener l)

Adds a ChangeListener. The change listeners are run each time any one of the Bounded Range model properties changes.

Parameters:

l - the ChangeListener to add

See Also:

removeChangeListener(javax.swing.event.ChangeListener), BoundedRangeModel.addChangeListener(javax.swing.event.ChangeListener)

removeChangeListener

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener.

Parameters:

l - the ChangeListener to remove

See Also:

addChangeListener(javax.swing.event.ChangeListener), BoundedRangeModel.removeChangeListener(javax.swing.event.ChangeListener)

getChangeListeners

public ChangeListener[] getChangeListeners()

Returns an array of all the change listeners registered on this DefaultBoundedRangeModel.

Returns:

all of this model's ChangeListeners or an empty array if no change listeners are currently registered

Since:

1.4

See Also:

addChangeListener(javax.swing.event.ChangeListener), removeChangeListener(javax.swing.event.ChangeListener)

fireStateChanged

protected void fireStateChanged()

Runs each ChangeListener's stateChanged method.

See Also:

#setRangeProperties, EventListenerList