org.jdesktop.swingx.decorator
Class ConditionalHighlighter

java.lang.Object
  org.jdesktop.swingx.decorator.Highlighter
      org.jdesktop.swingx.decorator.ConditionalHighlighter

Direct Known Subclasses:

PatternHighlighter, RolloverHighlighter

public abstract class ConditionalHighlighter
extends Highlighter

ConditionalHighlighter.

Nested Class Summary

Nested classes/interfaces inherited from class org.jdesktop.swingx.decorator.Highlighter

Highlighter.UIHighlighter

Field Summary

protected int	highlightColumn
protected int	mask
protected int	testColumn

Fields inherited from class org.jdesktop.swingx.decorator.Highlighter

changeEvent, immutable, ledgerBackground, listenerList, notePadBackground

Constructor Summary

ConditionalHighlighter()

ConditionalHighlighter(Color cellBackground, Color cellForeground, int testColumn, int highlightColumn)
Constructs a ConditionalHighlighter instance with the specified background and foreground colors that will be used to highlight the renderer component for a cell in the specified highlightColumn of any row if and only if needsHighlight returns true for the adapter that identifies that cell.

Method Summary

protected Color	computeSelectedForeground(Color seed) Deprecated.
protected Component	doMask(Component renderer, ComponentAdapter adapter) TODO: ??
int	getHighlightColumnIndex()
int	getMask() TODO: JW ??
int	getTestColumnIndex()
Component	highlight(Component renderer, ComponentAdapter adapter) Performs a conditional highlight.
protected void	maskBackground(Component renderer, ComponentAdapter adapter) TODO: ??
protected void	maskForeground(Component renderer, ComponentAdapter adapter) TODO: ??
protected boolean	needsHighlight(ComponentAdapter adapter) Checks if the cell identified by the specified adapter is a potential candidate for highlighting, and returns true if so; otherwise, it returns false.
void	setHighlightColumnIndex(int columnIndex)
void	setMask(int alpha) TODO: JW ??
void	setTestColumnIndex(int columnIndex)
protected abstract boolean	test(ComponentAdapter adapter) Tests if the cell identified by the specified adapter should actually be highlighted, and returns true if so; otherwise, it returns false.

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

addChangeListener, applyBackground, applyForeground, computeBackground, computeForeground, computeSelectedBackground, computeSelectedBackground, computeSelectedForeground, computeUnselectedBackground, computeUnselectedForeground, doHighlight, fireStateChanged, getBackground, getChangeListeners, getForeground, getSelectedBackground, getSelectedForeground, isImmutable, removeChangeListener, setBackground, setForeground, setSelectedBackground, setSelectedForeground

Methods inherited from class java.lang.Object

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

Field Detail

testColumn

protected int testColumn

highlightColumn

protected int highlightColumn

mask

protected int mask

Constructor Detail

ConditionalHighlighter

public ConditionalHighlighter()

ConditionalHighlighter

public ConditionalHighlighter(Color cellBackground,
                              Color cellForeground,
                              int testColumn,
                              int highlightColumn)

Constructs a ConditionalHighlighter instance with the specified background and foreground colors that will be used to highlight the renderer component for a cell in the specified highlightColumn of any row if and only if needsHighlight returns true for the adapter that identifies that cell.

Parameters:

cellBackground - background color for highlighted cells, or null, if background should not be changed

cellForeground - foreground color for highlighted cells, or null, if foreground should not be changed

testColumn - column whose value is to be tested to determine if a cell should be highlighted

highlightColumn - column whose index is used to determine if a cell could be highlighted; may be a valid column index in model coordinates, or -1 to indicate all columns

Method Detail

setMask

public void setMask(int alpha)

TODO: JW ??

getMask

public int getMask()

TODO: JW ??

Returns:

mask

highlight

public Component highlight(Component renderer,
                           ComponentAdapter adapter)

Performs a conditional highlight. Calls doHighlight if and only if needsHighlight returns true.

Overrides:

highlight in class Highlighter

Parameters:

renderer -

adapter -

Returns:

the highlighted component

doMask

protected Component doMask(Component renderer,
                           ComponentAdapter adapter)

TODO: ??

Parameters:

renderer -

adapter -

Returns:

renderer

maskBackground

protected void maskBackground(Component renderer,
                              ComponentAdapter adapter)

TODO: ??

maskForeground

protected void maskForeground(Component renderer,
                              ComponentAdapter adapter)

TODO: ??

Parameters:

renderer -

adapter -

computeSelectedForeground

@Deprecated
protected Color computeSelectedForeground(Color seed)

Deprecated.

Description copied from class: Highlighter

Computes the selected foreground color. This implementation simply returns the selectedBackground property.

Overrides:

computeSelectedForeground in class Highlighter

Parameters:

seed - initial foreground color; must cope with null!

Returns:

the foreground color for a selected cell

getTestColumnIndex

public int getTestColumnIndex()

setTestColumnIndex

public void setTestColumnIndex(int columnIndex)

getHighlightColumnIndex

public int getHighlightColumnIndex()

setHighlightColumnIndex

public void setHighlightColumnIndex(int columnIndex)

needsHighlight

protected boolean needsHighlight(ComponentAdapter adapter)

Checks if the cell identified by the specified adapter is a potential candidate for highlighting, and returns true if so; otherwise, it returns false.

Parameters:

adapter -

Returns:

true if the cell identified by the specified adapter needs highlight; false otherwise

test

protected abstract boolean test(ComponentAdapter adapter)

Tests if the cell identified by the specified adapter should actually be highlighted, and returns true if so; otherwise, it returns false.

Parameters:

adapter -

Returns:

true if the test succeeds; false otherwise