goog.dom.browserrange.AbstractRange

Provided By	`goog.dom.browserrange.AbstractRange`
All Known Direct Subclasses	`goog.dom.browserrange.W3cRange`

Parameters	None.

Returns a RangeIterator over the contents of the range. Regardless of the direction of the range, the iterator will move in document order.

Parameters

`opt_keys`	`boolean=`
	Unused for this iterator.

Returns

goog.dom.RangeIterator

An iterator over tags in the range.

VIEW SOURCE

Parameters

None.

Returns

(goog.dom.browserrange.AbstractRange|null)

A clone of this range.

VIEW SOURCE

Collapses the range to one of its boundary points.

Parameters

`toStart`	`boolean`
	Whether to collapse to the start of the range.

VIEW SOURCE

Compares one endpoint of this range with the endpoint of another browser native range object.

Parameters

`range`	`(Range\|TextRange\|null)`
	The browser native range to compare against.
`thisEndpoint`	`goog.dom.RangeEndpoint`
	The endpoint of this range to compare with.
`otherEndpoint`	`goog.dom.RangeEndpoint`
	The endpoint of the other range to compare with.

Returns

number

0 if the endpoints are equal, negative if this range endpoint comes before the other range endpoint, and positive otherwise.

VIEW SOURCE

Tests if this range contains the given node.

Parameters

`node`	`(Node\|null)`
	The node to test.
