• index
• goog
• dom
• search: Go

The goog.dom.TagIterator Class

goog.dom.TagIterator
> goog.iter.Iterator

goog.dom.TagIterator(opt_node, opt_reversed, opt_unconstrained, opt_tagType, opt_depth)

A DOM tree traversal iterator. Starting with the given node, the iterator walks the DOM in order, reporting events for the start and end of Elements, and the presence of text nodes. For example:

 <div>1<span>2</span>3</div>
 

 <div>|1|<span>|2|</span>|3|</div>|
 

opt_node {Node=}

The start node. If unspecified or null, 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_tagType {goog.dom.TagWalkType?=}

The type of the position. Defaults to the start of the given node for forward iterators, and the end of the node for reverse iterators.

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

returns {goog.dom.TagIterator}

A copy of this iterator.

.constrained {boolean}

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

.depth {number}

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

    
|

.equals(other)

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

returns {boolean}

Whether this iterator's position is an end tag position.

.isNonElement()

returns {boolean}

Whether this iterator's position is not at an element node.

.isStartTag()

returns {boolean}

Whether this iterator's position is a start tag position.

.next()

Move 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}

The node this position is located on.

.restartTag()

Restart the current tag.

.reversed {boolean}

Whether the node iterator is moving in reverse.

.setPosition(node, opt_tagType, opt_depth)

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

Skip the current tag.

.splice(var_args)

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}

The type of this position.

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