javax.swing.text

Interface Highlighter

Contents

    • Method Detail

      • install

        void install(JTextComponent c)
        Called when the UI is being installed into the interface of a JTextComponent. This can be used to gain access to the model that is being navigated by the implementation of this interface.
        Parameters:
        c - the JTextComponent editor

      • deinstall

        void deinstall(JTextComponent c)
        Called when the UI is being removed from the interface of a JTextComponent. This is used to unregister any listeners that were attached.
        Parameters:
        c - the JTextComponent editor

      • paint

        void paint(Graphics g)
        Renders the highlights.
        Parameters:
        g - the graphics context.

      • addHighlight

        Object addHighlight(int p0,
                  int p1,
                  Highlighter.HighlightPainter p)
                    throws BadLocationException
        Adds a highlight to the view. Returns a tag that can be used to refer to the highlight.
        Parameters:
        p0 - the beginning of the range >= 0
        p1 - the end of the range >= p0
        p - the painter to use for the actual highlighting
        Returns:
        an object that refers to the highlight
        Throws:
        BadLocationException - for an invalid range specification

      • removeHighlight

        void removeHighlight(Object tag)
        Removes a highlight from the view.
        Parameters:
        tag - which highlight to remove

      • removeAllHighlights

        void removeAllHighlights()
        Removes all highlights this highlighter is responsible for.

      • changeHighlight

        void changeHighlight(Object tag,
                   int p0,
                   int p1)
                     throws BadLocationException
        Changes the given highlight to span a different portion of the document. This may be more efficient than a remove/add when a selection is expanding/shrinking (such as a sweep with a mouse) by damaging only what changed.
        Parameters:
        tag - which highlight to change
        p0 - the beginning of the range >= 0
        p1 - the end of the range >= p0
        Throws:
        BadLocationException - for an invalid range specification

      • getHighlights

        Highlighter.Highlight[] getHighlights()
        Fetches the current list of highlights.
        Returns:
        the highlight list

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/text/highlighter.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut