Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Swing 1.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.swing.text
Class DefaultHighlighter

    java.lang.Object
      |
      +--javax.swing.text.LayeredHighlighter
            |
            +--javax.swing.text.DefaultHighlighter

Direct Known Subclasses:
  BasicTextUI.BasicHighlighter

public class DefaultHighlighter
extends LayeredHighlighter

Implements the Highlighter interfaces. Implements a simple highlight painter that renders in a solid color.

See Also:
  `Highlighter`

Inner Class Summary
`static class` | `DefaultHighlighter.DefaultHighlightPainter` Simple highlight painter that fills a highlighted area with a solid color.

Inner classes inherited from class javax.swing.text.LayeredHighlighter
`LayeredHighlighter.LayerPainter`

Field Summary
`static LayeredHighlighter.LayerPainter` | `DefaultPainter`

Constructor Summary
`DefaultHighlighter()` Creates a new DefaultHighlighther object.

Method Summary
`java.lang.Object` | `addHighlight(int p0, int p1, Highlighter.HighlightPainter p)` Adds a highlight to the view.
`void` | `changeHighlight(java.lang.Object tag, int p0, int p1)` Changes a highlight.
`void` | `deinstall(JTextComponent c)` Called when the UI is being removed from the interface of a JTextComponent.
`boolean` | `getDrawsLayeredHighlights()`
`Highlighter.Highlight[]` | `getHighlights()` Makes a copy of the highlights.
`void` | `install(JTextComponent c)` Called when the UI is being installed into the interface of a JTextComponent.
`void` | `paint(java.awt.Graphics g)` Renders the highlights.
`void` | `paintLayeredHighlights(java.awt.Graphics g, int p0, int p1, java.awt.Shape viewBounds, JTextComponent editor, View view)` When leaf Views (such as LabelView) are rendering they should call into this method.
`void` | `removeAllHighlights()` Removes all highlights.
`void` | `removeHighlight(java.lang.Object tag)` Removes a highlight from the view.
`void` | `setDrawsLayeredHighlights(boolean newValue)` If true, highlights are drawn as the Views draw the text.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### DefaultPainter

    public static LayeredHighlighter.LayerPainter DefaultPainter

Constructor Detail

### DefaultHighlighter

    public DefaultHighlighter()

  Creates a new DefaultHighlighther object.

Method Detail

### paint

    public void paint(java.awt.Graphics g)

  Renders the highlights.
  Parameters:
    `g` - the graphics context

### install

    public void install(JTextComponent c)

  Called when the UI is being installed into the interface of a JTextComponent. Installs the editor, and removes any existing highlights.
  Parameters:
    `c` - the editor component
  See Also:
    `Highlighter.install(javax.swing.text.JTextComponent)`

### deinstall

    public void deinstall(JTextComponent c)

  Called when the UI is being removed from the interface of a JTextComponent.
  Parameters:
    `c` - the component
  See Also:
    `Highlighter.deinstall(javax.swing.text.JTextComponent)`

### addHighlight

    public java.lang.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 start offset of the range to highlight >= 0
    `p1` - the end offset of the range to highlight >= p0
    `p` - the painter to use to actually render the highlight
  Throws:
    BadLocationException - if the specified location is invalid

### removeHighlight

    public void removeHighlight(java.lang.Object tag)

  Removes a highlight from the view.
  Parameters:
    `tag` - the reference to the highlight

### removeAllHighlights

    public void removeAllHighlights()

  Removes all highlights.

### changeHighlight

    public void changeHighlight(java.lang.Object tag,
                                int p0,
                                int p1)
                         throws BadLocationException

  Changes a highlight.
  Parameters:
    `tag` - the highlight tag
    `p0` - the beginning of the range >= 0
    `p1` - the end of the range >= p0
  Throws:
    BadLocationException - if the specified location is invalid

### getHighlights

    public Highlighter.Highlight[] getHighlights()

  Makes a copy of the highlights. Does not actually clone each highlight, but only makes references to them.
  Returns:
    the copy
  See Also:
    `Highlighter.getHighlights()`

### paintLayeredHighlights

    public void paintLayeredHighlights(java.awt.Graphics g,
                                       int p0,
                                       int p1,
                                       java.awt.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
  Overrides:
    paintLayeredHighlights in class LayeredHighlighter

### setDrawsLayeredHighlights

    public void setDrawsLayeredHighlights(boolean newValue)

  If true, highlights are drawn as the Views draw the text. That is the Views will call into `paintLayeredHighlight` which will result in a rectangle being drawn before the text is drawn (if the offsets are in a highlighted region that is). For this to work the painter supplied must be an instance of LayeredHighlightPainter.

### getDrawsLayeredHighlights

    public boolean getDrawsLayeredHighlights()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Swing 1.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.