1.9.9.2
Prysm
NodeIterator Interface Reference

The NodeIterator interface represents an iterator over the members of a list of the nodes in a subtree of the DOM. The nodes will be returned in document order. More...

Public Member Functions

Node nextNode ()
 
Node previousNode ()
 

Public Attributes

readonly attribute Node root
 Returns a Node representing the root node as specified when the NodeIterator was created. More...
 
readonly attribute Node referenceNode
 Returns the Node to which the iterator is anchored. More...
 
readonly attribute boolean pointerBeforeReferenceNode
 Returns a Boolean flag that indicates whether the NodeIterator is anchored before, the flag being true, or after, the flag being false, the anchor node. More...
 
readonly attribute unsigned long whatToShow
 Returns an unsigned long being a bitmask made of constants describing the types of Node that must to be presented. More...
 
readonly attribute NodeFilter filter
 Returns a NodeFilter used to select the relevant nodes. More...
 

Detailed Description

The NodeIterator interface represents an iterator over the members of a list of the nodes in a subtree of the DOM. The nodes will be returned in document order.

Member Function Documentation

◆ nextNode()

Node NodeIterator::nextNode ( )
Returns
the next Node in the document, or null if there are none.

◆ previousNode()

Node NodeIterator::previousNode ( )
Returns
the previous Node in the document, or null if there are none.

Member Data Documentation

◆ filter

readonly attribute NodeFilter NodeIterator::filter

Returns a NodeFilter used to select the relevant nodes.

◆ pointerBeforeReferenceNode

readonly attribute boolean NodeIterator::pointerBeforeReferenceNode

Returns a Boolean flag that indicates whether the NodeIterator is anchored before, the flag being true, or after, the flag being false, the anchor node.

◆ referenceNode

readonly attribute Node NodeIterator::referenceNode

Returns the Node to which the iterator is anchored.

◆ root

readonly attribute Node NodeIterator::root

Returns a Node representing the root node as specified when the NodeIterator was created.

◆ whatToShow

readonly attribute unsigned long NodeIterator::whatToShow

Returns an unsigned long being a bitmask made of constants describing the types of Node that must to be presented.