Class ToolTipHighlighter

  • All Implemented Interfaces:
    Highlighter

    public class ToolTipHighlighter
    extends AbstractHighlighter
    A highlighter for setting a tool tip on the component.
    Author:
    kschaefer
    • 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()
      • canHighlight

        protected boolean canHighlight​(Component component,
                                       ComponentAdapter adapter)
        Subclasses may override to further limit the highlighting based on Highlighter state, f.i. a PainterHighlighter can only be applied to PainterAware components.

        This implementation returns true always.

        Implemented to return false if the component is not a JComponent.

        Overrides:
        canHighlight in class AbstractHighlighter
        Returns:
        a boolean indication if the adapter can be highlighted based general state. This implementation returns true always.