oracle.javatools.ui

Class AttributedStringBuilder<K extends java.text.AttributedCharacterIterator.Attribute,V>

java.lang.Object

oracle.javatools.ui.AttributedStringBuilder<K,V>

public final class AttributedStringBuilder<K extends java.text.AttributedCharacterIterator.Attribute,V>
extends java.lang.Object

A class to help construct an AttributedString.

The AttributedString is built up in sections by supplying runs (a string and common attributes). When desired the runs can be combined into one AttributedString by calling toAttributedString().

Field Summary

Fields

Modifier and Type	Field and Description
static java.text.AttributedString	EMPTY_ATTRIBUTED_STRING

Constructor Summary

Constructors

Constructor and Description
AttributedStringBuilder(java.text.AttributedString attributedString)
AttributedStringBuilder(java.lang.String text) Create an AttributedStringBuilder.
AttributedStringBuilder(java.lang.String text, K attribute, V value) Create an AttributedStringBuilder, supplying the initial text run.
AttributedStringBuilder(java.lang.String text, java.util.Map<K,V> attributes) Create an AttributedStringBuilder, supplying the initial run.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(K key, V value) Add an attribute to the entire set of runs, up to this point.
void	append(java.text.AttributedString attributedString) Append the attributedString
void	append(java.lang.String text) Append text with no attributes.
void	append(java.lang.String text, K attribute, V value) Append a run of text with the given attribute and value.
void	append(java.lang.String text, java.util.Map<K,V> attributes) Append a run of text with the given set of attributes and values.
static char	charAt(java.text.AttributedString as, int i) Return the char at the given index.
java.text.AttributedString	toAttributedString() Construct an AttributedString from all the supplied runs so far.
static java.lang.String	toString(java.text.AttributedString as) Convert an AttributedString to a plain string with no attributes.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ATTRIBUTED_STRING

public static final java.text.AttributedString EMPTY_ATTRIBUTED_STRING

Constructor Detail

AttributedStringBuilder

public AttributedStringBuilder(java.lang.String text)

Create an AttributedStringBuilder.

Parameters:

text - the initial run on text with no attributes.

AttributedStringBuilder

public AttributedStringBuilder(java.text.AttributedString attributedString)

AttributedStringBuilder

public AttributedStringBuilder(java.lang.String text,
                               K attribute,
                               V value)

Create an AttributedStringBuilder, supplying the initial text run.

Parameters:

text - the initial text

attribute - an attribute to cover the entire initial text.

value - the value for the attribute.

AttributedStringBuilder

public AttributedStringBuilder(java.lang.String text,
                               java.util.Map<K,V> attributes)

Create an AttributedStringBuilder, supplying the initial run.

Parameters:

text - the initial text

attributes - a map of attributes and values to cover the entire initial run.

Method Detail

append

public void append(java.lang.String text)

Append text with no attributes.

Parameters:

text -

append

public void append(java.text.AttributedString attributedString)

Append the attributedString

Parameters:

text -

append

public void append(java.lang.String text,
                   K attribute,
                   V value)

Append a run of text with the given attribute and value.

Parameters:

text -

attribute -

value -

append

public void append(java.lang.String text,
                   java.util.Map<K,V> attributes)

Append a run of text with the given set of attributes and values.

Parameters:

text -

attributes -

toAttributedString

public java.text.AttributedString toAttributedString()

Construct an AttributedString from all the supplied runs so far.

Returns:

toString

public static java.lang.String toString(java.text.AttributedString as)

Convert an AttributedString to a plain string with no attributes.

Parameters:

as -

Returns:

charAt

public static char charAt(java.text.AttributedString as,
                          int i)

Return the char at the given index.

Parameters:

as -

i -

Returns:

addAttribute

public void addAttribute(K key,
                         V value)

Add an attribute to the entire set of runs, up to this point. Later runs will not be affected.

Parameters:

attribute -

value -