• index
• goog
• dom
• iter
• search: Go

The goog.dom.iter.AncestorIterator Class

goog.dom.iter.AncestorIterator
> goog.iter.Iterator

goog.dom.iter.AncestorIterator(node, opt_includeNode)

Iterator over a Node's ancestors, stopping after the document body.

node {Node}

The node to start with.

opt_includeNode {boolean=}

Whether to return the given node as the first return value from next.

.__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.

.next()

Returns the next value of the iteration. This will throw the object {@see goog.iter#StopIteration} when the iteration passes the end.

returns {*}

Any object or value.

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