-
- All Superinterfaces:
- CharacterIterator, Cloneable
public interface AttributedCharacterIterator extends CharacterIterator
AnAttributedCharacterIterator
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.
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.Attribute
and 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 class
AttributedCharacterIterator.Attribute
Defines 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.Object
getAttribute(AttributedCharacterIterator.Attribute attribute)
Returns the value of the namedattribute
for the current character.Map<AttributedCharacterIterator.Attribute,Object>
getAttributes()
Returns a map with the attributes defined on the current character.int
getRunLimit()
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 givenattribute
containing the current character.int
getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)
Returns the index of the first character following the run with respect to the givenattributes
containing the current character.int
getRunStart()
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 givenattribute
containing the current character.int
getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)
Returns the index of the first character of the run with respect to the givenattributes
containing 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 givenattribute
containing 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 givenattributes
containing 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 givenattribute
containing 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 givenattributes
containing 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 namedattribute
for the current character. Returnsnull
if theattribute
is 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.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/text/AttributedCharacterIterator.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.