dom.AbstractRange Extends Object
Creates a new selection with no properties. Do not use this constructor - use one of the goog.dom.Range.from* methods instead.

Inheritance

Object
     goog.dom.AbstractRange

Constructor

goog.dom.AbstractRange()

Instance Methods

Public Protected Private
Defined in goog.dom.AbstractRange
__iterator__() ⇒
goog.dom.RangeIterator
Returns a RangeIterator over the contents of the range. Regardless of the direction of the range, the iterator will move in document order.
Returns: 
goog.dom.RangeIterator
  An iterator over tags in the range.
code »
clone() ⇒
goog.dom.AbstractRange
No description.
Returns: 
goog.dom.AbstractRange
  A clone of this range.
code »
collapse()
Collapses the range to one of its boundary points.
code »
containsNode(node, opt_allowPartial) ⇒
boolean
Tests if this range contains the given node.
Arguments:
node :
Node
The node to test for.
opt_allowPartial :
boolean
If not set or false, the node must be entirely contained in the selection for this function to return true.
Returns: 
boolean
  Whether this range contains the given node.
code »
containsRange() ⇒
boolean
Tests if this range contains the given range.
Returns: 
boolean
  Whether this range contains the given range.
code »
getAnchorNode() ⇒
Node
No description.
Returns: 
Node
  The element or text node the range is anchored at.
code »
getAnchorOffset() ⇒
number
No description.
Returns: 
number
  The offset into the node the range is anchored at. For text nodes, this is an offset into the node value. For elements, this is an offset into the childNodes array.
code »
getBrowserRangeObject() ⇒
Range | TextRange
No description.
Returns: 
Range | TextRange
  The native browser range object.
code »
getContainer() ⇒
Node
No description.
Returns: 
Node
  The deepest node that contains the entire range.
code »
getContainerElement() ⇒
Element
Returns the deepest element in the tree that contains the entire range.
Returns: 
Element
  The deepest element that contains the entire range.
code »
getDocument() ⇒
Document
No description.
Returns: 
Document
  The document this selection is a part of.
code »
getEndNode() ⇒
Node
No description.
Returns: 
Node
  The element or text node the range ends in.
code »
getEndOffset() ⇒
number
No description.
Returns: 
number
  The offset into the node the range ends in. For text nodes, this is an offset into the node value. For elements, this is an offset into the childNodes array.
code »
getFocusNode() ⇒
Node
No description.
Returns: 
Node
  The element or text node the range is focused at - i.e. where the cursor is.
code »
getFocusOffset() ⇒
number
No description.
Returns: 
number
  The offset into the node the range is focused at - i.e. where the cursor is. For text nodes, this is an offset into the node value. For elements, this is an offset into the childNodes array.
