Class LineHighlightManager


  • class LineHighlightManager
    extends java.lang.Object
    Manages line highlights in an RTextArea.
    Version:
    1.0
    • Constructor Detail

      • LineHighlightManager

        LineHighlightManager​(RTextArea textArea)
        Constructor.
        Parameters:
        textArea - The parent text area.
    • Method Detail

      • addLineHighlight

        public java.lang.Object addLineHighlight​(int line,
                                                 java.awt.Color color)
                                          throws javax.swing.text.BadLocationException
        Highlights the specified line.
        Parameters:
        line - The line to highlight.
        color - The color to highlight with.
        Returns:
        A tag for the highlight.
        Throws:
        javax.swing.text.BadLocationException - If line is not a valid line number.
        See Also:
        removeLineHighlight(Object)
      • getCurrentLineHighlightTags

        protected java.util.List<java.lang.Object> getCurrentLineHighlightTags()
        Returns the current line highlights' tags.
        Returns:
        The current line highlights' tags, or an empty list if there are none.
      • getLineHighlightCount

        protected int getLineHighlightCount()
        Returns the current number of line highlights. Useful for testing.
        Returns:
        The current number of line highlights.
      • paintLineHighlights

        public void paintLineHighlights​(java.awt.Graphics g)
        Paints any highlighted lines in the specified line range.
        Parameters:
        g - The graphics context.
      • removeLineHighlight

        public void removeLineHighlight​(java.lang.Object tag)
        Removes a line highlight.
        Parameters:
        tag - The tag of the line highlight to remove.
        See Also:
        addLineHighlight(int, Color)
      • repaintLine

        private void repaintLine​(LineHighlightManager.LineHighlightInfo lhi)
        Repaints the line pointed to by the specified highlight information.
        Parameters:
        lhi - The highlight information.