Added in API level 1

AttributedCharacterIterator

interface AttributedCharacterIterator : CharacterIterator

java.text.AttributedCharacterIterator

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.

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.

Summary

Nested classes
open	Attribute Defines attribute keys that are used to identify text attributes.

Inherited constants
From class CharacterIterator Char DONE 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.

Public methods
abstract MutableSet<AttributedCharacterIterator.Attribute!>!	getAllAttributeKeys() Returns the keys of all attributes defined on the iterator's text range.
abstract Any!	getAttribute(attribute: AttributedCharacterIterator.Attribute!) Returns the value of the named attribute for the current character.
abstract MutableMap<AttributedCharacterIterator.Attribute!, Any!>!	getAttributes() Returns a map with the attributes defined on the current character.
abstract Int	getRunLimit() Returns the index of the first character following the run with respect to all attributes containing the current character.
abstract Int	getRunLimit(attribute: AttributedCharacterIterator.Attribute!) Returns the index of the first character following the run with respect to the given attribute containing the current character.
abstract Int	getRunLimit(attributes: MutableSet<out AttributedCharacterIterator.Attribute!>!) Returns the index of the first character following the run with respect to the given attributes containing the current character.
abstract Int	getRunStart() Returns the index of the first character of the run with respect to all attributes containing the current character.
abstract Int	getRunStart(attribute: AttributedCharacterIterator.Attribute!) Returns the index of the first character of the run with respect to the given attribute containing the current character.
abstract Int	getRunStart(attributes: MutableSet<out AttributedCharacterIterator.Attribute!>!) Returns the index of the first character of the run with respect to the given attributes containing the current character.

Inherited functions

From class CharacterIterator Any clone() Create a copy of this iterator Char current() Gets the character at the current position (as returned by getIndex()). Char first() Sets the position to getBeginIndex() and returns the character at that position. Int getBeginIndex() Returns the start index of the text. Int getEndIndex() Returns the end index of the text. This index is the index of the first character following the end of the text. Int getIndex() Returns the current index. Char last() Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position. Char next() 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. Char previous() 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. Char setIndex(position: Int) Sets the position to the specified position in the text and returns that character.

Public methods

getAllAttributeKeys

Added in API level 1

abstract fun getAllAttributeKeys(): MutableSet<AttributedCharacterIterator.Attribute!>!

Returns the keys of all attributes defined on the iterator's text range. The set is empty if no attributes are defined.

Return
MutableSet<AttributedCharacterIterator.Attribute!>!	the keys of all attributes

getAttribute

Added in API level 1

abstract fun getAttribute(attribute: AttributedCharacterIterator.Attribute!): Any!

Returns the value of the named attribute for the current character. Returns null if the attribute is not defined.

Parameters
attribute	AttributedCharacterIterator.Attribute!: the desired attribute

Return
Any!	the value of the named attribute or null

getAttributes

Added in API level 1

abstract fun getAttributes(): MutableMap<AttributedCharacterIterator.Attribute!, Any!>!

Returns a map with the attributes defined on the current character.

Return
MutableMap<AttributedCharacterIterator.Attribute!, Any!>!	a map with the attributes defined on the current character

getRunLimit

Added in API level 1

abstract fun getRunLimit(): Int

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.

Return
Int	the index of the first character following the run

getRunLimit

Added in API level 1

abstract fun getRunLimit(attribute: AttributedCharacterIterator.Attribute!): Int

Returns the index of the first character following the run with respect to the given attribute containing the current character.

Parameters
attribute	AttributedCharacterIterator.Attribute!: the desired attribute

Return
Int	the index of the first character following the run

getRunLimit

Added in API level 1

abstract fun getRunLimit(attributes: MutableSet<out AttributedCharacterIterator.Attribute!>!): Int

Returns the index of the first character following the run with respect to the given attributes containing the current character.

Parameters
attributes	MutableSet<out AttributedCharacterIterator.Attribute!>!: a set of the desired attributes

Return
Int	the index of the first character following the run

getRunStart

Added in API level 1

abstract fun getRunStart(): Int

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.

Return
Int	the index of the first character of the run

getRunStart

Added in API level 1

abstract fun getRunStart(attribute: AttributedCharacterIterator.Attribute!): Int

Returns the index of the first character of the run with respect to the given attribute containing the current character.

Parameters
attribute	AttributedCharacterIterator.Attribute!: the desired attribute.

Return
Int	the index of the first character of the run

getRunStart

Added in API level 1

abstract fun getRunStart(attributes: MutableSet<out AttributedCharacterIterator.Attribute!>!): Int

Returns the index of the first character of the run with respect to the given attributes containing the current character.

Parameters
attributes	MutableSet<out AttributedCharacterIterator.Attribute!>!: a set of the desired attributes.

Return
Int	the index of the first character of the run