Summary: Nested Classes | Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

AttributedCharacterIterator

implements CharacterIterator

java.text.AttributedCharacterIterator

Class Overview

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.

Summary

Nested Classes
class	AttributedCharacterIterator.Attribute	Defines attribute keys that are used to identify text attributes.

[Expand]

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.Attribute, Object>	getAttributes() Returns a map with the attributes defined on 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	getRunLimit() Returns the index of the first character following the run with respect to all 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(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.

[Expand]

Inherited Methods

From interface java.text.CharacterIterator

abstract Object	clone() Create a copy of this iterator
abstract char	current() Gets the character at the current position (as returned by getIndex()).
abstract char	first() Sets the position to getBeginIndex() and returns the character at that position.
abstract int	getBeginIndex() Returns the start index of the text.
abstract int	getEndIndex() Returns the end index of the text.
abstract int	getIndex() Returns the current index.
abstract char	last() Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
abstract char	next() Increments the iterator's index by one and returns the character at the new index.
abstract char	previous() Decrements the iterator's index by one and returns the character at the new index.
abstract char	setIndex(int position) Sets the position to the specified position in the text and returns that character.

Public Methods

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

public abstract 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	the key of the attribute whose value is requested.

public abstract Map<AttributedCharacterIterator.Attribute, Object> getAttributes ()

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

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

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

public abstract int getRunLimit ()

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

public abstract int getRunStart ()

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

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

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

Interfaces

Classes

Enums

Exceptions