javax.swing.text.html
Class HTMLDocument.Iterator
- java.lang.Object
-
- javax.swing.text.html.HTMLDocument.Iterator
-
- Enclosing class:
- HTMLDocument
public abstract static class HTMLDocument.Iterator extends Object
An iterator to iterate over a particular type of tag. The iterator is not thread safe. If reliable access to the document is not already ensured by the context under which the iterator is being used, its use should be performed under the protection of Document.render.
-
-
Constructor Summary
Constructors Constructor and Description Iterator()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description abstract AttributeSetgetAttributes()Return the attributes for this tag.abstract intgetEndOffset()Returns the end of the range for which the current occurrence of the tag is defined and has the same attributes.abstract intgetStartOffset()Returns the start of the range for which the current occurrence of the tag is defined and has the same attributes.abstract HTML.TaggetTag()Type of tag this iterator represents.abstract booleanisValid()Indicates if the iterator is currently representing an occurrence of a tag.abstract voidnext()Move the iterator forward to the next occurrence of the tag it represents.
-
-
-
Method Detail
getAttributes
public abstract AttributeSet getAttributes()
Return the attributes for this tag.- Returns:
-
the
AttributeSetfor this tag, ornullif none can be found
getStartOffset
public abstract int getStartOffset()
Returns the start of the range for which the current occurrence of the tag is defined and has the same attributes.- Returns:
- the start of the range, or -1 if it can't be found
getEndOffset
public abstract int getEndOffset()
Returns the end of the range for which the current occurrence of the tag is defined and has the same attributes.- Returns:
- the end of the range
next
public abstract void next()
Move the iterator forward to the next occurrence of the tag it represents.
isValid
public abstract boolean isValid()
Indicates if the iterator is currently representing an occurrence of a tag. If false there are no more tags for this iterator.- Returns:
- true if the iterator is currently representing an occurrence of a tag, otherwise returns false
getTag
public abstract HTML.Tag getTag()
Type of tag this iterator represents.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
