HTMLDocument.Iterator

extends Object

java.lang.Object
↳	javax.swing.text.html.HTMLDocument.Iterator

Class Overview

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.

Summary

Public Constructors
	HTMLDocument.Iterator()

Public Methods
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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public HTMLDocument.Iterator ()

Public Methods

public abstract AttributeSet getAttributes ()

Return the attributes for this tag.

Returns

the AttributeSet for this tag, or null if none can be found

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

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

public abstract HTML.Tag getTag ()

Type of tag this iterator represents.

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

public abstract void next ()

Move the iterator forward to the next occurrence of the tag it represents.

Classes

Enums

HTMLDocument.Iterator

Class Overview

Summary

Public Constructors

public HTMLDocument.Iterator ()

Public Methods

public abstract AttributeSet getAttributes ()

Returns

public abstract int getEndOffset ()

Returns

public abstract int getStartOffset ()

Returns

public abstract HTML.Tag getTag ()

public abstract boolean isValid ()

Returns

public abstract void next ()