org.eclipse.emf.edit.provider

Class StyledString

java.lang.Object

org.eclipse.emf.edit.provider.StyledString

All Implemented Interfaces:

java.lang.Iterable<StyledString.Fragment>

public final class StyledString
extends java.lang.Object
implements java.lang.Iterable<StyledString.Fragment>

A mutable string with styled ranges similar to JFaces's SyledString. All fragments mark substrings of the string and do not overlap. Styles are applied using instances of StyledString.Style. It can be iterated to get all composing fragments.

Since:

2.10

Author:

Mikael Barbero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StyledString.Fragment An immutable string styled with a given StyledString.Style.
static class	StyledString.Style An immutable object describing how a StyledString should be style.

Constructor Summary

Constructors

Constructor and Description
StyledString() Constructs an empty styled string.
StyledString(java.lang.String text) Constructs a new styled string with the given text with no associated style.
StyledString(java.lang.String text, StyledString.Style style) Constructs a new styled string with the given text associated with the given style.

Method Summary

Methods

Modifier and Type	Method and Description
StyledString	append(java.lang.String string) Appends a string with a style to the StyledString.
StyledString	append(java.lang.String string, StyledString.Style style) Appends a string with a style to the StyledString.
StyledString	append(StyledString styledString) Appends a string with styles to the StyledString.
java.lang.String	getString() Returns the string of this StyledString.
java.util.Iterator<StyledString.Fragment>	iterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

StyledString

public StyledString()

Constructs an empty styled string.

StyledString

public StyledString(java.lang.String text)

Constructs a new styled string with the given text with no associated style.

StyledString

public StyledString(java.lang.String text,
            StyledString.Style style)

Constructs a new styled string with the given text associated with the given style.

Method Detail

getString

public java.lang.String getString()

Returns the string of this StyledString.

Returns:

the current string of this StyledString.

append

public StyledString append(java.lang.String string)

Appends a string with a style to the StyledString. The appended string will be not be styled.

Parameters:

string - the string to append

Returns:

returns a reference to this object

append

public StyledString append(java.lang.String string,
                  StyledString.Style style)

Appends a string with a style to the StyledString. The appended string will be styled with the given style.

Parameters:

string - the string to append

style - the style to use for styling the string to append or null if no style should be associated with the appended string.

Returns:

returns a reference to this object

append

public StyledString append(StyledString styledString)

Appends a string with styles to the StyledString.

Parameters:

styledString - the string to append

Returns:

returns a reference to this object

iterator

public java.util.Iterator<StyledString.Fragment> iterator()

Specified by:

iterator in interface java.lang.Iterable<StyledString.Fragment>