code »
getHtmlFragment() ⇒
string
Returns the HTML fragment this range selects. This is slow on all browsers. The HTML fragment may not be valid HTML, for instance if the user selects from a to b inclusively in the following html: >div<a>/div<b This method will return a</div>b If you need valid HTML, use {@link #getValidHtml} instead.
Returns: 
string
  HTML fragment of the range, does not include context containing elements.
code »
getPastableHtml() ⇒
string
Returns pastable HTML for this range. This guarantees that any child items that must have specific ancestors will have them, for instance all TDs will be contained in a TR in a TBODY in a TABLE and all LIs will be contained in a UL or OL as appropriate. This is semi-fast on all browsers.
Returns: 
string
  Pastable HTML of the range, including context containing elements.
code »
getStartNode() ⇒
Node
No description.
Returns: 
Node
  The element or text node the range starts in. For text ranges, the range comprises all text between the start and end position. For other types of range, start and end give bounds of the range but do not imply all nodes in those bounds are selected.
code »
getStartOffset() ⇒
number
No description.
Returns: 
number
  The offset into the node the range starts in. For text nodes, this is an offset into the node value. For elements, this is an offset into the childNodes array.
code »
getText() ⇒
string
No description.
Returns: 
string
  The text content of the range.
code »
getTextRange() ⇒
goog.dom.TextRange
Get the i-th text range in this range. The behavior is undefined if i >= getTextRangeCount or i < 0.
Returns: 
goog.dom.TextRange
  The i-th text range.
code »
getTextRangeCount() ⇒
number
No description.
Returns: 
number
  The number of text ranges in this range.
code »
getTextRanges() ⇒
Array.<goog.dom.TextRange>
Gets an array of all text ranges this range is comprised of. For non-multi ranges, returns a single element array containing this.
Returns: 
Array.<goog.dom.TextRange>
  Array of text ranges.
code »
getType() ⇒
goog.dom.RangeType
No description.
Returns: 
goog.dom.RangeType
  The type of range represented by this object.
code »
getValidHtml() ⇒
string
Returns valid HTML for this range. This is fast on IE, and semi-fast on other browsers.
Returns: 
string
  Valid HTML of the range, including context containing elements.
code »
getWindow() ⇒
Window
No description.
Returns: 
Window
  The window this selection is a part of.
code »
insertNode() ⇒
Node
Inserts a node before (or after) the range. The range may be disrupted beyond recovery because of the way this splits nodes.
Returns: 
Node
  The node added to the document. This may be different than the node parameter because on IE we have to clone it.
code »
isCollapsed() ⇒
boolean
No description.
Returns: 
boolean
  Whether the range is collapsed.
code »
isRangeInDocument() ⇒
boolean
Tests whether this range is valid (i.e. whether its endpoints are still in the document). A range becomes invalid when, after this object was created, either one or both of its endpoints are removed from the document. Use of an invalid range can lead to runtime errors, particularly in IE.
Returns: 
boolean
  Whether the range is valid.
code »
isReversed() ⇒
boolean
No description.
Returns: 
boolean
  Whether the selection is reversed.
code »
removeContents()
No description.
code »
replaceContentsWithNode(node) ⇒
Node
Replaces the range contents with (possibly a copy of) the given node. The range may be disrupted beyond recovery because of the way this splits nodes.
Arguments:
node :
Node
The node to insert.
Returns: 
Node
  The node added to the document. This may be different than the node parameter because on IE we have to clone it.
code »
saveUsingCarets() ⇒
?goog.dom.SavedCaretRange
Saves the range using HTML carets. As long as the carets remained in the HTML, the range can be restored...even when the HTML is copied across documents.
Returns: 
?goog.dom.SavedCaretRange
  A range representation that can be restored as long as carets are not removed. Returns null if carets could not be created.
code »
saveUsingDom() ⇒
goog.dom.SavedRange
Saves the range so that if the start and end nodes are left alone, it can be restored.
Returns: 
goog.dom.SavedRange
  A range representation that can be restored as long as the endpoint nodes of the selection are not modified.
code »
select()
No description.
code »
setBrowserRangeObject(nativeRange) ⇒
boolean
Sets the native browser range object, overwriting any state this range was storing.
Arguments:
nativeRange :
Range | TextRange
The native browser range object.
Returns: 
boolean
  Whether the given range was accepted. If not, the caller will need to call goog.dom.Range.createFromBrowserRange to create a new range object.
code »
surroundWithNodes()
Surrounds this range with the two given nodes. The range may be disrupted beyond recovery because of the way this splits nodes.
code »

Static Methods

goog.dom.AbstractRange.getBrowserSelectionForWindow(win) ⇒
?Object
Gets the browser native selection object from the given window.
Arguments:
win :
Window
The window to get the selection object from.
Returns: 
?Object
  The browser native selection object, or null if it could not be retrieved.
code »
goog.dom.AbstractRange.isNativeControlRange(range) ⇒
boolean
Tests if the given Object is a controlRange.
Arguments:
range :
Object
The range object to test.
Returns: 
boolean
  Whether the given Object is a controlRange.
code »

Package dom

Package Reference