class NodeIterator

# class NodeIterator | NodeIterators are used to step through a set of nodes, e. More...
Full name | `DOM::NodeIterator`
Definition | `#include <dom2_traversal.h>`
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- NodeIterator ()
- NodeIterator (const NodeIterator &other)
- NodeIterator & operator = (const NodeIterator &other)
- ~NodeIterator ()
- Node root ()
- unsigned long whatToShow ()
- NodeFilter filter ()
- bool expandEntityReferences ()
- Node nextNode ()
- Node previousNode ()
- void detach ()
- NodeIteratorImpl * handle () const
- bool isNull () const

#### Protected Methods

- NodeIterator (NodeIteratorImpl *i)

#### Protected Members

- NodeIteratorImpl *impl

## Detailed Description

NodeIterators are used to step through a set of nodes, e.g. the set of nodes in a NodeList, the document subtree governed by a particular node, the results of a query, or any other set of nodes. The set of nodes to be iterated is determined by the implementation of the NodeIterator. DOM Level 2 specifies a single NodeIterator implementation for document-order traversal of a document subtree. Instances of these iterators are created by calling DocumentTraversal.createNodeIterator().

Any Iterator that returns nodes may implement the `NodeIterator` interface. Users and vendor libraries may also choose to create Iterators that implement the `NodeIterator` interface.

NodeIterator () | ### NodeIterator

NodeIterator (const NodeIterator &other) | ### NodeIterator

NodeIterator & operator = (const NodeIterator &other) | ### operator =

~NodeIterator () | ### ~NodeIterator

Node root () | ### root

The root node of the NodeIterator, as specified when it was created.

unsigned long whatToShow () | ### whatToShow

This attribute determines which node types are presented via the iterator. The available set of constants is defined in the NodeFilter interface. Nodes not accepted by whatToShow will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any.

NodeFilter filter () | ### filter

The NodeFilter used to screen nodes.

bool expandEntityReferences () | ### expandEntityReferences

The value of this flag determines whether the children of entity reference nodes are visible to the iterator. If false, they and their descendents will be rejected. Note that this rejection takes precedence over whatToShow and the filter. Also note that this is currently the only situation where NodeIterators may reject a complete subtree rather than skipping individual nodes.

To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set expandEntityReferences to true when creating the iterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the whatToShow flags to show the entity reference node and set expandEntityReferences to false.

Node nextNode () | ### nextNode

Returns the next node in the set and advances the position of the Iterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.

Returns: The next `Node` in the set being iterated over, or `null` if there are no more members in that set.

Throws: Exceptions, from, user, code, Any, exceptions, raised, by, a, user-written, Filter, will, propagate, through.

Node previousNode () | ### previousNode

Returns the previous node in the set and moves the position of the Iterator backwards in the set.

Returns: The previous `Node` in the set being iterated over, or `null` if there are no more members in that set.

Throws: Exceptions, from, user, code, Any, exceptions, raised, by, a, user-written, Filter, will, propagate, through.

void detach () | ### detach

Detaches the NodeIterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. After detach has been invoked, calls to nextNode or previousNode will raise the exception INVALID_STATE_ERR.

NodeIteratorImpl * handle () | ### handle

[const]

not part of the DOM

bool isNull () | ### isNull

[const]

NodeIteratorImpl * impl | ### impl

[protected]

NodeIterator (NodeIteratorImpl *i) | ### NodeIterator

[protected]

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:37:43 2003, using kdoc 2.0a54.