org.eclipse.fx.ui.controls.styledtext

Class StyleRange

java.lang.Object

org.eclipse.fx.ui.controls.styledtext.TextStyle

org.eclipse.fx.ui.controls.styledtext.StyleRange

All Implemented Interfaces:

java.lang.Cloneable

public class StyleRange
extends TextStyle
implements java.lang.Cloneable

StyleRange defines a set of styles for a specified range of text.

The hashCode() method in this class uses the values of the public fields to compute the hash value. When storing instances of the class in hashed collections, do not modify these fields after the object has been inserted.

See Also:

Sample code and further information

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOLD The font style constant indicating a bold weight font (value is 1<<0).
int	fontStyle the font style of the range.
static int	ITALIC The font style constant indicating an italic font (value is 1<<1).
int	length the length of the range
static int	NORMAL The font style constant indicating a normal weight, non-italic font (value is 0).
int	start the start offset of the range, zero-based from the document start

Fields inherited from class org.eclipse.fx.ui.controls.styledtext.TextStyle

background, BORDER_DASH, BORDER_DOT, BORDER_SOLID, borderColor, borderStyle, data, font, foreground, hoverStylename, NONE, rise, strikeout, strikeoutColor, stylename, underline, UNDERLINE_DOUBLE, UNDERLINE_ERROR, UNDERLINE_LINK, UNDERLINE_SINGLE, UNDERLINE_SQUIGGLE, underlineColor, underlineStyle

Constructor Summary

Constructors

Constructor and Description
StyleRange(java.lang.String stylename) Create a new style range with no styles
StyleRange(java.lang.String stylename, int start, int length, javafx.scene.paint.Color foreground, javafx.scene.paint.Color background) Create a new style range.
StyleRange(java.lang.String stylename, int start, int length, javafx.scene.paint.Color foreground, javafx.scene.paint.Color background, int fontStyle) Create a new style range.
StyleRange(TextStyle style) Create a new style range from an existing text style.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a new StyleRange with the same values as this StyleRange.
boolean	equals(java.lang.Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
int	hashCode() Returns an integer hash code for the receiver.
boolean	isUnstyled() Returns whether or not the receiver is unstyled (i.e., does not have any style attributes specified).
boolean	similarTo(StyleRange style) Compares the specified object to this StyleRange and answer if the two are similar.
java.lang.String	toString() Returns a string containing a concise, human-readable description of the receiver.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NORMAL

public static final int NORMAL

The font style constant indicating a normal weight, non-italic font (value is 0). This constant is also used with ProgressBar to indicate a normal state.

Used By:

• ProgressBar

See Also:

Constant Field Values

BOLD

public static final int BOLD

The font style constant indicating a bold weight font (value is 1<<0).

See Also:

Constant Field Values

ITALIC

public static final int ITALIC

The font style constant indicating an italic font (value is 1<<1).

See Also:

Constant Field Values

start

public int start

the start offset of the range, zero-based from the document start

length

public int length

the length of the range

fontStyle

public int fontStyle

the font style of the range. It may be a combination of SWT.NORMAL, SWT.ITALIC or SWT.BOLD Note: the font style is not used if the font attribute is set

Constructor Detail

StyleRange

public StyleRange(java.lang.String stylename)

Create a new style range with no styles

Parameters:

stylename - the css stylename

Since:

3.2

StyleRange

public StyleRange(TextStyle style)

Create a new style range from an existing text style.

Parameters:

style - the text style to copy

Since:

3.4

StyleRange

public StyleRange(java.lang.String stylename,
                  int start,
                  int length,
                  javafx.scene.paint.Color foreground,
                  javafx.scene.paint.Color background)

Create a new style range.

Parameters:

stylename - the css stylename

start - start offset of the style

length - length of the style

foreground - foreground color of the style, null if none

background - background color of the style, null if none

StyleRange

public StyleRange(java.lang.String stylename,
                  int start,
                  int length,
                  javafx.scene.paint.Color foreground,
                  javafx.scene.paint.Color background,
                  int fontStyle)

Create a new style range.

Parameters:

stylename - the css stylename

start - start offset of the style

length - length of the style

foreground - foreground color of the style, null if none

background - background color of the style, null if none

fontStyle - font style of the style, may be SWT.NORMAL, SWT.ITALIC or SWT.BOLD

Method Detail

equals

public boolean equals(java.lang.Object object)

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.

Overrides:

equals in class TextStyle

Parameters:

object - the object to compare with this object

Returns:

true if the object is the same as this object and false otherwise

See Also:

hashCode()

hashCode

public int hashCode()

Returns an integer hash code for the receiver. Any two objects that return true when passed to equals must return the same value for this method.

Overrides:

hashCode in class TextStyle

Returns:

the receiver's hash

See Also:

equals(Object)

isUnstyled

public boolean isUnstyled()

Returns whether or not the receiver is unstyled (i.e., does not have any style attributes specified).

Returns:

true if the receiver is unstyled, false otherwise.

similarTo

public boolean similarTo(StyleRange style)

Compares the specified object to this StyleRange and answer if the two are similar. The object must be an instance of StyleRange and have the same field values for except for start and length.

Parameters:

style - the object to compare with this object

Returns:

true if the objects are similar, false otherwise

clone

public java.lang.Object clone()

Returns a new StyleRange with the same values as this StyleRange.

Overrides:

clone in class java.lang.Object

Returns:

a shallow copy of this StyleRange

toString

public java.lang.String toString()

Returns a string containing a concise, human-readable description of the receiver.

Overrides:

toString in class TextStyle

Returns:

a string representation of the StyleRange