Availability
DOM Level 2 Traversal
Synopsis
TreeWalker createTreeWalker(Node root,
unsigned long whatToShow,
NodeFilter filter,
boolean entityReferenceExpansion)
throws DOMException;
Arguments
root
The root of the subtree over which this TreeWalker is to walk. whatToShow
A bitmask of one or more NodeFilter flags that specify which types of
nodes should be returned by this TreeWalker.
filter
An optional node filter function for the TreeWalker, or
null for no node filter.
entityReferenceExpansion
true if the TreeWalker should expand entity
references in XML documents, or false otherwise.
Returns
A newly created TreeWalker object.
Throws
This method throws a DOMException with a code of
NOT_SUPPORTED_ERR if the
root argument is null.
Description
This method creates and returns a new TreeWalker object to traverse
the subtree rooted at the root node, using
the specified filters.
This method is not actually part of the Document interface but is
instead defined by the DocumentTraversal interface. If an
implementation supports the Traversal module, the Document object
always implements DocumentTraversal and defines this method.
See Also
Document.createNodeIterator( ), NodeFilter, TreeWalker