-
- 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.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/11/2024 18:34:32 Cette version de la page est en cache (à la date du 21/11/2024 18:34:32) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/text/AttributedCharacterIterator.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.
