AttributedString JDK 1.6)

Description

public class AttributedString

An AttributedString holds text and related attribute information.

See also: AttributedCharacterIterator Annotation

Constructors

public AttributedString (AttributedCharacterIterator text)

Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator.

Constructs an AttributedString instance with the given attributed
text represented by AttributedCharacterIterator.
Parameters:
- text - The text for this attributed string.
Throws:
- NullPointerException - if text is null.

pack-private AttributedString (AttributedCharacterIterator iterators)

Constructs an AttributedString instance with the given AttributedCharacterIterators.

public AttributedString (AttributedCharacterIterator text, int beginIndex, int endIndex)

Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator.

Constructs an AttributedString instance with the subrange of
the given attributed text represented by
AttributedCharacterIterator. If the given range produces an
empty text, all attributes will be discarded. Note that any
attributes wrapped by an Annotation object are discarded for a
subrange of the original attribute range.
Parameters:
- text - The text for this attributed string.
- beginIndex - Index of the first character of the range.
- endIndex - Index of the character following the last character of the range.
Throws:
- NullPointerException - if text is null.
- IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
See Also: Annotation,

public AttributedString (AttributedCharacterIterator text, int beginIndex, int endIndex, Attribute attributes)

Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator.

Constructs an AttributedString instance with the subrange of
the given attributed text represented by
AttributedCharacterIterator. Only attributes that match the
given attributes will be incorporated into the instance. If the
given range produces an empty text, all attributes will be
discarded. Note that any attributes wrapped by an Annotation
object are discarded for a subrange of the original attribute
range.
Parameters:
- text - The text for this attributed string.
- beginIndex - Index of the first character of the range.
- endIndex - Index of the character following the last character of the range.
- attributes - Specifies attributes to be extracted from the text. If null is specified, all available attributes will be used.
Throws:
- NullPointerException - if text or attributes is null.
- IllegalArgumentException - if the subrange given by beginIndex and endIndex is out of the text range.
See Also: Annotation,

public AttributedString (String text)

Constructs an AttributedString instance with the given text.

Constructs an AttributedString instance with the given text.
Parameters:
- text - The text for this attributed string.
Throws:
- NullPointerException - if text is null.

public AttributedString (String text, Map<Attribute, Object> attributes)

Constructs an AttributedString instance with the given text and attributes.

Constructs an AttributedString instance with the given text and attributes.
Parameters:
- text - The text for this attributed string.
- attributes - The attributes that apply to the entire string.
Throws:
- NullPointerException - if text or attributes is null.
- IllegalArgumentException - if the text has length 0 and the attributes parameter is not an empty Map (attributes cannot be applied to a 0-length range).

Methods

Hide/Show inherited methods

public void addAttribute (Attribute attribute, Object value)

Adds an attribute to the entire string.

Adds an attribute to the entire string.
Parameters:
- attribute - the attribute key
- value - the value of the attribute; may be null
Throws:
- NullPointerException - if attribute is null.
- IllegalArgumentException - if the AttributedString has length 0 (attributes cannot be applied to a 0-length range).

public void addAttribute (Attribute attribute, Object value, int beginIndex, int endIndex)

Adds an attribute to a subrange of the string.

Adds an attribute to a subrange of the string.
Parameters:
- attribute - the attribute key
- value - The value of the attribute. May be null.
- beginIndex - Index of the first character of the range.
- endIndex - Index of the character following the last character of the range.
Throws:
- NullPointerException - if attribute is null.
- IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string.

public void addAttributes (Map<Attribute, Object> attributes, int beginIndex, int endIndex)

Adds a set of attributes to a subrange of the string.

Adds a set of attributes to a subrange of the string.
Parameters:
- attributes - The attributes to be added to the string.
- beginIndex - Index of the first character of the range.
- endIndex - Index of the character following the last character of the range.
Throws:
- NullPointerException - if attributes is null.
- IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string and the attributes parameter is not an empty Map.

public AttributedCharacterIterator getIterator ()

Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.

public AttributedCharacterIterator getIterator (Attribute attributes)

Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.

public AttributedCharacterIterator getIterator (Attribute attributes, int beginIndex, int endIndex)

Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.

pack-private int length ()