public interface: NodeIterator
are used to step through a set of nodes, e.g.
the set of nodes in a
, the document subtree
governed by a particular
, the results of a query, or
any other set of nodes. The set of nodes to be iterated is determined by
the implementation of the
. DOM Level 2
specifies a single
document-order traversal of a document subtree. Instances of these
are created by calling
See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.
|Method from org.w3c.dom.traversal.NodeIterator Detail:|
public void detach()
NodeIterator from the set which it iterated
over, releasing any computational resources and placing the
NodeIterator in the INVALID state. After
detach has been invoked, calls to
previousNode will raise the exception
public boolean getExpandEntityReferences()
The value of this flag determines whether the children of entity
reference nodes are visible to the
false, these children and their descendants will be rejected. Note
that this rejection takes precedence over
the filter. Also note that this is currently the only situation where
NodeIterators may reject a complete subtree rather than
skipping individual nodes.
To produce a view of the document that has entity references
expanded and does not expose the entity reference node itself, use
whatToShow flags to hide the entity reference node
expandEntityReferences to true when creating the
NodeIterator. To produce a view of the document that has
entity reference nodes but no entity expansion, use the
whatToShow flags to show the entity reference node and
expandEntityReferences to false.
public NodeFilter getFilter()
NodeFilter used to screen nodes.
public Node getRoot()
The root node of the
NodeIterator, as specified when it
public int getWhatToShow()
This attribute determines which node types are presented via the
NodeIterator. The available set of constants is defined
NodeFilter interface. Nodes not accepted by
whatToShow will be skipped, but their children may still
be considered. Note that this skip takes precedence over the filter,
public Node nextNode() throws DOMException
Returns the next node in the set and advances the position of the
NodeIterator in the set. After a
NodeIterator is created, the first call to
nextNode() returns the first node in the set.
public Node previousNode() throws DOMException
Returns the previous node in the set and moves the position of the
NodeIterator backwards in the set.