An AttributedCharacterIterator allows iteration through both text and
related attribute information.
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.
A run with respect to an attribute is a maximum text range for
which:
- the attribute is undefined or null for the entire range, or
- the attribute value is defined and has the same non-null value for the
entire range.
A run with respect to a set of attributes is a maximum text range for
which this condition is met for each member attribute.
The returned indexes are limited to the range of the iterator.
The returned attribute information is limited to runs that contain
the current character.
Attribute keys are instances of AttributedCharacterIterator.Attribute and its
subclasses, such as java.awt.font.TextAttribute.
Constant that is returned when the iterator has reached either the end
or the beginning of the text. The value is '\\uFFFF', the "not a
character" value which should not occur in any valid Unicode string.
Create a copy of this iterator
Gets the character at the current position (as returned by getIndex()).
Sets the position to getBeginIndex() and returns the character at that
position.
Returns the keys of all attributes defined on the
iterator's text range. The set is empty if no
attributes are defined.
Returns the value of the named attribute for the current character.
Returns null if the attribute is not defined.
Returns a map with the attributes defined on the current
character.
Returns the start index of the text.
Returns the end index of the text. This index is the index of the first
character following the end of the text.
Returns the current index.
Returns the index of the first character following the run
with respect to all attributes containing the current character.
Returns the index of the first character following the run
with respect to the given attribute containing the current character.
Returns the index of the first character following the run
with respect to the given attributes containing the current character.
Returns the index of the first character of the run
with respect to all attributes containing the current character.
Returns the index of the first character of the run
with respect to the given attribute containing the current character.
Returns the index of the first character of the run
with respect to the given attributes containing the current character.
Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty)
and returns the character at that position.
Increments the iterator's index by one and returns the character
at the new index. If the resulting index is greater or equal
to getEndIndex(), the current index is reset to getEndIndex() and
a value of DONE is returned.
Decrements the iterator's index by one and returns the character
at the new index. If the current index is getBeginIndex(), the index
remains at getBeginIndex() and a value of DONE is returned.
Sets the position to the specified position in the text and returns that
character.