#include <TreeWalker.h>
Inheritance diagram for org::w3c::dom::traversal::TreeWalker:
TreeWalker
objects are used to navigate a document tree or subtree using the view of the document defined by their whatToShow
flags and filter (if any).
Any function which performs navigation using a TreeWalker
will automatically support any view defined by a TreeWalker
.
Omitting nodes from the logical view of a subtree can result in a structure that is substantially different from the same subtree in the complete, unfiltered document. Nodes that are siblings in the TreeWalker
view may be children of different, widely separated nodes in the original view. For instance, consider a NodeFilter
that skips all nodes except for Text nodes and the root node of a document. In the logical view that results, all text nodes will be siblings and appear as direct children of the root node, no matter how deeply nested the structure of the original document.
See also the Document acdk::lang::Object Model (DOM) Level 2 Traversal and Range Specification.
Public Member Functions | |
virtual RNode | getRoot ()=0 |
The root node of the TreeWalker , as specified when it was created. | |
virtual int | getWhatToShow ()=0 |
This attribute determines which node types are presented via the TreeWalker . | |
virtual RNodeFilter | getFilter ()=0 |
The filter used to screen nodes. | |
virtual bool | getExpandEntityReferences ()=0 |
The value of this flag determines whether the children of entity reference nodes are visible to the TreeWalker . | |
virtual RNode | getCurrentNode ()=0 |
The node at which the TreeWalker is currently positioned. | |
virtual void | setCurrentNode (IN(RNode) currentNode)=0 throw ( RDOMException ) |
The node at which the TreeWalker is currently positioned. | |
virtual RNode | parentNode ()=0 |
Moves to and returns the closest visible ancestor node of the current node. | |
virtual RNode | firstChild ()=0 |
Moves the TreeWalker to the first visible child of the current node, and returns the new node. | |
virtual RNode | lastChild ()=0 |
Moves the TreeWalker to the last visible child of the current node, and returns the new node. | |
virtual RNode | previousSibling ()=0 |
Moves the TreeWalker to the previous sibling of the current node, and returns the new node. | |
virtual RNode | nextSibling ()=0 |
Moves the TreeWalker to the next sibling of the current node, and returns the new node. | |
virtual RNode | previousNode ()=0 |
Moves the TreeWalker to the previous visible node in document order relative to the current node, and returns the new node. | |
virtual RNode | nextNode ()=0 |
Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node. |
|
Moves the
If the current node has no visible children, returns
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
The node at which the
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
The value of this flag determines whether the children of entity reference nodes are visible to the
If false, these children and their descendants will be rejected. Note that this rejection takes precedence over Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
The filter used to screen nodes.
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
The
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
This attribute determines which node types are presented via the
The available set of constants is defined in the Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
Moves the
If the current node has no visible children, returns
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
Moves the
If the current node has no next node, or if the search for nextNode attempts to step upward from the
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
Moves the
If the current node has no visible next sibling, returns
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
Moves to and returns the closest visible ancestor node of the current node.
If the search for
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
Moves the
If the current node has no previous node, or if the search for
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
Moves the
If the current node has no visible previous sibling, returns
Implemented in acdk::xml::dom::NodeIteratorWalker. |
|
The node at which the
|