Class FontHighlighter

  • All Implemented Interfaces:
    Highlighter

    public class FontHighlighter
    extends AbstractHighlighter
    A Highlighter which sets the Font of the component.

    Author:
    Karl George Schaefer
    • Constructor Detail

      • FontHighlighter

        public FontHighlighter()
        Instantiates a FontHighlighter with null Font. The Highlighter is applied always.
      • FontHighlighter

        public FontHighlighter​(java.awt.Font font)
        Instantiates a FontHighlighter with the given Font. The Highlighter is applied always.
        Parameters:
        font - the Font to apply
      • FontHighlighter

        public FontHighlighter​(HighlightPredicate predicate)
        Instantiates a FontHighlighter with the given HighlightPredicate and null Font.
        Parameters:
        predicate - the HighlightPredicate to use, may be null to default to ALWAYS.
      • FontHighlighter

        public FontHighlighter​(HighlightPredicate predicate,
                               java.awt.Font font)
        Instantiates a FontHighlighter with the given Font and HighlightPredicate.
        Parameters:
        predicate - the HighlightPredicate to use, may be null to default to ALWAYS.
        font - the Font to apply, may be null
    • Method Detail

      • getFont

        public java.awt.Font getFont()
        Returns the Font used for decoration.
        Returns:
        the Font used for decoration
        See Also:
        setFont(Font)
      • setFont

        public void setFont​(java.awt.Font font)
        Sets the Font used for decoration. May be null to not decorate.
        Parameters:
        font - the Font used for decoration, may be null to not decorate.
        See Also:
        getFont()
      • canHighlight

        protected boolean canHighlight​(java.awt.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 font property is null.

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