This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.text.html
class HTMLDocument.Iterator

java.lang.Object extended by 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

          
 
Method Summary
abstract 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

          Type of tag this iterator represents.
abstract boolean

          Indicates if the iterator is currently representing an occurrence of a tag.
abstract void

          Move the iterator forward to the next occurrence of the tag it represents.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HTMLDocument.Iterator

public HTMLDocument.Iterator()
Method Detail

getAttributes

public abstract AttributeSet getAttributes()
Return the attributes for this tag.

Returns:
the AttributeSet for this tag, or null if none can 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

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

getTag

public abstract HTML.Tag getTag()
Type of tag this iterator 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

next

public abstract void next()
Move the iterator forward to the next occurrence of the tag it represents.



This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.