org.jdesktop.swingx.decorator
Class HighlightPredicate.RowGroupHighlightPredicate

java.lang.Object
  org.jdesktop.swingx.decorator.HighlightPredicate.RowGroupHighlightPredicate

All Implemented Interfaces:

HighlightPredicate

Enclosing interface:

HighlightPredicate

public static class HighlightPredicate.RowGroupHighlightPredicate
extends java.lang.Object
implements HighlightPredicate

Nested Class Summary

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

HighlightPredicate.AndHighlightPredicate, HighlightPredicate.ColumnHighlightPredicate, 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, NEVER, ODD, READ_ONLY, ROLLOVER_ROW

Constructor Summary

HighlightPredicate.RowGroupHighlightPredicate(int linesPerGroup)
Instantiates a predicate with the given grouping.

Method Summary

int	getLinesPerGroup()
boolean	isHighlighted(java.awt.Component renderer, ComponentAdapter adapter) Returns a boolean to indicate whether the component should be highlighted.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightPredicate.RowGroupHighlightPredicate

public HighlightPredicate.RowGroupHighlightPredicate(int linesPerGroup)

Instantiates a predicate with the given grouping.

Parameters:

linesPerGroup - number of lines constituting a group, must be > 0

Throws:

java.lang.IllegalArgumentException - if linesPerGroup < 1

Method Detail

isHighlighted

public boolean isHighlighted(java.awt.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's row falls into a odd group number.

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.

getLinesPerGroup

public int getLinesPerGroup()

Returns:

the number of lines per group.