oracle.javatools.editor.highlight

Class HighlightedText

java.lang.Object

oracle.javatools.editor.highlight.HighlightedText

Direct Known Subclasses:

HighlightedLine

public class HighlightedText
extends java.lang.Object

A HighlightedText object represents a segment of text that has a HighlightStyle applied to it. It is created by calling addHighlight() in a highlight layer on a region of text.

When trying to change the highlight style or offsets for a HighlightedText object, the change must be done through the highlight layer so that the editor view can be properly repainted. Clients are not allowed to call the set*() accessor methods here directly.

Field Summary

Fields

Modifier and Type	Field and Description
protected OffsetMark	endMark The ending offset for this region of highlighted text (exclusive.)
protected HighlightStyle	highlightStyle The highlight style to use for rendering this fragment.
protected OffsetMark	startMark The starting offset for this region of highlighted text (exclusive.)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HighlightedText(HighlightStyle highlightStyle, OffsetMark startMark, OffsetMark endMark) Constructs a new HighlightedText object

Method Summary

Modifier and Type	Method and Description
int	getEndOffset() Fetches the ending offset of the highlight.
HighlightStyle	getHighlightStyle() Fetches the highlight style used for this region of highlight.
int	getStartOffset() Fetches the starting offset of the highlight.
boolean	isLineHighlight() Fetch whether this highlight is a line highlight or not.

Methods inherited from class java.lang.Object

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

Field Detail

highlightStyle

protected HighlightStyle highlightStyle

The highlight style to use for rendering this fragment.

startMark

protected OffsetMark startMark

The starting offset for this region of highlighted text (exclusive.)

endMark

protected OffsetMark endMark

The ending offset for this region of highlighted text (exclusive.)

Constructor Detail

HighlightedText

protected HighlightedText(HighlightStyle highlightStyle,
                          OffsetMark startMark,
                          OffsetMark endMark)

Constructs a new HighlightedText object

Parameters:

highlightStyle - the highlightStyle to use

startMark - starting offset

endMark - ending offset (exclusive)

Method Detail

getHighlightStyle

public HighlightStyle getHighlightStyle()

Fetches the highlight style used for this region of highlight.

Returns:

the highlight style

getStartOffset

public int getStartOffset()

Fetches the starting offset of the highlight.

Returns:

the starting offset

getEndOffset

public int getEndOffset()

Fetches the ending offset of the highlight.

Returns:

the ending offset

isLineHighlight

public boolean isLineHighlight()

Fetch whether this highlight is a line highlight or not.

Returns:

true if this is a line highlight