`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.

VIEW SOURCE

Tests if this range contains the given range.

Parameters

`abstractRange`	`(goog.dom.browserrange.AbstractRange\|null)`
	The range to test.
`opt_allowPartial`	`boolean=`
	If not set or false, the range must be entirely contained in the selection for this function to return true.

Returns

boolean

Whether this range contains the given range.

VIEW SOURCE

Returns the browser native implementation of the range. Please refrain from using this function - if you find you need the range please add wrappers for the functionality you need rather than just using the native range.

Parameters

None.

Returns

(Range|TextRange|null)

The browser native range object.

VIEW SOURCE

Returns the deepest node in the tree that contains the entire range.

Parameters

None.

Returns

(Node|null)

The deepest node that contains the entire range.

VIEW SOURCE

Returns the node the range ends in.

Parameters

None.

Returns

(Node|null)

The element or text node the range ends in.

VIEW SOURCE

Returns the offset into the node the range ends in.

Parameters

None.

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.

VIEW SOURCE

Parameters

None.

Returns

(goog.math.Coordinate|null)

The coordinate of the selection end node and offset.

VIEW SOURCE

Returns the HTML fragment this range selects. This is slow on all browsers.

Parameters

None.

Returns

string

HTML fragment of the range, does not include context containing elements.

VIEW SOURCE

Returns the node the range starts in.

Parameters

None.

Returns

(Node|null)

The element or text node the range starts in.

VIEW SOURCE

Returns the offset into the node the range starts in.

Parameters

None.

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.

VIEW SOURCE

Parameters

None.

Returns

(goog.math.Coordinate|null)

The coordinate of the selection start node and offset.

VIEW SOURCE

Parameters

None.

Returns

string

The text content of the range.

VIEW SOURCE

Returns valid HTML for this range. This is fast on IE, and semi-fast on other browsers.

Parameters

None.

Returns

string

Valid HTML of the range, including context containing elements.

VIEW SOURCE

Inserts a node before (or after) the range. The range may be disrupted beyond recovery because of the way this splits nodes.

Parameters

`node`	`(Node\|null)`
	The node to insert.
`before`	`boolean`
	True to insert before, false to insert after.

Returns

(Node|null)

The node added to the document. This may be different than the node parameter because on IE we have to clone it.

VIEW SOURCE

Tests if the selection is collapsed - i.e. is just a caret.

Parameters

None.

Returns

boolean

Whether the range is collapsed.

VIEW SOURCE

Removes the contents of the range from the document. As a side effect, the selection will be collapsed. The behavior of content removal is normalized across browsers. For instance, IE sometimes creates extra text nodes that a W3C browser does not. That behavior is corrected for.

VIEW SOURCE

Set this range as the selection in its window.

Parameters

`opt_reverse`	`boolean=`
	Whether to select the range in reverse, if possible.

VIEW SOURCE

Surrounds the text range with the specified element (on Mozilla) or with a clone of the specified element (on IE). Returns a reference to the surrounding element if the operation was successful; returns null if the operation failed.

Parameters

`element`	`(Element\|null)`
	The element with which the selection is to be surrounded.

Returns

(Element|null)

The surrounding element (same as the argument on Mozilla, but not on IE), or null if unsuccessful.

VIEW SOURCE

Surrounds this range with the two given nodes. The range may be disrupted beyond recovery because of the way this splits nodes.

Parameters

`startNode`	`(Element\|null)`
	The node to insert at the start.
`endNode`	`(Element\|null)`
	The node to insert at the end.

VIEW SOURCE

goog.dom.browserrange.AbstractRange

new AbstractRange()

Instance Methods

`this.`iterator( `opt_keys` ) `→` `goog.dom.RangeIterator`

`this.`clone() `→` `(goog.dom.browserrange.AbstractRange|null)`

`this.`collapse( `toStart` ) `→` `void`

`this.`compareBrowserRangeEndpoints( `range`, `thisEndpoint`, `otherEndpoint` ) `→` `number`

`this.`containsNode( `node`, `opt_allowPartial` ) `→` `boolean`

`this.`containsRange( `abstractRange`, `opt_allowPartial` ) `→` `boolean`

`this.`getBrowserRange() `→` `(Range|TextRange|null)`

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

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

`this.`getEndOffset() `→` `number`

`this.`getEndPosition() `→` `(goog.math.Coordinate|null)`

`this.`getHtmlFragment() `→` `string`

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

`this.`getStartOffset() `→` `number`

`this.`getStartPosition() `→` `(goog.math.Coordinate|null)`

`this.`getText() `→` `string`

`this.`getValidHtml() `→` `string`

`this.`insertNode( `node`, `before` ) `→` `(Node|null)`

`this.`isCollapsed() `→` `boolean`

`this.`removeContents() `→` `void`

`this.`select( `opt_reverse` ) `→` `void`

`this.`surroundContents( `element` ) `→` `(Element|null)`

`this.`surroundWithNodes( `startNode`, `endNode` ) `→` `void`

goog.dom.browserrange.AbstractRange

new AbstractRange()

Instance Methods

this.__iterator__( opt_keys ) → goog.dom.RangeIterator

this.clone() → (goog.dom.browserrange.AbstractRange|null)

this.collapse( toStart ) → void

this.compareBrowserRangeEndpoints( range, thisEndpoint, otherEndpoint ) → number

this.containsNode( node, opt_allowPartial ) → boolean

this.containsRange( abstractRange, opt_allowPartial ) → boolean

this.getBrowserRange() → (Range|TextRange|null)

this.getContainer() → (Node|null)

this.getEndNode() → (Node|null)

this.getEndOffset() → number

this.getEndPosition() → (goog.math.Coordinate|null)

this.getHtmlFragment() → string

this.getStartNode() → (Node|null)

this.getStartOffset() → number

this.getStartPosition() → (goog.math.Coordinate|null)

this.getText() → string

this.getValidHtml() → string

this.insertNode( node, before ) → (Node|null)

this.isCollapsed() → boolean

this.removeContents() → void

this.select( opt_reverse ) → void

this.surroundContents( element ) → (Element|null)

this.surroundWithNodes( startNode, endNode ) → void

`this.`iterator( `opt_keys` ) `→` `goog.dom.RangeIterator`

`this.`clone() `→` `(goog.dom.browserrange.AbstractRange|null)`

`this.`collapse( `toStart` ) `→` `void`

`this.`compareBrowserRangeEndpoints( `range`, `thisEndpoint`, `otherEndpoint` ) `→` `number`

`this.`containsNode( `node`, `opt_allowPartial` ) `→` `boolean`

`this.`containsRange( `abstractRange`, `opt_allowPartial` ) `→` `boolean`

`this.`getBrowserRange() `→` `(Range|TextRange|null)`

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

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

`this.`getEndOffset() `→` `number`

`this.`getEndPosition() `→` `(goog.math.Coordinate|null)`

`this.`getHtmlFragment() `→` `string`

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

`this.`getStartOffset() `→` `number`

`this.`getStartPosition() `→` `(goog.math.Coordinate|null)`

`this.`getText() `→` `string`

`this.`getValidHtml() `→` `string`

`this.`insertNode( `node`, `before` ) `→` `(Node|null)`

`this.`isCollapsed() `→` `boolean`

`this.`removeContents() `→` `void`

`this.`select( `opt_reverse` ) `→` `void`

`this.`surroundContents( `element` ) `→` `(Element|null)`

`this.`surroundWithNodes( `startNode`, `endNode` ) `→` `void`