Skip to content

Most visited

Recently visited

navigation

AttributedCharacterIterator

public interface AttributedCharacterIterator
implements 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 TextAttribute.

See also:

Summary

Nested classes

class AttributedCharacterIterator.Attribute

Defines attribute keys that are used to identify text attributes. 

Inherited constants

From interface java.text.CharacterIterator

Public methods

abstract Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys()

Returns the keys of all attributes defined on the iterator's text range.

abstract Object getAttribute(AttributedCharacterIterator.Attribute attribute)

Returns the value of the named attribute for the current character.

abstract Map<AttributedCharacterIterator.AttributeObject> 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(AttributedCharacterIterator.Attribute attribute)

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

abstract 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.

abstract 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.

abstract 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.

abstract int getRunStart()

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

Inherited methods

From interface java.text.CharacterIterator

Public methods

getAllAttributeKeys

Added in API level 1
Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys ()

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

Returns
Set<AttributedCharacterIterator.Attribute>

getAttribute

Added in API level 1
Object getAttribute (AttributedCharacterIterator.Attribute attribute)

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

Parameters
attribute AttributedCharacterIterator.Attribute
Returns
Object

getAttributes

Added in API level 1
Map<AttributedCharacterIterator.AttributeObject> getAttributes ()

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

Returns
Map<AttributedCharacterIterator.AttributeObject>

getRunLimit

Added in API level 1
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.

Returns
int

getRunLimit

Added in API level 1
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.

Parameters
attribute AttributedCharacterIterator.Attribute
Returns
int

getRunLimit

Added in API level 1
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.

Parameters
attributes Set
Returns
int

getRunStart

Added in API level 1
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.

Parameters
attribute AttributedCharacterIterator.Attribute
Returns
int

getRunStart

Added in API level 1
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.

Parameters
attributes Set
Returns
int

getRunStart

Added in API level 1
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.

Returns
int
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.