Class LayeredHighlighter

java.lang.Object

javax.swing.text.LayeredHighlighter

All Implemented Interfaces:: Highlighter

Direct Known Subclasses:: DefaultHighlighter

public abstract class LayeredHighlighter extends Object implements Highlighter

Implementation of Highlighter interface to mark up the background of leaf views with colored areas.

See Also:

Nested Class Summary

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

Nested classes/interfaces declared in interface Highlighter

Highlighter.Highlight, Highlighter.HighlightPainter

Constructor Summary

LayeredHighlighter()

Modifier	Constructor	Description
`protected`	Constructor for subclasses to call.

Method Summary

Modifier and Type	Method	Description
`abstract 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.

Methods declared in class Object

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

Methods declared in interface Highlighter

addHighlight, changeHighlight, deinstall, getHighlights, install, paint, removeAllHighlights, removeHighlight

Constructor Details

LayeredHighlighter

protected LayeredHighlighter()

Constructor for subclasses to call.

Method Details

paintLayeredHighlights

public abstract 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.

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

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/text/LayeredHighlighter.html