-
- All Superinterfaces:
- CharacterIterator, Cloneable
public interface AttributedCharacterIterator extends CharacterIterator
AnAttributedCharacterIteratorallows 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
nullfor the entire range, or - the attribute value is defined and has the same non-
nullvalue 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()andgetRunLimit()), 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.Attributeand its subclasses, such asTextAttribute.- Since:
- 1.2
- See Also:
AttributedCharacterIterator.Attribute,TextAttribute,AttributedString,Annotation
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static classAttributedCharacterIterator.AttributeDefines attribute keys that are used to identify text attributes.
-
Field Summary
-
Fields inherited from interface java.text.CharacterIterator
DONE
-
-
Method Summary
Methods Modifier and Type Method and Description Set<AttributedCharacterIterator.Attribute>getAllAttributeKeys()Returns the keys of all attributes defined on the iterator's text range.ObjectgetAttribute(AttributedCharacterIterator.Attribute attribute)Returns the value of the namedattributefor the current character.Map<AttributedCharacterIterator.Attribute,Object>getAttributes()Returns a map with the attributes defined on the current character.intgetRunLimit()Returns the index of the first character following the run with respect to all attributes containing the current character.intgetRunLimit(AttributedCharacterIterator.Attribute attribute)Returns the index of the first character following the run with respect to the givenattributecontaining the current character.intgetRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)Returns the index of the first character following the run with respect to the givenattributescontaining the current character.intgetRunStart()Returns the index of the first character of the run with respect to all attributes containing the current character.intgetRunStart(AttributedCharacterIterator.Attribute attribute)Returns the index of the first character of the run with respect to the givenattributecontaining the current character.intgetRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)Returns the index of the first character of the run with respect to the givenattributescontaining the current character.-
Methods inherited from interface java.text.CharacterIterator
clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex
-
-
-
-
Method Detail
-
getRunStart
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.
-
getRunStart
int getRunStart(AttributedCharacterIterator.Attribute attribute)
Returns the index of the first character of the run with respect to the givenattributecontaining the current character.
-
getRunStart
int getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)
Returns the index of the first character of the run with respect to the givenattributescontaining the current character.
-
getRunLimit
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.
-
getRunLimit
int getRunLimit(AttributedCharacterIterator.Attribute attribute)
Returns the index of the first character following the run with respect to the givenattributecontaining the current character.
-
getRunLimit
int getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)
Returns the index of the first character following the run with respect to the givenattributescontaining the current character.
-
getAttributes
Map<AttributedCharacterIterator.Attribute,Object> getAttributes()
Returns a map with the attributes defined on the current character.
-
getAttribute
Object getAttribute(AttributedCharacterIterator.Attribute attribute)
Returns the value of the namedattributefor the current character. Returnsnullif theattributeis not defined.
-
getAllAttributeKeys
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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/text/attributedcharacteriterator.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
