oracle.javatools.editor.underline
Class UnderlinedLine

java.lang.Object
  oracle.javatools.editor.underline.UnderlinedLine

public final class UnderlinedLine

extends java.lang.Object

A UnderlinedLine object is typically used as a separator to separate sections of a buffer from each other. For example, it may be used to separate Java methods in a Java file. It is created by calling addUnderlinedLine() in a underline layer on a region of text.

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

Field Summary

protected OffsetMark	lineStartMark The starting offset of the line (right-bias).
protected UnderlineStyle	underlineStyle The underline style to use for rendering this fragment.

Constructor Summary

protected

UnderlinedLine(UnderlineStyle underlineStyle, OffsetMark lineStartMark) Constructs a new UnderlinedLine object

Method Summary

int	getLineStartOffset() Fetches the starting offset of the line that has 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.

lineStartMark

protected OffsetMark lineStartMark

The starting offset of the line (right-bias).

Constructor Detail

UnderlinedLine

protected UnderlinedLine(UnderlineStyle underlineStyle,
                         OffsetMark lineStartMark)

Constructs a new UnderlinedLine object

Parameters:

underlineStyle - the underlineStyle to use

lineStartMark - the starting offset of the line.

Method Detail

getUnderlineStyle

public UnderlineStyle getUnderlineStyle()

Fetches the underline style used for this region of underline.

Returns:

the underline style

getLineStartOffset

public int getLineStartOffset()

Fetches the starting offset of the line that has the underline.

Returns:

the starting offset of the line