Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

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

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

Constructor Summary
 DefaultHighlighter()
Creates a new object.
 

Method Summary
Object  addHighlight(int p0, int p1, Highlighter.HighlightPainter p)
Adds a highlight to the view.
void  changeHighlight(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.
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(Graphics g)
Renders the highlights.
void  removeAllHighlights()
Removes all highlights.
void  removeHighlight(Object tag)
Removes a highlight from the view.
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultHighlighter

public DefaultHighlighter()
Creates a new object.
Method Detail

paint

public void paint(Graphics g)
Renders the highlights.
Implements:
paint in interface Highlighter
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 document model.
Implements:
install in interface Highlighter
Parameters:
c - the component
See Also:
install

deinstall

public void deinstall(JTextComponent c)
Called when the UI is being removed from the interface of a JTextComponent.
Implements:
deinstall in interface Highlighter
Parameters:
c - the component
See Also:
deinstall

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.
Implements:
addHighlight in interface Highlighter
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

removeHighlight

public void removeHighlight(Object tag)
Removes a highlight from the view.
Implements:
removeHighlight in interface Highlighter
Parameters:
tag - the reference to the highlight

removeAllHighlights

public void removeAllHighlights()
Removes all highlights.
Implements:
removeAllHighlights in interface Highlighter

changeHighlight

public void changeHighlight(Object tag,
                            int p0,
                            int p1) throws BadLocationException
Changes a highlight.
Implements:
changeHighlight in interface Highlighter
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

getHighlights

public Highlighter.Highlight[] getHighlights()
Makes a copy of the highlights.
Implements:
getHighlights in interface Highlighter
Returns:
the copy
See Also:
getHighlights

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
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.