java.text: public interface: AttributedCharacterIterator

java.text
public interface: AttributedCharacterIterator [javadoc | source]

All Implemented Interfaces:
CharacterIterator

All Known Implementing Classes:
AttributedSegment, AttributedStringIterator, AttributedStringIterator

An {@code 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 {@code null} for the entire range, or
the attribute value is defined and has the same non-{@code 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 java.awt.font.TextAttribute .

Also see:

AttributedCharacterIterator.Attribute

java.awt.font.TextAttribute

AttributedString

Annotation

since: 1.2 -

Nested Class Summary:
public static class	AttributedCharacterIterator.Attribute	Defines attribute keys that are used to identify text attributes. These keys are used in {@code AttributedCharacterIterator} and {@code AttributedString}.

Method from java.text.AttributedCharacterIterator Summary:
getAllAttributeKeys, getAttribute, getAttributes, getRunLimit, getRunLimit, getRunLimit, getRunStart, getRunStart, getRunStart

Method from java.text.AttributedCharacterIterator Detail:
public Set<Attribute> getAllAttributeKeys() Returns the keys of all attributes defined on the iterator's text range. The set is empty if no attributes are defined.
public Object getAttribute(Attribute attribute) Returns the value of the named {@code attribute} for the current character. Returns {@code null} if the {@code attribute} is not defined.
public Map<Attribute, Object> getAttributes() Returns a map with the attributes defined on the current character.
public int getRunLimit() Returns the index of the first character following the run with respect to all attributes containing the current character. 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.
public int getRunLimit(Attribute attribute) Returns the index of the first character following the run with respect to the given {@code attribute} containing the current character.
public int getRunLimit(Set<Attribute> attributes) Returns the index of the first character following the run with respect to the given {@code attributes} containing the current character.
public int getRunStart() Returns the index of the first character of the run with respect to all attributes containing the current character. 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.
public int getRunStart(Attribute attribute) Returns the index of the first character of the run with respect to the given {@code attribute} containing the current character.
public int getRunStart(Set<Attribute> attributes) Returns the index of the first character of the run with respect to the given {@code attributes} containing the current character.