---

IDOM_NodeIterator Class Reference

Inheritance diagram for IDOM_NodeIterator:

List of all members.

Public Methods
Get functions.
virtual IDOM_Node *	getRoot ()=0
virtual unsigned long	getWhatToShow ()=0
virtual IDOM_NodeFilter *	getFilter ()=0
virtual bool	getExpandEntityReferences ()=0
virtual IDOM_Node *	nextNode ()=0
virtual IDOM_Node *	previousNode ()=0
Detaching functions.
virtual void	detach ()=0
Protected Methods
	IDOM_NodeIterator (const IDOM_NodeIterator &other)
IDOM_NodeIterator &	operator= (const IDOM_NodeIterator &other)

---

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().

---

Member Function Documentation

virtual void IDOM_NodeIterator::detach (    )  [pure virtual]

Detaches the iterator 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.

virtual bool IDOM_NodeIterator::getExpandEntityReferences (    )  [pure virtual]

Return the expandEntityReferences flag. The value of this flag determines whether the children of entity reference nodes are visible to the IDOM_NodeFilter. If false, they will be skipped over.

virtual IDOM_NodeFilter* IDOM_NodeIterator::getFilter (    )  [pure virtual]

Return The filter used to screen nodes.

virtual IDOM_Node* IDOM_NodeIterator::getRoot (    )  [pure virtual]

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

virtual unsigned long IDOM_NodeIterator::getWhatToShow (    )  [pure virtual]

Return which node types are presented via the iterator. The available set of constants is defined in the IDOM_NodeFilter interface.

virtual IDOM_Node* IDOM_NodeIterator::nextNode (    )  [pure virtual]

Returns the next node in the set and advances the position of the iterator in the set. After a IDOM_NodeIterator is created, the first call to nextNode() returns the first node in the set. Exceptions: DOMException  INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

virtual IDOM_Node* IDOM_NodeIterator::previousNode (    )  [pure virtual]

Returns the previous node in the set and moves the position of the iterator backwards in the set. Exceptions: DOMException  INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

---

The documentation for this class was generated from the following file:

• IDOM_NodeIterator.hpp

---