public interface AttributedCharacterIterator extends CharacterIterator
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:
null
for the entire range, or
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.
When getting a run with no explicit attributes specified (i.e.,
calling getRunStart()
and getRunLimit()
), any
contiguous text segments having the same attributes (the same set
of attribute/value pairs) are treated as separate runs if the
attributes have been given to those text segments separately.
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 TextAttribute
.
AttributedCharacterIterator.Attribute
,
TextAttribute
,
AttributedString
,
Annotation
Modifier and Type | Interface and Description |
---|---|
static class |
AttributedCharacterIterator.Attribute
Defines attribute keys that are used to identify text attributes.
|
DONE
Modifier and Type | Method and Description |
---|---|
Set<AttributedCharacterIterator.Attribute> |
getAllAttributeKeys()
Returns the keys of all attributes defined on the
iterator's text range.
|
Object |
getAttribute(AttributedCharacterIterator.Attribute attribute)
Returns the value of the named
attribute for the current character. |
Map<AttributedCharacterIterator.Attribute,Object> |
getAttributes()
Returns a map with the attributes defined on the current
character.
|
int |
getRunLimit()
Returns the index of the first character following the run
with respect to all attributes containing the current character.
|
int |
getRunLimit(AttributedCharacterIterator.Attribute attribute)
Returns the index of the first character following the run
with respect to the given
attribute containing the current character. |
int |
getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)
Returns the index of the first character following the run
with respect to the given
attributes containing the current character. |
int |
getRunStart()
Returns the index of the first character of the run
with respect to all attributes containing the current character.
|
int |
getRunStart(AttributedCharacterIterator.Attribute attribute)
Returns the index of the first character of the run
with respect to the given
attribute containing the current character. |
int |
getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)
Returns the index of the first character of the run
with respect to the given
attributes containing the current character. |
clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex
int getRunStart()
Any contiguous text segments having the same attributes (the same set of attribute/value pairs) are treated as separate runs if the attributes have been given to those text segments separately.
int getRunStart(AttributedCharacterIterator.Attribute attribute)
attribute
containing the current character.attribute
- the desired attribute.int getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)
attributes
containing the current character.attributes
- a set of the desired attributes.int getRunLimit()
Any contiguous text segments having the same attributes (the same set of attribute/value pairs) are treated as separate runs if the attributes have been given to those text segments separately.
int getRunLimit(AttributedCharacterIterator.Attribute attribute)
attribute
containing the current character.attribute
- the desired attributeint getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)
attributes
containing the current character.attributes
- a set of the desired attributesMap<AttributedCharacterIterator.Attribute,Object> getAttributes()
Object getAttribute(AttributedCharacterIterator.Attribute attribute)
attribute
for the current character.
Returns null
if the attribute
is not defined.attribute
- the desired attributeattribute
or null
Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2021, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.