DocumentTraversal Interface

Table 2-12 summarizes the methods available through DocumentTraversal interface.

Table 2-12 Summary of DocumentTraversal Methods; Dom Package

Function Summary

DocumentTraversal()

Constructor.

createNodeIterator()

Create new NodeIterator object.

createTreeWalker()

Create new TreeWalker object.

destroyNodeIterator()

Destroys NodeIterator object.

destroyTreeWalker()

Destroys TreeWalker object.

~DocumentTraversal()

Default destructor.



DocumentTraversal()

Constructs the factory.

Syntax

DocumentTraversal();

Returns

(DocumentTraversal) new factory object


createNodeIterator()

Create new iterator object.

Syntax

NodeIterator< Node>* createNodeIterator(
   NodeRef< Node>& root,
   WhatToShowCode whatToShow,
   boolean entityReferenceExpansion)
throw (DOMException);
Parameter Description
root
root of subtree, for iteration
whatToShow
node types filter
entityReferenceExpansion
if TRUE, expand entity references

Returns

(NodeIterator*) Pointer to new iterator


createTreeWalker()

Create new TreeWalker object.

Syntax

TreeWalker< Node>* createTreeWalker(
   NodeRef< Node>& root,
   WhatToShowCode whatToShow,
   boolean entityReferenceExpansion)
throw (DOMException);
Parameter Description
root
root of subtree, for traversal
whatToShow
node types filter
entityReferenceExpansion
if TRUE, expand entity references

Returns

(TreeWalker*) Pointer to new tree walker


destroyNodeIterator()

Destroys node iterator object.

Syntax

void destroyNodeIterator(
   NodeIterator< Node>* iter)
throw (DOMException);
Parameter Description
iter
iterator


destroyTreeWalker()

Destroys TreeWalker object.

Syntax

void destroyTreeWalker(
   TreeWalker< Node>* walker)
throw (DOMException);
Parameter Description
walker
TreeWalker


~DocumentTraversal()

Default destructor.

Syntax

~DocumentTraversal();