<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.
goog.iter.Iterator | |
goog.dom.TagIterator | goog.iter.Iterator |
goog.dom.NodeIterator | goog.dom.TagIterator |
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.
|
No description.
Returns: !goog.dom.TagIterator
A copy of this iterator.
|
code » | ||||
![]()
Replace this iterator's values with values from another. The two iterators
must be of the same type.
Arguments:
|
code » | ||||
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.
Arguments:
Returns: boolean
Whether the two iterators are at the same position.
|
code » | ||||
No description.
Returns: boolean
Whether this iterator's position is an end tag position.
|
code » | ||||
No description.
Returns: boolean
Whether this iterator's position is not at an element node.
|
code » | ||||
No description.
Returns: boolean
Whether this iterator's position is a start tag position.
|
code » | ||||
No description.
Returns: boolean
Whether next has ever been called on this iterator.
|
code » | ||||
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.
|
code » | ||||
![]()
Restart the current tag.
|
code » | ||||
![]()
Set the position of the iterator. Overwrite the tree node and the position
type which can be one of the
goog.dom.TagWalkType token types.
Only overwrites the tree depth when the parameter is specified.
Arguments:
|
code » | ||||
![]()
Skip the current tag.
|
code » | ||||
![]()
Replace the current node with the list of nodes. Reset the iterator so that
it visits the first of the nodes next.
Arguments:
|
code » |
Returns the
Iterator object itself. This is used to implement
the iterator protocol in JavaScript 1.7
Arguments:
|
code » | ||
![]()
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 » |
![]()
No description.
|
Code » |
![]()
Whether the iterator is constrained to the starting node and its children.
|
Code » | |
![]()
No description.
|
Code » | |
![]()
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. |
Code » | |
![]()
The node this position is located on.
|
Code » | |
![]()
Whether the node iterator is moving in reverse.
|
Code » | |
![]()
Whether iteration has started.
|
Code » | |
![]()
The type of this position.
|
Code » |
![]()
No description.
|
Code » |