Home » openjdk-7 » javax » swing » text » [javadoc | source]
public class: ElementIterator [javadoc | source]

All Implemented Interfaces:

ElementIterator, as the name suggests, iteratates over the Element tree. The constructor can be invoked with either Document or an Element as an argument. If the constructor is invoked with a Document as an argument then the root of the iteration is the return value of document.getDefaultRootElement(). The iteration happens in a depth-first manner. In terms of how boundary conditions are handled: a) if next() is called before first() or current(), the root will be returned. b) next() returns null to indicate the end of the list. c) previous() returns null when the current element is the root or next() has returned null. The ElementIterator does no locking of the Element tree. This means that it does not track any changes. It is the responsibility of the user of this class, to ensure that no changes happen during element iteration. Simple usage example: public void iterate() { ElementIterator it = new ElementIterator(root); Element elem; while (true) { if ((elem = next()) != null) { // process element System.out.println("elem: " + elem.getName()); } else { break; } } }

 public ElementIterator(Document document) 
    Creates a new ElementIterator. The root element is taken to get the default root element of the document.
    document - a Document.
 public ElementIterator(Element root) 
    Creates a new ElementIterator.
    root - the root Element.
Method from javax.swing.text.ElementIterator Summary:
clone,   current,   depth,   first,   next,   previous
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.text.ElementIterator Detail:
 public synchronized Object clone() 
    Clones the ElementIterator.
 public Element current() 
    Fetches the current Element.
 public int depth() 
    Fetches the current depth of element tree.
 public Element first() 
    Fetches the first element.
 public Element next() 
    Fetches the next Element. The strategy used to locate the next element is a depth-first search.
 public Element previous() 
    Fetches the previous Element. If howver the current element is the last element, or the current element is null, then null is returned.