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:
- 9, DOM Level 2
- 
Method SummaryModifier and TypeMethodDescriptioncreateNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) Create a newNodeIteratorover the subtree rooted at the specified node.createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) Create a newTreeWalkerover the subtree rooted at the specified node.
- 
Method Details- 
createNodeIteratorNodeIterator createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException Create a newNodeIteratorover the subtree rooted at the specified node.- Parameters:
- root- The node which will be iterated together with its children. The- NodeIteratoris initially positioned just before this node. The- whatToShowflags and the filter, if any, are not considered when setting this position. The root must not be- null.
- whatToShow- This flag specifies which node types may appear in the logical view of the tree presented by the- NodeIterator. See the description of- NodeFilterfor the set of possible- SHOW_values.These flags can be combined using- OR.
- filter- The- NodeFilterto be used with this- NodeIterator, or- nullto indicate no filter.
- entityReferenceExpansion- The value of this flag determines whether entity reference nodes are expanded.
- Returns:
- The newly created NodeIterator.
- Throws:
- DOMException- NOT_SUPPORTED_ERR: Raised if the specified- rootis- null.
 
- 
createTreeWalkerTreeWalker createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException Create a newTreeWalkerover the subtree rooted at the specified node.- Parameters:
- root- The node which will serve as the- rootfor the- TreeWalker. The- whatToShowflags and the- NodeFilterare not considered when setting this value; any node type will be accepted as the- root. The- currentNodeof the- TreeWalkeris initialized to this node, whether or not it is visible. The- rootfunctions as a stopping point for traversal methods that look upward in the document structure, such as- parentNodeand nextNode. The- rootmust not be- null.
- whatToShow- This flag specifies which node types may appear in the logical view of the tree presented by the- TreeWalker. See the description of- NodeFilterfor the set of possible- SHOW_values.These flags can be combined using- OR.
- filter- The- NodeFilterto be used with this- TreeWalker, or- nullto indicate no filter.
- entityReferenceExpansion- If this flag is false, the contents of- EntityReferencenodes are not presented in the logical view.
- Returns:
- The newly created TreeWalker.
- Throws:
- DOMException- NOT_SUPPORTED_ERR: Raised if the specified- rootis- null.
 
 
-