javax.swing.text
Interface Highlighter

All Known Implementing Classes:

LayeredHighlighter

public interface Highlighter

Unsafe:

Method Summary

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

Method Detail

install

public void install(JTextComponent c)

Suppressed: Called when the UI is being installed into the interface of a JTextComponent. This can be used to gain access to the model that is being navigated by the implementation of this interface.

Parameters:

c - the JTextComponent editor

deinstall

public void deinstall(JTextComponent c)

Suppressed: Called when the UI is being removed from the interface of a JTextComponent. This is used to unregister any listeners that were attached.

Parameters:

c - the JTextComponent editor

paint

public void paint(Graphics g)

Suppressed: Renders the highlights.

Parameters:

g - the graphics context.

addHighlight

public Object addHighlight(int p0,
                           int p1,
                           javax.swing.text.Highlighter.HighlightPainter p)
                    throws BadLocationException

Suppressed: Adds a highlight to the view. Returns a tag that can be used to refer to the highlight.

Parameters:

p0 - the beginning of the range >= 0

p1 - the end of the range >= p0

p - the painter to use for the actual highlighting

Returns:

an object that refers to the highlight

BadLocationException

removeHighlight

public void removeHighlight(Object tag)

Enabled: Removes a highlight from the view.

Parameters:

tag - which highlight to remove

removeAllHighlights

public void removeAllHighlights()

Enabled: Removes all highlights this highlighter is responsible for.

changeHighlight

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

Enabled: Changes the given highlight to span a different portion of the document. This may be more efficient than a remove/add when a selection is expanding/shrinking (such as a sweep with a mouse) by damaging only what changed.

Parameters:

tag - which highlight to change

p0 - the beginning of the range >= 0

p1 - the end of the range >= p0

BadLocationException

getHighlights

public javax.swing.text.Highlighter.Highlight[] getHighlights()

Suppressed: Fetches the current list of highlights.

Returns:

the highlight list