All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.swing.text.DefaultHighlighter 

java.lang.Object
    |
    +----java.awt.swing.text.DefaultHighlighter
public class DefaultHighlighter
extends Object
implements Highlighter
Implements the Highlighter interfaces. Implements a simple highlight painter that renders in a solid color.

See Also:
Highlighter

Class Index

o DefaultHighlighter.DefaultHighlightPainter
Simple highlight painter that fills a highlighted area with a solid color.

Constructor Index

o DefaultHighlighter()
Creates a new object.

Method Index

o addHighlight(int, int, Highlighter.HighlightPainter)
Adds a highlight to the view.
o changeHighlight(Object, int, int)
Changes a highlight.
o deinstall(JTextComponent)
Called when the UI is being removed from the interface of a JTextComponent.
o getHighlights()
Makes a copy of the highlights.
o install(JTextComponent)
Called when the UI is being installed into the interface of a JTextComponent.
o paint(Graphics)
Renders the highlights.
o removeAllHighlights()
Removes all highlights.
o removeHighlight(Object)
Removes a highlight from the view.

Constructors

o DefaultHighlighter 
public DefaultHighlighter()
Creates a new object.

Methods

o paint 
public void paint(Graphics g)
Renders the highlights.

Parameters:
g - the graphics context
o install 
public void install(JTextComponent c)
Called when the UI is being installed into the interface of a JTextComponent. Installs the document model.

Parameters:
c - the component
See Also:
install
o 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:
deinstall
o addHighlight 
public 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
p1 - the end offset of the range to highlight
p - the painter to use to actually render the highlight
Throws: BadLocationException
if the specified location is invalid
o removeHighlight 
public void removeHighlight(Object tag)
Removes a highlight from the view.

Parameters:
tag - the reference to the highlight
o removeAllHighlights 
public void removeAllHighlights()
Removes all highlights.

o changeHighlight 
public void changeHighlight(Object tag,
                            int p0,
                            int p1) throws BadLocationException
Changes a highlight.

Parameters:
tag - the highlight tag
p0 - the beginning of the range
p1 - the end of the range
Throws: BadLocationException
if the specified location is invalid
o getHighlights 
public Highlighter.Highlight[] getHighlights()
Makes a copy of the highlights.

Returns:
the copy
See Also:
getHighlights
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature