ZVON > References > DOM2 Reference
Intro / Search / ZVON
    DOM2 reference > TraversalRange: DocumentTraversal > createTreeWalker [Go to standard]         [Glossary]  [Help]   

createTreeWalker (method )

Owning interface and usage:  
DocumentTraversal.createTreeWalker(root, whatToShow, filter, entityReferenceExpansion)

Member of these other interfaces:  
none

Description:  
Create a new TreeWalker over the subtree rooted at the specified node.

Parameters:  
Node 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.
unsigned whatToShow  -  This flag specifies which node types may appear in the logical view of the tree presented by the tree-walker. See the description of NodeFilter for the set of possible SHOW_ values.
These flags can be combined using OR.
NodeFilter filter  -  The NodeFilter to be used with this TreeWalker, or null to indicate no filter.
Boolean entityReferenceExpansion  -  If this flag is false, the contents of EntityReference nodes are not presented in the logical view.

Returns:  
TreeWalker -  The newly created TreeWalker.

Exceptions:  
DOMException NOT_SUPPORTED_ERR
Raised if the specified root is null.