org.jdesktop.swingx.decorator
Class CompoundHighlighter

java.lang.Object
  org.jdesktop.swingx.decorator.AbstractHighlighter
      org.jdesktop.swingx.decorator.CompoundHighlighter

All Implemented Interfaces:

Highlighter, UIDependent

public class CompoundHighlighter
extends AbstractHighlighter
implements UIDependent

A class which manages the lists of Highlighters.

Author:

Ramesh Gupta, Jeanette Winzenburg

See Also:

Highlighter

Field Summary

static Highlighter[]

EMPTY_HIGHLIGHTERS

Constructor Summary

CompoundHighlighter(Highlighter... inList)
Instantiates a CompoundHighlighter containing the given Highlighters.

CompoundHighlighter(HighlightPredicate predicate, Highlighter... inList)
Instantiates a CompoundHighlighter with the given predicate containing the given Highlighters.

Method Summary

void	addHighlighter(Highlighter highlighter) Appends a highlighter to the pipeline.
void	addHighlighter(Highlighter highlighter, boolean prepend) Adds a highlighter to the pipeline.
Highlighter[]	getHighlighters() Returns an array of contained Highlighters.
void	removeHighlighter(Highlighter hl) Removes a highlighter from the pipeline.
void	setHighlighters(Highlighter... inList) Sets the given Highlighters.
void	updateUI() method to call after the LookAndFeel changed.

Methods inherited from class org.jdesktop.swingx.decorator.AbstractHighlighter

addChangeListener, getChangeListeners, getHighlightPredicate, highlight, removeChangeListener, setHighlightPredicate

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_HIGHLIGHTERS

public static final Highlighter[] EMPTY_HIGHLIGHTERS

Constructor Detail

CompoundHighlighter

public CompoundHighlighter(Highlighter... inList)

Instantiates a CompoundHighlighter containing the given Highlighters.

Parameters:

inList - zero or more not-null Highlighters to manage by this CompoundHighlighter.

Throws:

java.lang.NullPointerException - if array is null or array contains null values.

CompoundHighlighter

public CompoundHighlighter(HighlightPredicate predicate,
                           Highlighter... inList)

Instantiates a CompoundHighlighter with the given predicate containing the given Highlighters.

Parameters:

predicate - the highlightPredicate to use

inList - zero or more not-null Highlighters to manage by this CompoundHighlighter.

Throws:

java.lang.NullPointerException - if array is null or array contains null values.

Method Detail

setHighlighters

public void setHighlighters(Highlighter... inList)

Sets the given Highlighters.

Parameters:

inList - zero or more not-null Highlighters to manage by this CompoundHighlighter.

Throws:

java.lang.NullPointerException - if array is null or array contains null values.

addHighlighter

public void addHighlighter(Highlighter highlighter)

Appends a highlighter to the pipeline.

Parameters:

highlighter - highlighter to add

Throws:

java.lang.NullPointerException - if highlighter is null.

addHighlighter

public void addHighlighter(Highlighter highlighter,
                           boolean prepend)

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

Parameters:

highlighter - highlighter to add

prepend - prepend the highlighter if true; false will append

Throws:

java.lang.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()

Returns an array of contained Highlighters.

Returns:

the contained Highlighters, might be empty but never null.

updateUI

public void updateUI()

method to call after the LookAndFeel changed.

Implemented to call updateUI on contained Highlighters.

Specified by:

updateUI in interface UIDependent