Interface 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:
- 9, DOM Level 2
-
Method Summary
Modifier 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
-
createNodeIterator
NodeIterator 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. TheNodeIteratoris initially positioned just before this node. ThewhatToShowflags and the filter, if any, are not considered when setting this position. The root must not benull.whatToShow- This flag specifies which node types may appear in the logical view of the tree presented by theNodeIterator. See the description ofNodeFilterfor the set of possibleSHOW_values.These flags can be combined usingOR.filter- TheNodeFilterto be used with thisNodeIterator, ornullto 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 specifiedrootisnull.
-
createTreeWalker
TreeWalker 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 therootfor theTreeWalker. ThewhatToShowflags and theNodeFilterare not considered when setting this value; any node type will be accepted as theroot. ThecurrentNodeof theTreeWalkeris initialized to this node, whether or not it is visible. Therootfunctions as a stopping point for traversal methods that look upward in the document structure, such asparentNodeand nextNode. Therootmust not benull.whatToShow- This flag specifies which node types may appear in the logical view of the tree presented by theTreeWalker. See the description ofNodeFilterfor the set of possibleSHOW_values.These flags can be combined usingOR.filter- TheNodeFilterto be used with thisTreeWalker, ornullto indicate no filter.entityReferenceExpansion- If this flag is false, the contents ofEntityReferencenodes are not presented in the logical view.- Returns:
- The newly created
TreeWalker. - Throws:
DOMException- NOT_SUPPORTED_ERR: Raised if the specifiedrootisnull.
-