dom.TextRangeIterator Extends goog.dom.RangeIterator
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.

Inheritance

Object
     goog.iter.Iterator
          goog.dom.TagIterator
               goog.dom.RangeIterator
                    goog.dom.TextRangeIterator

Constructor

goog.dom.TextRangeIterator(startNode, startOffset, endNode, endOffset, opt_reverse)

Parameters

startNode :
Node
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
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.

Instance Methods

Public Protected Private
Defined in goog.dom.TextRangeIterator
clone() ⇒
goog.dom.TextRangeIterator
No description.
Returns: 
goog.dom.TextRangeIterator
  An identical iterator.
code »
copyFrom(other)
Replace this iterator's values with values from another.
Arguments:
other :
goog.dom.TextRangeIterator
The iterator to copy.
code »
getEndNode()
No description.
code »
getEndTextOffset()
No description.
code »
getStartNode()
No description.
code »
getStartTextOffset()
No description.
code »
isLast()
No description.
code »
next() ⇒
Node
Move to the next position in the selection. Throws {@code goog.iter.StopIteration} when it passes the end of the range.
Returns: 
Node
  The node at the next position.
code »
setEndNode(node)
Change the end node of the iterator.
Arguments:
node :
Node
The new end node.
code »
setStartNode(node)
Change the start node of the iterator.
Arguments:
node :
Node
The new start node.
code »
Defined in goog.dom.RangeIterator
getEndNode() ⇒
Node
No description.
Returns: 
Node
  The iterator's end node.
code »
getEndTextOffset() ⇒
number
No description.
Returns: 
number
  The end offset into the current node, or -1 if the current node is not a text node.
code »
getStartNode() ⇒
Node
No description.
Returns: 
Node
  node The iterator's start node.
code »
getStartTextOffset() ⇒
number
No description.
Returns: 
number
  The offset into the current node, or -1 if the current node is not a text node.
code »
isLast() ⇒
boolean
No description.
Returns: 
boolean
  Whether a call to next will fail.
code »
Defined in goog.dom.TagIterator
clone() ⇒
goog.dom.TagIterator
No description.
Returns: 
goog.dom.TagIterator
  A copy of this iterator.
code »
copyFrom(other)
Replace this iterator's values with values from another.
Arguments:
other :
goog.dom.TagIterator
The iterator to copy.
code »
equals(other) ⇒
boolean
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:
other :
goog.dom.TagIterator
The iterator to compare to.
Returns: 
boolean
  Whether the two iterators are at the same position.
code »
isEndTag() ⇒
boolean
No description.
Returns: 
boolean
  Whether this iterator's position is an end tag position.
code »
isNonElement() ⇒
boolean
No description.
Returns: 
boolean
  Whether this iterator's position is not at an element node.
code »
isStartTag() ⇒
boolean
No description.
Returns: 
boolean
  Whether this iterator's position is a start tag position.
code »
isStarted() ⇒
boolean
No description.
Returns: 
boolean
  Whether next has ever been called on this iterator.
code »
next() ⇒
Node
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 »
restartTag()
No description.
code »
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.
Arguments:
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.
code »
skipTag()
No description.
code »
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.
Arguments:
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.
code »
Defined in goog.iter.Iterator
__iterator__(opt_keys) ⇒
!goog.iter.Iterator
Returns the {@code 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
  The object itself.
code »
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.
code »

Instance Properties

Defined in goog.dom.TextRangeIterator
endNode_ :
?Node
The last node in the selection.
Code »
endOffset_ :
number
The offset within the last node in the selection.
Code »
startNode_ :
?Node
The first node in the selection.
Code »
startOffset_ :
number
The offset within the first node in the selection.
Code »
Defined in goog.dom.TagIterator
node :
?Node
The node this position is located on.
Code »
started_ :
boolean
Whether iteration has started.
Code »

Package dom

Package Reference