org.jdesktop.swingx.decorator
Class HighlightPredicate.DepthHighlightPredicate

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

All Implemented Interfaces:

HighlightPredicate

Enclosing interface:

HighlightPredicate

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

A HighlightPredicate based on adapter depth.

Author:

Karl Schaefer

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.DepthHighlightPredicate(int... depths)
Instantiates a predicate which returns true for the given depths.

Method Summary

java.lang.Integer[]	getDepths()
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.DepthHighlightPredicate

public HighlightPredicate.DepthHighlightPredicate(int... depths)

Instantiates a predicate which returns true for the given depths.

Parameters:

depths - the depths to highlight

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! This implementation returns true if the adapter's depth is contained in this predicates list.

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.

getDepths

public java.lang.Integer[] getDepths()

Returns:

array of numbers representing different depths