View source

class Selection

package js.html

@:native("Selection")

Available on js

A Selection object represents the range of text selected by the user or the current position of the caret. To obtain a Selection object for examination or modification, call window.getSelection().

Documentation Selection by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Variables

read onlyanchorNode:Node

Returns the Node in which the selection begins.

read onlyanchorOffset:Int

Returns a number representing the offset of the selection's anchor within the anchorNode. If anchorNode is a text node, this is the number of characters within anchorNode preceding the anchor. If anchorNode is an element, this is the number of child nodes of the anchorNode preceding the anchor.

caretBidiLevel:Int

read onlyfocusNode:Node

Returns the Node in which the selection ends.

read onlyfocusOffset:Int

Returns a number representing the offset of the selection's anchor within the focusNode. If focusNode is a text node, this is the number of characters within focusNode preceding the focus. If focusNode is an element, this is the number of child nodes of the focusNode preceding the focus.

read onlyisCollapsed:Bool

Returns a Boolean indicating whether the selection's start and end points are at the same position.

read onlyrangeCount:Int

Returns the number of ranges in the selection.

read onlytype:String

Returns a DOMString describing the type of the current selection.

Methods

addRange(range:Range):Void

A Range object that will be added to the selection.

Throws:

null

DOMError

@:value({ offset : 0 })collapse(node:Node, offset:Int = 0):Void

Collapses the current selection to a single point.

Throws:

null

DOMError

collapseToEnd():Void

Collapses the selection to the end of the last range in the selection.

Throws:

null

DOMError

collapseToStart():Void

Collapses the selection to the start of the first range in the selection.

Throws:

null

DOMError

@:value({ allowPartialContainment : false })containsNode(node:Node, allowPartialContainment:Bool = false):Bool

Indicates if a certain node is part of the selection.

Throws:

null

DOMError

deleteFromDocument():Void

Deletes the selection's content from the document.

Throws:

null

DOMError

empty():Void

Throws:

null

DOMError

@:value({ offset : 0 })extend(node:Node, offset:Int = 0):Void

Moves the focus of the selection to a specified point.

Throws:

null

DOMError

getRangeAt(index:Int):Range

Returns a Range object representing one of the ranges currently selected.

Throws:

null

DOMError

modify(alter:String, direction:String, granularity:String):Void

Changes the current selection.

Throws:

null

DOMError

removeAllRanges():Void

Removes all ranges from the selection.

Throws:

null

DOMError

removeRange(range:Range):Void

Removes a range from the selection.

Throws:

null

DOMError

selectAllChildren(node:Node):Void

Adds all the children of the specified node to the selection.

Throws:

null

DOMError

setBaseAndExtent(anchorNode:Node, anchorOffset:Int, focusNode:Node, focusOffset:Int):Void

Sets the selection to be a range including all or parts of two specified DOM nodes, and any content located between them.

Throws:

null

DOMError

@:value({ offset : 0 })setPosition(node:Node, offset:Int = 0):Void

Throws:

null

DOMError