Class LayeredHighlighter

java.lang.Object
javax.swing.text.LayeredHighlighter
All Implemented Interfaces:
Highlighter
Direct Known Subclasses:
DefaultHighlighter
public abstract class LayeredHighlighter extends Object implements Highlighter
Implementation of Highlighter interface to mark up the background of leaf views with colored areas.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    LayeredHighlighter.LayerPainter
    Layered highlight renderer.

    Nested classes/interfaces declared in interface Highlighter

    Highlighter.Highlight, Highlighter.HighlightPainter
    Modifier and Type
    Interface
    Description
    static interface 
    Highlighter.Highlight
    A highlight.
    static interface 
    Highlighter.HighlightPainter
    Highlight renderer.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    LayeredHighlighter()
    Constructor for subclasses to call.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    paintLayeredHighlights(Graphics g, int p0, int p1, Shape viewBounds, JTextComponent editor, View view)
    When leaf Views (such as LabelView) are rendering they should call into this method.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

    Methods declared in interface Highlighter

    addHighlight, changeHighlight, deinstall, getHighlights, install, paint, removeAllHighlights, removeHighlight
    Modifier and Type
    Method
    Description
    Object
    addHighlight(int p0, int p1, Highlighter.HighlightPainter p)
    Adds a highlight to the view.
    void
    changeHighlight(Object tag, int p0, int p1)
    Changes the given highlight to span a different portion of the document.
    void
    deinstall(JTextComponent c)
    Called when the UI is being removed from the interface of a JTextComponent.
    Highlighter.Highlight[]
    getHighlights()
    Fetches the current list of highlights.
    void
    install(JTextComponent c)
    Called when the UI is being installed into the interface of a JTextComponent.
    void
    paint(Graphics g)
    Renders the highlights.
    void
    removeAllHighlights()
    Removes all highlights this highlighter is responsible for.
    void
    removeHighlight(Object tag)
    Removes a highlight from the view.

  • Constructor Details

    • LayeredHighlighter

      protected LayeredHighlighter()
      Constructor for subclasses to call.

  • Method Details

    • paintLayeredHighlights

      public abstract void paintLayeredHighlights(Graphics g, int p0, int p1, Shape viewBounds, JTextComponent editor, View view)
      When leaf Views (such as LabelView) are rendering they should call into this method. If a highlight is in the given region it will be drawn immediately.
      Parameters:
      g - Graphics used to draw
      p0 - starting offset of view
      p1 - ending offset of view
      viewBounds - Bounds of View
      editor - JTextComponent
      view - View instance being rendered