java.lang.Object
javax.swing.text.html.HTMLDocument.Iterator
- Enclosing class:
- HTMLDocument
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 -
Method Summary
Modifier and TypeMethodDescriptionabstract AttributeSetReturn the attributes for this tag.abstract intReturns the end of the range for which the current occurrence of the tag is defined and has the same attributes.abstract intReturns 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.
-
Constructor Details
-
Iterator
protected Iterator()Constructor for subclasses to call.
-
-
Method Details
-
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
Type of tag this iterator represents.- Returns:
- the tag
-