Interface: java.text.AttributedCharacterIterator
- public interface AttributedCharacterIterator
- extends CharacterIterator
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.
Methods
-
getAllAttributeKeystop
Returns the keys of all attributes defined on the iterator's text range. The set is empty if no attributes are defined. -
getAttributetop
Returns the value of the named attribute for the current character. Returns null if the attribute is not defined. -
getAttributestop
Returns a map with the attributes defined on the current character. -
getRunLimittop
public int getRunLimit()Returns the index of the first character following the run with respect to all attributes containing the current character. -
getRunLimittop
public 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. -
getRunLimittop
Returns the index of the first character following the run with respect to the given attributes containing the current character. -
getRunStarttop
public int getRunStart()Returns the index of the first character of the run with respect to all attributes containing the current character. -
getRunStarttop
public 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. -
getRunStarttop
Returns the index of the first character of the run with respect to the given attributes containing the current character.