goog.dom.TextRangeIterator

Provided By	`goog.dom.TextRangeIterator`
Extends	`goog.dom.RangeIterator` `goog.dom.TagIterator` `goog.iter.Iterator<(Node\|null)>`
All Implemented Interfaces	`Iterator<(Node\|null), ?, ?>`

Subclass of goog.dom.TagIterator that iterates over a DOM range. It adds functions to determine the portion of each text node that is selected.

new TextRangeIterator( `startNode`, `startOffset`, `endNode`, `endOffset`, `opt_reverse` )

Parameters

`startNode`	`(Node\|null)`
	The starting node position.
`startOffset`	`number`
	The offset in to startNode. If startNode is an element, indicates an offset in to childNodes. If startNode is a text node, indicates an offset in to nodeValue.
`endNode`	`(Node\|null)`
	The ending node position.
`endOffset`	`number`
	The offset in to endNode. If endNode is an element, indicates an offset in to childNodes. If endNode is a text node, indicates an offset in to nodeValue.
`opt_reverse`	`boolean=`
	Whether to traverse nodes in reverse.

VIEW SOURCE

Instance Methods

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

Defined by

goog.iter.Iterator

Parameters

`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|null)>

The object itself.

VIEW SOURCE

Overrides

goog.dom.TagIterator

Parameters

None.

Returns

goog.dom.TextRangeIterator

An identical iterator.

VIEW SOURCE

Replace this iterator's values with values from another. The two iterators must be of the same type.

Overrides

goog.dom.TagIterator

Parameters

`other`	`(goog.dom.TagIterator\|null)`
	The iterator to copy.

VIEW SOURCE

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.

Defined by

goog.dom.TagIterator

Parameters

`other`	`(goog.dom.TagIterator\|null)`
	The iterator to compare to.

Returns

boolean

Whether the two iterators are at the same position.

VIEW SOURCE

Overrides

goog.dom.RangeIterator

Parameters

None.

Returns

(Node|null)

The iterator's end node.

VIEW SOURCE

Overrides

goog.dom.RangeIterator

Parameters

None.

Returns

number

The end offset into the current node, or -1 if the current node is not a text node.

VIEW SOURCE

Overrides

goog.dom.RangeIterator

Parameters

None.

Returns

(Node|null)

node The iterator's start node.

VIEW SOURCE

Overrides

goog.dom.RangeIterator

Parameters

None.

Returns

number

The offset into the current node, or -1 if the current node is not a text node.

VIEW SOURCE

Defined by

goog.dom.TagIterator

Parameters

None.

Returns

boolean

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

VIEW SOURCE

Overrides

goog.dom.RangeIterator

Parameters

None.

Returns

boolean

Whether a call to next will fail.

VIEW SOURCE

Defined by

goog.dom.TagIterator

Parameters

None.

Returns

boolean

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

VIEW SOURCE

Defined by

goog.dom.TagIterator

Parameters

None.

Returns

boolean

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

VIEW SOURCE

Defined by

goog.dom.TagIterator

Parameters

None.

Returns

boolean

Whether next has ever been called on this iterator.

VIEW SOURCE

Move to the next position in the selection. Returns {done: true} when it passes the end of the range.

Overrides

goog.dom.TagIterator

Specified by

Iterator

Parameters

`opt_value`	`?=`

Returns

IIterableResult<Node>

The node at the next position.

VIEW SOURCE

Restart the current tag.

VIEW SOURCE

Change the end node of the iterator.

Parameters

`node`	`(Node\|null)`
	The new end node.

VIEW SOURCE

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.

Defined by

goog.dom.TagIterator

Parameters

`node`	`(Node\|null)`
	The node to set the position to.
`opt_tagType`	`(goog.dom.TagWalkType\|null)=`
	The type of the position Defaults to the start of the given node.
`opt_depth`	`number=`
	The tree depth.

VIEW SOURCE

Change the start node of the iterator.

Parameters

`node`	`(Node\|null)`
	The new start node.

VIEW SOURCE

Skip the current tag.

Overrides	`goog.dom.TagIterator`
Parameters	None.

VIEW SOURCE

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

Defined by

goog.dom.TagIterator

Parameters

`var_args`	`...(Object\|null)`
	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.

VIEW SOURCE

Instance Properties

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

VIEW SOURCE

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.

VIEW SOURCE

The node this position is located on.

VIEW SOURCE

Whether the node iterator is moving in reverse.

VIEW SOURCE

The type of this position.

VIEW SOURCE

goog.dom.TextRangeIterator

new TextRangeIterator( `startNode`, `startOffset`, `endNode`, `endOffset`, `opt_reverse` )

Instance Methods

`this.`iterator( `opt_keys` ) `→` `goog.iter.Iterator<(VALUE|null)>`

`this.`clone() `→` `goog.dom.TextRangeIterator`

`this.`copyFrom( `other` ) `→` `void`

`this.`equals( `other` ) `→` `boolean`

`this.`getEndNode() `→` `(Node|null)`

`this.`getEndTextOffset() `→` `number`

`this.`getStartNode() `→` `(Node|null)`

`this.`getStartTextOffset() `→` `number`

`this.`isEndTag() `→` `boolean`

`this.`isLast() `→` `boolean`

`this.`isNonElement() `→` `boolean`

`this.`isStartTag() `→` `boolean`

`this.`isStarted() `→` `boolean`

`this.`next( `opt_value` ) `→` `IIterableResult<Node>`

`this.`restartTag() `→` `void`

`this.`setEndNode( `node` ) `→` `void`

`this.`setPosition( `node`, `opt_tagType`, `opt_depth` ) `→` `void`

`this.`setStartNode( `node` ) `→` `void`

`this.`skipTag() `→` `void`

`this.`splice( `...var_args` ) `→` `void`

Instance Properties

`this.`constrained `→` `boolean`

`this.`depth `→` `number`

`this.`node `→` `(Node|null)`

`this.`reversed `→` `boolean`

`this.`tagType `→` `goog.dom.TagWalkType`

goog.dom.TextRangeIterator

new TextRangeIterator( startNode, startOffset, endNode, endOffset, opt_reverse )

Instance Methods

this.__iterator__( opt_keys ) → goog.iter.Iterator<(VALUE|null)>

this.clone() → goog.dom.TextRangeIterator

this.copyFrom( other ) → void

this.equals( other ) → boolean

this.getEndNode() → (Node|null)

this.getEndTextOffset() → number

this.getStartNode() → (Node|null)

this.getStartTextOffset() → number

this.isEndTag() → boolean

this.isLast() → boolean

this.isNonElement() → boolean

this.isStartTag() → boolean

this.isStarted() → boolean

this.next( opt_value ) → IIterableResult<Node>

this.restartTag() → void

this.setEndNode( node ) → void

this.setPosition( node, opt_tagType, opt_depth ) → void

this.setStartNode( node ) → void

this.skipTag() → void

this.splice( ...var_args ) → void

Instance Properties

this.constrained → boolean

this.depth → number

this.node → (Node|null)

this.reversed → boolean

this.tagType → goog.dom.TagWalkType

new TextRangeIterator( `startNode`, `startOffset`, `endNode`, `endOffset`, `opt_reverse` )

`this.`iterator( `opt_keys` ) `→` `goog.iter.Iterator<(VALUE|null)>`

`this.`clone() `→` `goog.dom.TextRangeIterator`

`this.`copyFrom( `other` ) `→` `void`

`this.`equals( `other` ) `→` `boolean`

`this.`getEndNode() `→` `(Node|null)`

`this.`getEndTextOffset() `→` `number`

`this.`getStartNode() `→` `(Node|null)`

`this.`getStartTextOffset() `→` `number`

`this.`isEndTag() `→` `boolean`

`this.`isLast() `→` `boolean`

`this.`isNonElement() `→` `boolean`

`this.`isStartTag() `→` `boolean`

`this.`isStarted() `→` `boolean`

`this.`next( `opt_value` ) `→` `IIterableResult<Node>`

`this.`restartTag() `→` `void`

`this.`setEndNode( `node` ) `→` `void`

`this.`setPosition( `node`, `opt_tagType`, `opt_depth` ) `→` `void`

`this.`setStartNode( `node` ) `→` `void`

`this.`skipTag() `→` `void`

`this.`splice( `...var_args` ) `→` `void`

`this.`constrained `→` `boolean`

`this.`depth `→` `number`

`this.`node `→` `(Node|null)`

`this.`reversed `→` `boolean`

`this.`tagType `→` `goog.dom.TagWalkType`