| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
getRunLimit(AttributedCharacterIterator.Attribute attribute) 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 |
getRunStart(AttributedCharacterIterator.Attribute attribute) 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 |
---|
public Set getAllAttributeKeys()
public Object getAttribute(AttributedCharacterIterator.Attribute attribute)
attribute
- the key of the attribute whose value is requested.public Map getAttributes()
public int getRunLimit()
public int getRunLimit(AttributedCharacterIterator.Attribute attribute)
attribute
public int getRunLimit(Set attributes)
attributes
public int getRunStart()
public int getRunStart(AttributedCharacterIterator.Attribute attribute)
attribute
public int getRunStart(Set attributes)
attributes
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |