- 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 HTMLDocument.Iterator()
-
Method Summary
Methods Modifier and Type Method and Description abstract AttributeSet
getAttributes()
Return the attributes for this tag.abstract int
getEndOffset()
Returns the end of the range for which the current occurrence of the tag is defined and has the same attributes.abstract int
getStartOffset()
Returns the start of the range for which the current occurrence of the tag is defined and has the same attributes.abstract HTML.Tag
getTag()
Type of tag this iterator represents.abstract boolean
isValid()
Indicates if the iterator is currently representing an occurrence of a tag.abstract void
next()
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
AttributeSet
for this tag, ornull
if 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.
-
-
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-javax/swing/text/html/htmldocument.iterator.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.