goog.dom.ControlRange

Provided By	`goog.dom.ControlRange`
Extends	`goog.dom.AbstractMultiRange` `goog.dom.AbstractRange`

Create a new control selection with no properties. Do not use this constructor: use one of the goog.dom.Range.createFrom* methods instead.

new ControlRange()

Parameters	None.

VIEW SOURCE

Instance Methods

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

Overrides

goog.dom.AbstractRange

Parameters

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

Returns

goog.dom.RangeIterator

An iterator over tags in the range.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

goog.dom.AbstractRange

A clone of this range.

VIEW SOURCE

Collapses the range to one of its boundary points.

Overrides

goog.dom.AbstractRange

Parameters

`toAnchor`	`boolean`
	Whether to collapse to the anchor of the range.

VIEW SOURCE

Tests if this range contains the given node.

Defined by

goog.dom.AbstractMultiRange

Overrides

goog.dom.AbstractRange

Parameters

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

VIEW SOURCE

Tests if this range contains the given range.

Defined by

goog.dom.AbstractMultiRange

Overrides

goog.dom.AbstractRange

Parameters

`range`	`(goog.dom.AbstractRange\|null)`
	The range to test.
`opt_allowPartial`	`boolean=`
	If true, the range can be partially contained in the selection, otherwise the range must be entirely contained.

Returns

boolean

Whether this range contains the given range.

VIEW SOURCE

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

(Node|null)

The element or text node the range is anchored at.

VIEW SOURCE

Defined by

goog.dom.AbstractRange

Parameters

None.

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.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

(Range|TextRange|null)

The native browser range object.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

(Node|null)

The deepest node that contains the entire range.

VIEW SOURCE

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

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

(Element|null)

The deepest element that contains the entire range.

VIEW SOURCE

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

Document

The document this selection is a part of.

VIEW SOURCE

Parameters

None.

Returns

Array<(Element|null)>

Array of elements in the control range.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

(Node|null)

The element or text node the range ends in.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

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

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

(goog.math.Coordinate|null)

The coordinate of the selection end node and offset.

VIEW SOURCE

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

(Node|null)

The element or text node the range is focused at - i.e. where the cursor is.

VIEW SOURCE

Defined by

goog.dom.AbstractRange

Parameters

None.

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.

VIEW SOURCE

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 #getValidHtml instead.

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

string

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

VIEW SOURCE

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.

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

string

Pastable HTML of the range, including context containing elements.

VIEW SOURCE

Parameters

None.

Returns

Array<(Element|null)>

Array of elements comprising the control range, sorted by document order.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

(Node|null)

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.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

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

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

(goog.math.Coordinate|null)

The coordinate of the selection start node and offset.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

string

The text content of the range.

VIEW SOURCE

Get the i-th text range in this range. The behavior is undefined if i >= getTextRangeCount or i < 0.

Overrides

goog.dom.AbstractRange

Parameters

`i`	`number`
	The range number to retrieve.

Returns

(goog.dom.AbstractRange|null)

The i-th text range.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

number

The number of text ranges in this range.

VIEW SOURCE

Gets an array of all text ranges this range is comprised of. For non-multi ranges, returns a single element array containing this.

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

Array<(goog.dom.AbstractRange|null)>

Array of text ranges.

VIEW SOURCE

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

goog.dom.RangeType

The type of range represented by this object.

VIEW SOURCE

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

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

string

Valid HTML of the range, including context containing elements.

VIEW SOURCE

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

Window

The window this selection is a part of.

VIEW SOURCE

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

Defined by

goog.dom.AbstractMultiRange

Overrides

goog.dom.AbstractRange

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

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

boolean

Whether the range is collapsed.

VIEW SOURCE

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.

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

boolean

Whether the range is valid.

VIEW SOURCE

Defined by

goog.dom.AbstractRange

Parameters

None.

Returns

boolean

Whether the selection is reversed.

VIEW SOURCE

Removes the contents of the range from the document.

Overrides	`goog.dom.AbstractRange`
Parameters	None.

VIEW SOURCE

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.

Overrides

goog.dom.AbstractRange

Parameters

`node`	`(Node\|null)`
	The node to insert.

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

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.

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

(goog.dom.AbstractSavedCaretRange|null)

A range representation that can be restored as long as carets are not removed. Returns null if carets could not be created.

VIEW SOURCE

Saves the range so that if the start and end nodes are left alone, it can be restored.

Overrides

