org.eclipse.fx.ui.controls.styledtext

Class StyledString

java.lang.Object

org.eclipse.fx.ui.controls.styledtext.StyledString

All Implemented Interfaces:

java.lang.CharSequence

public class StyledString
extends java.lang.Object
implements java.lang.CharSequence

A string with styling informations This is an experimental component provided as a preview we'll improve and fix problems in up coming releases

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
StyledString() Create a styled string

Method Summary

Modifier and Type	Method and Description
void	appendSegment(java.lang.String text, java.util.List<java.lang.String> styleClass) Append a new segment with the given text and styleclasses
void	appendSegment(java.lang.String text, java.lang.String... styleClass) Append a new segment with the given text and styleclasses
char	charAt(int index)
javafx.collections.ObservableList<StyledStringSegment>	getSegmentList()
int	length()
java.lang.CharSequence	subSequence(int start, int end)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

StyledString

public StyledString()

Create a styled string

Method Detail

length

public int length()

Specified by:

length in interface java.lang.CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

toString

public java.lang.String toString()

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Object

getSegmentList

public javafx.collections.ObservableList<StyledStringSegment> getSegmentList()

Returns:

list of segments

appendSegment

public void appendSegment(java.lang.String text,
                          java.lang.String... styleClass)

Append a new segment with the given text and styleclasses

Parameters:

text - the text

styleClass - the style classes

See Also:

StyledStringSegment(String, String...)

appendSegment

public void appendSegment(java.lang.String text,
                          java.util.List<java.lang.String> styleClass)

Append a new segment with the given text and styleclasses

Parameters:

text - the text

styleClass - the style classes

See Also:

StyledStringSegment(String, List)