FileDocCategorySizeDatePackage
DocumentTraversal.javaAPI DocJava SE 5 API4942Fri Aug 26 14:58:42 BST 2005org.w3c.dom.traversal

DocumentTraversal

public interface DocumentTraversal
DocumentTraversal contains methods that create NodeIterators and TreeWalkers to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document). In DOMs which support the Traversal feature, DocumentTraversal will be implemented by the same objects that implement the Document interface.

See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.

since
DOM Level 2

Fields Summary
Constructors Summary
Methods Summary
public org.w3c.dom.traversal.NodeIteratorcreateNodeIterator(org.w3c.dom.Node root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter, boolean entityReferenceExpansion)
Create a new NodeIterator over the subtree rooted at the specified node.

param
root The node which will be iterated together with its children. The NodeIterator is initially positioned just before this node. The whatToShow flags and the filter, if any, are not considered when setting this position. The root must not be null.
param
whatToShow This flag specifies which node types may appear in the logical view of the tree presented by the NodeIterator. See the description of NodeFilter for the set of possible SHOW_ values.These flags can be combined using OR.
param
filter The NodeFilter to be used with this NodeIterator, or null to indicate no filter.
param
entityReferenceExpansion The value of this flag determines whether entity reference nodes are expanded.
return
The newly created NodeIterator.
exception
DOMException NOT_SUPPORTED_ERR: Raised if the specified root is null.

public org.w3c.dom.traversal.TreeWalkercreateTreeWalker(org.w3c.dom.Node root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter, boolean entityReferenceExpansion)
Create a new TreeWalker over the subtree rooted at the
specified node.
param
root The node which will serve as the root for the
TreeWalker. The whatToShow flags and the
NodeFilter are not considered when setting this value;
any node type will be accepted as the root. The
currentNode of the TreeWalker is
initialized to this node, whether or not it is visible. The
root functions as a stopping point for traversal
methods that look upward in the document structure, such as
parentNode and nextNode. The root must
not be null.
param
whatToShow This flag specifies which node types may appear in
the logical view of the tree presented by the
TreeWalker. See the description of
NodeFilter for the set of possible SHOW_
values.These flags can be combined using OR.
param
filter The NodeFilter to be used with this
TreeWalker, or null to indicate no filter.
param
entityReferenceExpansion If this flag is false, the contents of
EntityReference nodes are not presented in the logical
view.
return
The newly created TreeWalker.
exception
DOMException
NOT_SUPPORTED_ERR: Raised if the specified root is
null.