The goog.dom.NodeIterator Class

goog.dom.NodeIterator
> goog.dom.TagIterator
> goog.iter.Iterator

goog.dom.NodeIterator(opt_node, opt_reversed, opt_unconstrained, opt_depth)

A DOM tree traversal iterator. Starting with the given node, the iterator walks the DOM in order, reporting events for each node. The iterator acts as a prefix iterator: 

 <div>1<span>2</span>3</div>
Will return the following nodes: [div, 1, span, 2, 3] With the following depths [1, 1, 2, 2, 1] Imagining | represents iterator position, the traversal stops at each of the following locations: 
<div>|1|<span>|2|</span>3|</div>
The iterator can also be used in reverse mode, which will return the nodes and states in the opposite order. The depths will be slightly different since, like in normal mode, the depth is computed *after* the last move. Lastly, it is possible to create an iterator that is unconstrained, meaning that it will continue iterating until the end of the document instead of until exiting the start node.
opt_node {Node=}
The start node. Defaults to an empty iterator.
opt_reversed {boolean=}
Whether to traverse the tree in reverse.
opt_unconstrained {boolean=}
Whether the iterator is not constrained to the starting node and its children.
opt_depth {number=}
The starting tree depth.

.__iterator__(opt_keys)

Inherited from goog.iter.Iterator .

Returns the {@code Iterator} object itself. This is used to implement the iterator protocol in JavaScript 1.7

opt_keys {boolean=}
Whether to return the keys or values. Default is to only return the values. This is being used by the for-in loop (true) and the for-each-in loop (false). Even though the param gives a hint about what the iterator will return there is no guarantee that it will return the keys when true is passed.
returns {!goog.iter.Iterator}
The object itself.

.clone()

Inherited from goog.dom.TagIterator .

returns {goog.dom.TagIterator}
A copy of this iterator.

.constrained {boolean}

Inherited from goog.dom.TagIterator .

Whether the iterator is constrained to the starting node and its children.

.depth {number}

Inherited from goog.dom.TagIterator .

The tree depth of this position relative to where the iterator started. The depth is considered to be the tree depth just past the current node, so if an iterator is at position 

    
|
(i.e. the node is the div and the type is START_TAG) its depth will be 1.

.equals(other)

Inherited from goog.dom.TagIterator .

Test if two iterators are at the same position - i.e. if the node and tagType is the same. This will still return true if the two iterators are moving in opposite directions or have different constraints.

other {goog.dom.TagIterator}
The iterator to compare to.
returns {boolean}
Whether the two iterators are at the same position.

.isEndTag()

Inherited from goog.dom.TagIterator .

returns {boolean}
Whether this iterator's position is an end tag position.

.isNonElement()

Inherited from goog.dom.TagIterator .

returns {boolean}
Whether this iterator's position is not at an element node.

.isStartTag()

Inherited from goog.dom.TagIterator .

returns {boolean}
Whether this iterator's position is a start tag position.

.next()

Moves to the next position in the DOM tree.

returns {Node}
Returns the next node, or throws a goog.iter.StopIteration exception if the end of the iterator's range has been reached.

.node {Node}

Inherited from goog.dom.TagIterator .

The node this position is located on.

.restartTag()

Inherited from goog.dom.TagIterator .

Restart the current tag.

.reversed {boolean}

Inherited from goog.dom.TagIterator .

Whether the node iterator is moving in reverse.

.setPosition(node, opt_tagType, opt_depth)

Inherited from goog.dom.TagIterator .

Set the position of the iterator. Overwrite the tree node and the position type which can be one of the {@link goog.dom.TagWalkType} token types. Only overwrites the tree depth when the parameter is specified.

node {Node}
The node to set the position to.
opt_tagType {goog.dom.TagWalkType?=}
The type of the position Defaults to the start of the given node.
opt_depth {number=}
The tree depth.

.skipTag()

Inherited from goog.dom.TagIterator .

Skip the current tag.

.splice(var_args)

Inherited from goog.dom.TagIterator .

Replace the current node with the list of nodes. Reset the iterator so that it visits the first of the nodes next.

var_args {...Object}
A list of nodes to replace the current node with. If the first argument is array-like, it will be used, otherwise all the arguments are assumed to be nodes.

.tagType {goog.dom.TagWalkType}

Inherited from goog.dom.TagIterator .

The type of this position.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.