org.jdesktop.swingx.decorator

Class ToolTipHighlighter

java.lang.Object

org.jdesktop.swingx.decorator.AbstractHighlighter

org.jdesktop.swingx.decorator.ToolTipHighlighter

All Implemented Interfaces:

Highlighter

public class ToolTipHighlighter
extends AbstractHighlighter

A highlighter for setting a tool tip on the component.

Constructor Summary

Constructors

Constructor and Description
ToolTipHighlighter() Instantiates a ToolTipHighlighter with null StringValue.
ToolTipHighlighter(HighlightPredicate predicate) Instantiates a ToolTipHighlighter with the specified HighlightPredicate and a null StringValue.
ToolTipHighlighter(HighlightPredicate predicate, StringValue toolTipValue) Instantiates a ToolTipHighlighter with the specified HighlightPredicate and StringValue.
ToolTipHighlighter(StringValue toolTipValue) Instantiates a ToolTipHighlighter with the specified StringValue.

Method Summary

Modifier and Type	Method and Description
StringValue	getToolTipValue() Returns the StringValue used for decoration.
void	setToolTipValue(StringValue toolTipValue) Sets the StringValue used for decoration.

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

Constructor Detail

ToolTipHighlighter

public ToolTipHighlighter()

Instantiates a ToolTipHighlighter with null StringValue. The Highlighter is applied always.

ToolTipHighlighter

public ToolTipHighlighter(StringValue toolTipValue)

Instantiates a ToolTipHighlighter with the specified StringValue. The Highlighter is applied always.

Parameters:

toolTipValue - the StringValue used to create the tool tip

ToolTipHighlighter

public ToolTipHighlighter(HighlightPredicate predicate)

Instantiates a ToolTipHighlighter with the specified HighlightPredicate and a null StringValue.

Parameters:

predicate - the HighlightPredicate to use, may be null to default to ALWAYS.

ToolTipHighlighter

public ToolTipHighlighter(HighlightPredicate predicate,
                          StringValue toolTipValue)

Instantiates a ToolTipHighlighter with the specified HighlightPredicate and StringValue.

Parameters:

predicate - the HighlightPredicate to use, may be null to default to ALWAYS.

toolTipValue - the StringValue used to create the tool tip

Method Detail

getToolTipValue

public StringValue getToolTipValue()

Returns the StringValue used for decoration.

Returns:

the StringValue used for decoration

See Also:

#setToolTipValue(Font)

setToolTipValue

public void setToolTipValue(StringValue toolTipValue)

Sets the StringValue used for decoration. May be null to use default decoration.

Parameters:

font - the Font used for decoration, may be null to use default decoration.

See Also:

getToolTipValue()