goog.dom.AbstractRange

Parameters

None.

Returns

goog.dom.SavedRange

A range representation that can be restored as long as the endpoint nodes of the selection are not modified.

VIEW SOURCE

Sets this range as the selection in its window.

Overrides	`goog.dom.AbstractRange`
Parameters	None.

VIEW SOURCE

Sets the native browser range object, overwriting any state this range was storing.

Overrides

goog.dom.AbstractRange

Parameters

`nativeRange`	`(Range\|TextRange\|null)`
	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.

VIEW SOURCE

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

Defined by

goog.dom.AbstractMultiRange

Overrides

goog.dom.AbstractRange

Parameters

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

VIEW SOURCE

Static Functions

Create a new range wrapper from the given browser range object. Do not use this method directly - please use goog.dom.Range.createFrom* instead.

Parameters

`controlRange`	`(Object\|null)`
	The browser range object.

Returns

goog.dom.ControlRange

A range wrapper object.

VIEW SOURCE

Create a new range wrapper that selects the given element. Do not use this method directly - please use goog.dom.Range.createFrom* instead.

Parameters

`var_args`	`...(Element\|null)`
	The element(s) to select.

Returns

goog.dom.ControlRange

A range wrapper object.

VIEW SOURCE

goog.dom.ControlRange

new ControlRange()

Instance Methods

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

this.clone() → goog.dom.AbstractRange

this.collapse( toAnchor ) → void

this.containsNode( node, opt_allowPartial ) → boolean

this.containsRange( range, opt_allowPartial ) → boolean

this.getAnchorNode() → (Node|null)

this.getAnchorOffset() → number

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

this.getContainer() → (Node|null)

this.getContainerElement() → (Element|null)

this.getDocument() → Document

this.getElements() → Array<(Element|null)>

this.getEndNode() → (Node|null)

this.getEndOffset() → number

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

this.getFocusNode() → (Node|null)

this.getFocusOffset() → number

this.getHtmlFragment() → string

this.getPastableHtml() → string

this.getSortedElements() → Array<(Element|null)>

this.getStartNode() → (Node|null)

this.getStartOffset() → number

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

this.getText() → string

this.getTextRange( i ) → (goog.dom.AbstractRange|null)

this.getTextRangeCount() → number

this.getTextRanges() → Array<(goog.dom.AbstractRange|null)>

this.getType() → goog.dom.RangeType

this.getValidHtml() → string

this.getWindow() → Window

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

this.isCollapsed() → boolean

this.isRangeInDocument() → boolean

this.isReversed() → boolean

this.removeContents() → void

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

this.saveUsingCarets() → (goog.dom.AbstractSavedCaretRange|null)

this.saveUsingDom() → goog.dom.SavedRange

this.select() → void

this.setBrowserRangeObject( nativeRange ) → boolean

this.surroundWithNodes( startNode, endNode ) → void

Static Functions

ControlRange.createFromBrowserRange( controlRange ) → goog.dom.ControlRange

ControlRange.createFromElements( ...var_args ) → goog.dom.ControlRange

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

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

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

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

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

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

`this.`getAnchorOffset() `→` `number`

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

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

`this.`getContainerElement() `→` `(Element|null)`

`this.`getDocument() `→` `Document`

`this.`getElements() `→` `Array<(Element|null)>`

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

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

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

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

`this.`getFocusOffset() `→` `number`

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

`this.`getPastableHtml() `→` `string`

`this.`getSortedElements() `→` `Array<(Element|null)>`

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

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

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

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

`this.`getTextRange( `i` ) `→` `(goog.dom.AbstractRange|null)`

`this.`getTextRangeCount() `→` `number`

`this.`getTextRanges() `→` `Array<(goog.dom.AbstractRange|null)>`

`this.`getType() `→` `goog.dom.RangeType`

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

`this.`getWindow() `→` `Window`

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

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

`this.`isRangeInDocument() `→` `boolean`

`this.`isReversed() `→` `boolean`

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

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

`this.`saveUsingCarets() `→` `(goog.dom.AbstractSavedCaretRange|null)`

`this.`saveUsingDom() `→` `goog.dom.SavedRange`

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

`this.`setBrowserRangeObject( `nativeRange` ) `→` `boolean`

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

ControlRange.createFromBrowserRange( `controlRange` ) `→` `goog.dom.ControlRange`

ControlRange.createFromElements( `...var_args` ) `→` `goog.dom.ControlRange`