oracle.javatools.editor.underline
Class UnderlineStyle

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

public final class UnderlineStyle

extends java.lang.Object

An UnderlineStyle describes how an underline will be painted. It consists of a color, underline shape, whether it is enabled or not, and a priority level.

You can create new or modify existing styles through the UnderlineRegistry.

Field Summary

static int	MAXIMUM_PRIORITY The maximum priority level an underline can use.
static int	MINIMUM_PRIORITY The minimum priority level an underline can use.

Method Summary

java.awt.Color	getColor() Fetches the color of the underline.
boolean	getEnabled() Fetches the enabled status of this underline style.
java.lang.String	getName() Fetches the name of the underline.
UnderlinePainter	getPainter() Fetches the painter to use for painting the underline.
java.lang.String	getPresentationName() Fetch the visible or presentation name of the style.
int	getPriority() Fetches the priority of the underline.
java.lang.String	toString() Fetches the human-readable name of the style.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_PRIORITY

public static final int MINIMUM_PRIORITY

The minimum priority level an underline can use.

See Also:

Constant Field Values

MAXIMUM_PRIORITY

public static final int MAXIMUM_PRIORITY

The maximum priority level an underline can use.

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Fetches the name of the underline.

Returns:

the underline name

getPresentationName

public java.lang.String getPresentationName()

Fetch the visible or presentation name of the style. This is generally a translated name that can be used for UI purposes.

Returns:

the visible or presentation name of the style

toString

public java.lang.String toString()

Fetches the human-readable name of the style.

Returns:

the style name

getEnabled

public boolean getEnabled()

Fetches the enabled status of this underline style.

Returns:

whether this style is enabled or not

getPriority

public int getPriority()

Fetches the priority of the underline.

Returns:

the priority of the underline

getColor

public java.awt.Color getColor()

Fetches the color of the underline.

Returns:

the color of the underline

getPainter

public UnderlinePainter getPainter()

Fetches the painter to use for painting the underline.

Returns:

the painter for the underline