Class DefaultHighlighter

java.lang.Object

javax.swing.text.LayeredHighlighter

javax.swing.text.DefaultHighlighter

All Implemented Interfaces:: Highlighter

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:

Nested Class Summary

Modifier and Type	Class	Description
`static class`	`DefaultHighlighter.DefaultHighlightPainter`	Simple highlight painter that fills a highlighted area with a solid color.

Nested classes/interfaces declared in class LayeredHighlighter

LayeredHighlighter.LayerPainter

Modifier and Type	Class	Description
`static class`	`LayeredHighlighter.LayerPainter`	Layered highlight renderer.

Nested classes/interfaces declared in interface Highlighter

Highlighter.Highlight, Highlighter.HighlightPainter

Modifier and Type	Interface	Description
`static interface`	`Highlighter.Highlight`	A highlight.
`static interface`	`Highlighter.HighlightPainter`	Highlight renderer.

Field Summary

Modifier and Type	Field	Description
`static final LayeredHighlighter.LayerPainter`	`DefaultPainter`	Default implementation of LayeredHighlighter.LayerPainter that can be used for painting highlights.

Constructor Summary

Constructor	Description
`DefaultHighlighter()`	Creates a new DefaultHighlighter object.

Method Summary

Modifier and Type	Method	Description
`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.
`boolean`	`getDrawsLayeredHighlights()`	Return the draw layered highlights.
`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`	`paintLayeredHighlights(Graphics g, int p0, int p1, 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(Object tag)`	Removes a highlight from the view.
`void`	`setDrawsLayeredHighlights(boolean newValue)`	If true, highlights are drawn as the Views draw the text.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

DefaultPainter

public static final LayeredHighlighter.LayerPainter DefaultPainter

Default implementation of LayeredHighlighter.LayerPainter that can be used for painting highlights.

As of 1.4 this field is final.

Constructor Details

DefaultHighlighter

public DefaultHighlighter()

Creates a new DefaultHighlighter object.

Method Details

paint

public void paint(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:

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:

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 >= 0; p1 - the end offset of the range to highlight >= p0; p - the painter to use to actually render the highlight
Returns:: an object that can be used as a tag to refer to the highlight
Throws:: BadLocationException - if the specified location is invalid

removeHighlight

public void removeHighlight(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(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:

paintLayeredHighlights

public void paintLayeredHighlights(Graphics g, int p0, int p1, 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.

Specified by:: paintLayeredHighlights in class LayeredHighlighter
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

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.

Parameters:: newValue - the new value

getDrawsLayeredHighlights

public boolean getDrawsLayeredHighlights()

Return the draw layered highlights.

Returns:: the draw layered highlights

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.