dom.iter.SiblingIterator Extends goog.iter.Iterator
Iterator over a Node's siblings.

Inheritance

Constructor

goog.dom.iter.SiblingIterator(nodeopt_includeNodeopt_reverse)

Parameters

node : Node
The node to start with.
opt_includeNode : boolean=
Whether to return the given node as the first return value from next.
opt_reverse : boolean=
Whether to traverse siblings in reverse document order.

Instance Methods

Public Protected Private
next()
No description.
code »
__iterator__(opt_keys) !goog.iter.Iterator.<VALUE>
Returns the Iterator object itself. This is used to implement the iterator protocol in JavaScript 1.7
Arguments:
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.<VALUE>  The object itself.
code »
next() VALUE
Returns the next value of the iteration. This will throw the object when the iteration passes the end.
Returns: VALUE  Any object or value.
code »

Instance Properties

constructor :
No description.
Code »
node_ :
The current node, or null if iteration is finished.
Code »
reverse_ :
Whether to iterate in reverse.
Code »

Static Properties

goog.dom.iter.SiblingIterator.superClass_ :
No description.
Code »

Package dom.iter

Package Reference