|  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
 | | |  |  |  | 
 DOMNodeIterator Class ReferenceDOMNodeIteratorsare used to step through a set of nodes, e.g.  
More...
List of all members. 
|  |  | 
 Public Member Functions |  |  |  | virtual | ~DOMNodeIterator () |  |  | Destructor. 
 |  |  |  | virtual DOMNode * | getRoot ()=0 |  |  | The rootnode of theDOMNodeIterator, as specified when it was created.
 |  | virtual unsigned long | getWhatToShow ()=0 |  |  | Return which node types are presented via the iterator. 
 |  | virtual DOMNodeFilter * | getFilter ()=0 |  |  | The DOMNodeFilterused to screen nodes.
 |  | virtual bool | getExpandEntityReferences ()=0 |  |  | Return the expandEntityReferences flag. 
 |  | virtual DOMNode * | nextNode ()=0 |  |  | Returns the next node in the set and advances the position of the DOMNodeIteratorin the set.
 |  | virtual DOMNode * | previousNode ()=0 |  |  | Returns the previous node in the set and moves the position of the DOMNodeIteratorbackwards in the set.
 |  | virtual void | detach ()=0 |  |  | Detaches the DOMNodeIteratorfrom the set which it iterated over, releasing any computational resources and placing theDOMNodeIteratorin the INVALID state.
 |  |  |  | virtual void | release ()=0 |  |  | Called to indicate that this NodeIterator is no longer in use and that the implementation may relinquish any resources associated with it. 
 |  | 
 Protected Member Functions |  |  |  |  | DOMNodeIterator () |  |  | DOMNodeIterator (const DOMNodeIterator &) |  
 Detailed DescriptionDOMNodeIteratorsare used to step through a set of nodes, e.g.
the set of nodes in a DOMNodeList, the document subtree governed by a particularDOMNode, the results of a query, or any other set of nodes. The set of nodes to be iterated is determined by the implementation of theDOMNodeIterator. DOM Level 2 specifies a singleDOMNodeIteratorimplementation for document-order traversal of a document subtree. Instances of theseDOMNodeIteratorsare created by callingDOMDocumentTraversal.createNodeIterator(). 
See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.  Since:DOM Level 2 
 
 
 Constructor & Destructor Documentation
 
  
    | 
        
          | DOMNodeIterator::DOMNodeIterator | ( |  | ) |  [protected] |  |  
 
 
 Member Function Documentation
 
  
    | 
        
          | virtual void DOMNodeIterator::detach | ( |  | ) |  [pure virtual] |  |  
  
    |  | 
Detaches the DOMNodeIteratorfrom the set which it iterated over, releasing any computational resources and placing theDOMNodeIteratorin the INVALID state. 
After detachhas been invoked, calls tonextNodeorpreviousNodewill raise the exception INVALID_STATE_ERR. Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual bool DOMNodeIterator::getExpandEntityReferences | ( |  | ) |  [pure virtual] |  |  
  
    |  | 
Return the expandEntityReferences flag. 
 
The value of this flag determines whether the children of entity reference nodes are visible to the DOMNodeIterator. If false, these children and their descendants will be rejected. Note that this rejection takes precedence overwhatToShowand the filter. Also note that this is currently the only situation whereDOMNodeIteratorsmay 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
 whatToShowflags to hide the entity reference node and setexpandEntityReferencesto true when creating theDOMNodeIterator. To produce a view of the document that has entity reference nodes but no entity expansion, use thewhatToShowflags to show the entity reference node and setexpandEntityReferencesto false. 
 Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual DOMNodeFilter* DOMNodeIterator::getFilter | ( |  | ) |  [pure virtual] |  |  
 
  
    | 
        
          | virtual DOMNode* DOMNodeIterator::getRoot | ( |  | ) |  [pure virtual] |  |  
  
    |  | 
The rootnode of theDOMNodeIterator, as specified when it was created. 
 Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual unsigned long DOMNodeIterator::getWhatToShow | ( |  | ) |  [pure virtual] |  |  
  
    |  | 
Return which node types are presented via the iterator. 
 
This attribute determines which node types are presented via the DOMNodeIterator. The available set of constants is defined in theDOMNodeFilterinterface. Nodes not accepted bywhatToShowwill be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any. Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNodeIterator::nextNode | ( |  | ) |  [pure virtual] |  |  
  
    |  | 
Returns the next node in the set and advances the position of the DOMNodeIteratorin the set. 
After a DOMNodeIteratoris created, the first call tonextNode()returns the first node in the set. Returns:The next DOMNodein the set being iterated over, ornullif there are no more members in that set.
 Exceptions:
  
    |  | DOMException | INVALID_STATE_ERR: Raised if this method is called after the detachmethod was invoked. | 
 Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual DOMNode* DOMNodeIterator::previousNode | ( |  | ) |  [pure virtual] |  |  
  
    |  | 
Returns the previous node in the set and moves the position of the DOMNodeIteratorbackwards in the set. 
 Returns:The previous DOMNodein the set being iterated over, ornullif there are no more members in that set.
 Exceptions:
  
    |  | DOMException | INVALID_STATE_ERR: Raised if this method is called after the detachmethod was invoked. | 
 Since:DOM Level 2 
 |  
 
  
    | 
        
          | virtual void DOMNodeIterator::release | ( |  | ) |  [pure virtual] |  |  
  
    |  | 
Called to indicate that this NodeIterator is no longer in use and that the implementation may relinquish any resources associated with it. 
 
(release() will call detach() where appropriate) 
Access to a released object will lead to unexpected result.      |  The documentation for this class was generated from the following file:
 | 
 
 | 
 |