Package org.jdesktop.swingx.decorator

Class HighlightPredicate.EqualsHighlightPredicate

java.lang.Object

org.jdesktop.swingx.decorator.HighlightPredicate.EqualsHighlightPredicate

All Implemented Interfaces:

HighlightPredicate

Enclosing interface:

HighlightPredicate

public static class HighlightPredicate.EqualsHighlightPredicate
extends Object
implements HighlightPredicate

Predicate testing the componentAdapter value against a fixed Object.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jdesktop.swingx.decorator.HighlightPredicate

HighlightPredicate.AndHighlightPredicate, HighlightPredicate.ColumnHighlightPredicate, HighlightPredicate.ColumnTypeHighlightPredicate, HighlightPredicate.DepthHighlightPredicate, HighlightPredicate.EqualsHighlightPredicate, HighlightPredicate.IdentifierHighlightPredicate, HighlightPredicate.NotHighlightPredicate, HighlightPredicate.OrHighlightPredicate, HighlightPredicate.RowGroupHighlightPredicate, HighlightPredicate.TypeHighlightPredicate

Field Summary

Fields inherited from interface org.jdesktop.swingx.decorator.HighlightPredicate

ALWAYS, BIG_DECIMAL_NEGATIVE, EDITABLE, EMPTY_INTEGER_ARRAY, EMPTY_OBJECT_ARRAY, EMPTY_PREDICATE_ARRAY, EVEN, HAS_FOCUS, INTEGER_NEGATIVE, IS_FOLDER, IS_LEAF, IS_SELECTED, IS_TEXT_TRUNCATED, NEVER, ODD, READ_ONLY, ROLLOVER_CELL, ROLLOVER_COLUMN, ROLLOVER_ROW

Constructor Summary

Constructors

Constructor	Description
EqualsHighlightPredicate()	Instantitates a predicate with null compare value.
EqualsHighlightPredicate(Object compareValue)	Instantiates a predicate with the given compare value.

Method Summary

Modifier and Type	Method	Description
Object	getCompareValue()
boolean	isHighlighted(Component renderer, ComponentAdapter adapter)	Returns a boolean to indicate whether the component should be highlighted.

Methods inherited from class java.lang.Object

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

Constructor Details

EqualsHighlightPredicate

public EqualsHighlightPredicate()

Instantitates a predicate with null compare value.

EqualsHighlightPredicate

public EqualsHighlightPredicate(Object compareValue)

Instantiates a predicate with the given compare value. PENDING JW: support array?

Parameters:

compareValue - the fixed value to compare the adapter against.

Method Details

isHighlighted

public boolean isHighlighted(Component renderer,
 ComponentAdapter adapter)

Returns a boolean to indicate whether the component should be highlighted.

Note: both parameters should be considered strictly read-only! Implemented to return true if the adapter value equals the this predicate's compare value.

Specified by:

isHighlighted in interface HighlightPredicate

Parameters:

renderer - the cell renderer component that is to be decorated, must not be null

adapter - the ComponentAdapter for this decorate operation, most not be null

Returns:

a boolean to indicate whether the component should be highlighted.

getCompareValue

public Object getCompareValue()

Returns:

the value this predicate checks against.