javax.swing.text
Class ElementIterator

java.lang.Object
  extended by javax.swing.text.ElementIterator
All Implemented Interfaces:
Cloneable

public class ElementIterator
extends Object
implements Cloneable

This class can be used to iterate over the Element tree of a Document or an Element. This iterator performs an "in-order" traversal -- first it visits a node, then each of the node's children in order. No locking is performed during the iteration; that is up to the caller.


Constructor Summary
ElementIterator(Document document)
          Create a new ElementIterator to iterate over the given document.
ElementIterator(Element root)
          Create a new ElementIterator to iterate over the given document.
 
Method Summary
 Object clone()
          Returns a new ElementIterator which is a clone of this ElementIterator.
 Element current()
          Returns the current element.
 int depth()
          Returns the depth to which we have descended in the tree.
 Element first()
          Returns the first element in the tree.
 Element next()
          Advance the iterator and return the next element of the tree, performing an "in-order" traversal.
 Element previous()
          Returns the previous item.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ElementIterator

public ElementIterator(Document document)
Create a new ElementIterator to iterate over the given document.

Parameters:
document - the Document over which we iterate

ElementIterator

public ElementIterator(Element root)
Create a new ElementIterator to iterate over the given document.

Parameters:
root - the Document over which we iterate
Method Detail

clone

public Object clone()
Returns a new ElementIterator which is a clone of this ElementIterator.

Overrides:
clone in class Object
Returns:
a copy of the Object
See Also:
Cloneable

current

public Element current()
Returns the current element.


depth

public int depth()
Returns the depth to which we have descended in the tree.


first

public Element first()
Returns the first element in the tree.


next

public Element next()
Advance the iterator and return the next element of the tree, performing an "in-order" traversal.


previous

public Element previous()
Returns the previous item. Does not modify the iterator state.