This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.text
interface AttributedCharacterIterator

All Superinterfaces:
CharacterIterator, Cloneable

Most common way to construct:

AttributedString attributeString = …;

AttributedCharacterIterator paragraph = attributeString.getIterator();

Based on 48 examples


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:

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.


Nested Class Summary
static class

           Defines attribute keys that are used to identify text attributes.
 
Field Summary
 
Fields inherited from class java.text.CharacterIterator
DONE
 
Method Summary
 Set

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

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

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

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

          Returns the index of the first character following the run with respect to the given attribute containing the current character.
 int
getRunLimit(Set attributes)

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

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

          Returns the index of the first character of the run with respect to the given attribute containing the current character.
 int
getRunStart(Set attributes)

          Returns the index of the first character of the run with respect to the given attributes containing the current character.
 
Methods inherited from class java.text.CharacterIterator
clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex
 

Method Detail

getAllAttributeKeys

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


getAttribute

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

getAttributes

public Map getAttributes()
Returns a map with the attributes defined on the current character.


getRunLimit

public int getRunLimit()
Returns the index of the first character following the run with respect to all attributes containing the current character.


getRunLimit

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.

Parameters:
attribute

getRunLimit

public int getRunLimit(Set attributes)
Returns the index of the first character following the run with respect to the given attributes containing the current character.

Parameters:
attributes

getRunStart

public int getRunStart()
Returns the index of the first character of the run with respect to all attributes containing the current character.


getRunStart

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.

Parameters:
attribute

getRunStart

public int getRunStart(Set attributes)
Returns the index of the first character of the run with respect to the given attributes containing the current character.

Parameters:
attributes


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.