Extension SDK 10.1.2


oracle.javatools.editor.underline
Class UnderlinedText

java.lang.Object
  extended byoracle.javatools.editor.underline.UnderlinedText


public final class UnderlinedText
extends java.lang.Object

A UnderlinedText object represents a segment of text that has an UnderlineStyle applied to it. It is created by calling addUnderlinedText() in a underline layer on a region of text.

When trying to change the underline style or offsets for an UnderlinedText object, the change must be done through the underline layer so that the editor view can be properly repainted.


Field Summary
protected OffsetMark endMark
The ending offset for this region of underlined text (exclusive.)
protected OffsetMark startMark
The starting offset for this region of underlined text (inclusive.)
protected UnderlineStyle underlineStyle
The underline style to use for rendering this fragment.

Constructor Summary
protected UnderlinedText(UnderlineStyle underlineStyle, OffsetMark startMark, OffsetMark endMark)
Constructs a new UnderlinedText object

Method Summary
int getEndOffset()
Fetches the ending offset of the underline.
int getStartOffset()
Fetches the starting offset of the underline.
UnderlineStyle getUnderlineStyle()
Fetches the underline style used for this region of underline.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

underlineStyle

protected UnderlineStyle underlineStyle
The underline style to use for rendering this fragment.

startMark

protected OffsetMark startMark
The starting offset for this region of underlined text (inclusive.)

endMark

protected OffsetMark endMark
The ending offset for this region of underlined text (exclusive.)

Constructor Detail

UnderlinedText

protected UnderlinedText(UnderlineStyle underlineStyle,
                         OffsetMark startMark,
                         OffsetMark endMark)
Constructs a new UnderlinedText object
Parameters:
underlineStyle - the underlineStyle to use
startMark - starting offset (inclusive)
endMark - ending offset (exclusive)

Method Detail

getUnderlineStyle

public UnderlineStyle getUnderlineStyle()
Fetches the underline style used for this region of underline.
Returns:
the underline style

getStartOffset

public int getStartOffset()
Fetches the starting offset of the underline.
Returns:
the starting offset

getEndOffset

public int getEndOffset()
Fetches the ending offset of the underline.
Returns:
the ending offset

Extension SDK


Copyright © 1997, 2004, Oracle. All rights reserved.