org.jdesktop.swingx.decorator
Class IconHighlighter

java.lang.Object
  org.jdesktop.swingx.decorator.AbstractHighlighter
      org.jdesktop.swingx.decorator.IconHighlighter

All Implemented Interfaces:

Highlighter

public class IconHighlighter
extends AbstractHighlighter

Highlighter which decorates by setting the icon property of a label.

Author:

Jeanette Winzenburg

Constructor Summary

IconHighlighter()
Instantiates a IconHighlighter with null Icon and default HighlightPredicate.

IconHighlighter(HighlightPredicate predicate)
Instantiates a IconHighlighter with null Icon the given predicate.

IconHighlighter(HighlightPredicate predicate, javax.swing.Icon icon)
Instantiates a IconHighlighter with the specified Icon and HighlightPredicate.

IconHighlighter(javax.swing.Icon icon)
Instantiates a IconHighlighter with the specified Icon and default HighlightPredicate.

Method Summary

javax.swing.Icon	getIcon() Returns the Icon used for decoration.
void	setIcon(javax.swing.Icon icon) Sets the icon to use 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

IconHighlighter

public IconHighlighter()

Instantiates a IconHighlighter with null Icon and default HighlightPredicate.

IconHighlighter

public IconHighlighter(HighlightPredicate predicate)

Instantiates a IconHighlighter with null Icon the given predicate.

Parameters:

predicate - the HighlightPredicate to use.

IconHighlighter

public IconHighlighter(javax.swing.Icon icon)

Instantiates a IconHighlighter with the specified Icon and default HighlightPredicate.

Parameters:

icon - the icon to use for decoration.

IconHighlighter

public IconHighlighter(HighlightPredicate predicate,
                       javax.swing.Icon icon)

Instantiates a IconHighlighter with the specified Icon and HighlightPredicate.

Parameters:

predicate - the HighlightPredicate to use.

icon - the Icon to use for decoration.

Method Detail

setIcon

public void setIcon(javax.swing.Icon icon)

Sets the icon to use for decoration. A null icon indicates to not decorate.

The default value is null.

Parameters:

icon - the Icon to use for decoration, might be null.

getIcon

public javax.swing.Icon getIcon()

Returns the Icon used for decoration.

Returns:

icon the Icon used for decoration.

See Also:

setIcon(Icon)