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
-
Method Summary
Modifier and TypeMethodDescriptionabstract AttributeSet
Return the attributes for this tag.abstract int
Returns the end of the range for which the current occurrence of the tag is defined and has the same attributes.abstract int
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.
-
Constructor Details
-
Iterator
protected Iterator()Constructor for subclasses to call.
-
-
Method Details
-
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
Type of tag this iterator represents.- Returns:
- the tag
-