|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.text.AttributedString
public class AttributedString
An AttributedString holds text and related attribute information. It may be used as the actual data storage in some cases where a text reader wants to access attributed text through the AttributedCharacterIterator interface.
An attribute is a key/value pair, identified by the key. No two attributes on a given character can have the same key.
The values for an attribute are immutable, or must not be mutated by clients or storage. They are always passed by reference, and not cloned.
AttributedCharacterIterator
,
Annotation
Constructor Summary | |
---|---|
AttributedString(AttributedCharacterIterator text)
Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator. |
|
AttributedString(AttributedCharacterIterator text,
int beginIndex,
int endIndex)
Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. |
|
AttributedString(AttributedCharacterIterator text,
int beginIndex,
int endIndex,
AttributedCharacterIterator.Attribute[] attributes)
Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. |
|
AttributedString(String text)
Constructs an AttributedString instance with the given text. |
|
AttributedString(String text,
Map<? extends AttributedCharacterIterator.Attribute,?> attributes)
Constructs an AttributedString instance with the given text and attributes. |
Method Summary | |
---|---|
void |
addAttribute(AttributedCharacterIterator.Attribute attribute,
Object value)
Adds an attribute to the entire string. |
void |
addAttribute(AttributedCharacterIterator.Attribute attribute,
Object value,
int beginIndex,
int endIndex)
Adds an attribute to a subrange of the string. |
void |
addAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes,
int beginIndex,
int endIndex)
Adds a set of attributes to a subrange of the string. |
AttributedCharacterIterator |
getIterator()
Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string. |
AttributedCharacterIterator |
getIterator(AttributedCharacterIterator.Attribute[] attributes)
Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. |
AttributedCharacterIterator |
getIterator(AttributedCharacterIterator.Attribute[] attributes,
int beginIndex,
int endIndex)
Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AttributedString(String text)
text
- The text for this attributed string.
NullPointerException
- if text
is null.public AttributedString(String text, Map<? extends AttributedCharacterIterator.Attribute,?> attributes)
text
- The text for this attributed string.attributes
- The attributes that apply to the entire string.
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).public AttributedString(AttributedCharacterIterator text)
text
- The text for this attributed string.
NullPointerException
- if text
is null.public AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex)
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.
NullPointerException
- if text
is null.
IllegalArgumentException
- if the subrange given by
beginIndex and endIndex is out of the text range.Annotation
public AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex, AttributedCharacterIterator.Attribute[] attributes)
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.
NullPointerException
- if text
or
attributes
is null.
IllegalArgumentException
- if the subrange given by
beginIndex and endIndex is out of the text range.Annotation
Method Detail |
---|
public void addAttribute(AttributedCharacterIterator.Attribute attribute, Object value)
attribute
- the attribute keyvalue
- the value of the attribute; may be null
NullPointerException
- if attribute
is null.
IllegalArgumentException
- if the AttributedString has length 0
(attributes cannot be applied to a 0-length range).public void addAttribute(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex)
attribute
- the attribute keyvalue
- 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.
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<? extends AttributedCharacterIterator.Attribute,?> attributes, int beginIndex, int endIndex)
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.
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()
public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes)
attributes
- a list of attributes that the client is interested in
public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex)
attributes
- a list of attributes that the client is interested inbeginIndex
- the index of the first characterendIndex
- the index of the character following the last character
IllegalArgumentException
- if beginIndex is less then 0,
endIndex is greater than the length of the string, or beginIndex is
greater than endIndex.
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.