Package org.jdesktop.swingx.decorator

Class EnabledHighlighter

java.lang.Object
org.jdesktop.swingx.decorator.AbstractHighlighter
org.jdesktop.swingx.decorator.EnabledHighlighter
All Implemented Interfaces:
Highlighter
public class EnabledHighlighter extends AbstractHighlighter
A Highlighter which sets the enabled property.

Note: the enabled is a mutable property of this Highlighter which defaults to false because we assume that's the most common use case to make a rendering component look disabled when the parent is enabled. It's mutable for symmetry reasons, though the other way round - enabled looking rendering component on a disabled parent - most probably will confuse users.

Author:
Jeanette Winzenburg (slight cleanup), original contributed by swingx member martinm1000

  • Constructor Details

    • EnabledHighlighter

      public EnabledHighlighter()
      Instantiates a EnabledHighlighter with default enabled property (== false). The Highlighter is applied always.

    • EnabledHighlighter

      public EnabledHighlighter(boolean enabled)
      Instantiates a EnabledHighlighter with the specified enabled property. The Highlighter is applied always.
      Parameters:
      enabled - the enabled property

    • EnabledHighlighter

      public EnabledHighlighter(HighlightPredicate predicate)
      Instantiates a EnabledHighlighter with the specified HighlightPredicate and default enabled property (== false).
      Parameters:
      predicate - the HighlightPredicate to use, may be null to default to ALWAYS.

    • EnabledHighlighter

      public EnabledHighlighter(HighlightPredicate predicate, boolean enabled)
      Instantiates a EnabledHighlighter with the specified HighlightPredicate and default enabled property.
      Parameters:
      predicate - the HighlightPredicate to use, may be null to default to ALWAYS.
      enabled - the enabled property

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Returns the enabled property.
      Returns:
      the enabled

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets the enabled property. The default value is false.
      Parameters:
      enabled - the enabled to set

    • doHighlight

      protected Component doHighlight(Component renderer, ComponentAdapter adapter)
      Apply the highlights.

      Implemented to set the rendering component's enabled property.

      Specified by:
      doHighlight in class AbstractHighlighter
      Parameters:
      renderer - the cell renderer component that is to be decorated
      adapter - the ComponentAdapter for this decorate operation
      Returns:
      Component component
      See Also: