org.eclipse.fx.text.ui

Class TextAttribute

java.lang.Object

org.eclipse.fx.text.ui.TextAttribute

public class TextAttribute
extends java.lang.Object

Description of textual attributes such as color and style. Text attributes are considered value objects.

Clients usually instantiate object of the class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STRIKETHROUGH Text attribute for strikethrough style.
static int	UNDERLINE Text attribute for underline style.

Constructor Summary

Constructors

Constructor and Description
TextAttribute(java.lang.String stylename)
TextAttribute(java.lang.String stylename, javafx.scene.paint.Color foreground) Creates a text attribute for the given foreground color, no background color and with the SWT normal style.
TextAttribute(java.lang.String stylename, javafx.scene.paint.Color foreground, javafx.scene.paint.Color background, int style) Creates a text attribute with the given colors and style.
TextAttribute(java.lang.String stylename, javafx.scene.paint.Color foreground, javafx.scene.paint.Color background, int style, javafx.scene.text.Font font) Creates a text attribute with the given colors and style.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
javafx.scene.paint.Color	getBackground() Returns the attribute's background color.
javafx.scene.text.Font	getFont() Returns the attribute's font.
javafx.scene.paint.Color	getForeground() Returns the attribute's foreground color.
int	getStyle() Returns the attribute's style.
java.lang.String	getStylename()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

STRIKETHROUGH

public static final int STRIKETHROUGH

Text attribute for strikethrough style. (value 1 << 29).

Since:

3.1

See Also:

Constant Field Values

UNDERLINE

public static final int UNDERLINE

Text attribute for underline style. (value 1 << 30)

Since:

3.1

See Also:

Constant Field Values

Constructor Detail

TextAttribute

public TextAttribute(java.lang.String stylename,
                     javafx.scene.paint.Color foreground,
                     javafx.scene.paint.Color background,
                     int style)

Creates a text attribute with the given colors and style.

Parameters:

foreground - the foreground color, null if none

background - the background color, null if none

style - the style

TextAttribute

public TextAttribute(java.lang.String stylename,
                     javafx.scene.paint.Color foreground,
                     javafx.scene.paint.Color background,
                     int style,
                     javafx.scene.text.Font font)

Creates a text attribute with the given colors and style.

Parameters:

foreground - the foreground color, null if none

background - the background color, null if none

style - the style

font - the font, null if none

Since:

3.3

TextAttribute

public TextAttribute(java.lang.String stylename,
                     javafx.scene.paint.Color foreground)

Creates a text attribute for the given foreground color, no background color and with the SWT normal style.

Parameters:

foreground - the foreground color, null if none

TextAttribute

public TextAttribute(java.lang.String stylename)

Method Detail

getStylename

public java.lang.String getStylename()

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getForeground

public javafx.scene.paint.Color getForeground()

Returns the attribute's foreground color.

Returns:

the attribute's foreground color or null if not set

getBackground

public javafx.scene.paint.Color getBackground()

Returns the attribute's background color.

Returns:

the attribute's background color or null if not set

getStyle

public int getStyle()

Returns the attribute's style.

Returns:

the attribute's style

getFont

public javafx.scene.text.Font getFont()

Returns the attribute's font.

Returns:

the attribute's font or null if not set

Since:

3.3