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

createNodeIterator (method )

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

Member of these other interfaces:  
none

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

Parameters:  
Node root  -  The node which will be iterated together with its children. The iterator 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.
unsigned whatToShow  -  This flag specifies which node types may appear in the logical view of the tree presented by the iterator. 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 NodeIterator, or null to indicate no filter.
Boolean entityReferenceExpansion  -  The value of this flag determines whether entity reference nodes are expanded.

Returns:  
NodeIterator -  The newly created NodeIterator.

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