Class CompoundHighlighter

    • Constructor Detail

      • CompoundHighlighter

        public CompoundHighlighter​(Highlighter... inList)
        Instantiates a CompoundHighlighter containing the given Highlighters.
        Parameters:
        inList - zero or more not-null Highlighters to manage by this CompoundHighlighter.
        Throws:
        NullPointerException - if array is null or array contains null values.
      • CompoundHighlighter

        public CompoundHighlighter​(HighlightPredicate predicate,
                                   Highlighter... inList)
        Instantiates a CompoundHighlighter with the given predicate containing the given Highlighters.
        Parameters:
        predicate - the highlightPredicate to use
        inList - zero or more not-null Highlighters to manage by this CompoundHighlighter.
        Throws:
        NullPointerException - if array is null or array contains null values.
    • Method Detail

      • setHighlighters

        public void setHighlighters​(Highlighter... inList)
        Sets the given Highlighters.
        Parameters:
        inList - zero or more not-null Highlighters to manage by this CompoundHighlighter.
        Throws:
        NullPointerException - if array is null or array contains null values.
      • addHighlighter

        public void addHighlighter​(Highlighter highlighter)
        Appends a highlighter to the pipeline.
        Parameters:
        highlighter - highlighter to add
        Throws:
        NullPointerException - if highlighter is null.
      • addHighlighter

        public void addHighlighter​(Highlighter highlighter,
                                   boolean prepend)
        Adds a highlighter to the pipeline. PENDING: Duplicate inserts?
        Parameters:
        highlighter - highlighter to add
        prepend - prepend the highlighter if true; false will append
        Throws:
        NullPointerException - if highlighter is null.
      • removeHighlighter

        public void removeHighlighter​(Highlighter hl)
        Removes a highlighter from the pipeline.
        Parameters:
        hl - highlighter to remove
      • getHighlighters

        public Highlighter[] getHighlighters()
        Returns an array of contained Highlighters.
        Returns:
        the contained Highlighters, might be empty but never null.
      • updateUI

        public void updateUI()
        Updates all internal visuals after changing a UI-delegate.

        Implemented to call updateUI on contained Highlighters.

        Specified by:
        updateUI in interface UIDependent
        See Also:
        JComponent.updateUI()
      • getHighlighterChangeListener

        protected ChangeListener getHighlighterChangeListener()
        Returns the ChangeListner to contained Highlighters. The listener is lazily created.
        Returns:
        the listener for contained highlighters, guaranteed to be not null.
      • createHighlighterChangeListener

        protected ChangeListener createHighlighterChangeListener()
        Creates and returns the ChangeListener registered to contained Highlighters. Here: fires a stateChanged on each notification.
        Returns:
        the listener for contained Highlighters.