|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Highlighter
An interface for an object that allows one to mark up the background with colored areas.
| Nested Class Summary | |
|---|---|
static interface |
Highlighter.Highlight
|
static interface |
Highlighter.HighlightPainter
Highlight renderer. |
| 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 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. |
| Method Detail |
|---|
void install(JTextComponent c)
c - the JTextComponent editorvoid deinstall(JTextComponent c)
c - the JTextComponent editorvoid paint(Graphics g)
g - the graphics context.
Object addHighlight(int p0,
int p1,
Highlighter.HighlightPainter p)
throws BadLocationException
p0 - the beginning of the range >= 0p1 - the end of the range >= p0p - the painter to use for the actual highlighting
BadLocationException - for an invalid range specificationvoid removeHighlight(Object tag)
tag - which highlight to removevoid removeAllHighlights()
void changeHighlight(Object tag,
int p0,
int p1)
throws BadLocationException
tag - which highlight to changep0 - the beginning of the range >= 0p1 - the end of the range >= p0
BadLocationException - for an invalid range specificationHighlighter.Highlight[] getHighlights()
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.