Selection

js.html.Selection (extern class)

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:

Instance Members

anchorNode: Node

Returns the Node in which the selection begins.

anchorOffset: 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.

focusNode: Node

Returns the Node in which the selection ends.

focusOffset: 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.

isCollapsed: Bool

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

rangeCount: Int

Returns the number of ranges in the selection.

type: String

Returns a DOMString describing the type of the current selection.

caretBidiLevel: Int
getRangeAt(index: Int): Range

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

Name Type
index Int
Returns
Range
addRange(range: Range): Void

A Range object that will be added to the selection.

Name Type
range Range
removeRange(range: Range): Void

Removes a range from the selection.

Name Type
range Range
removeAllRanges(): Void

Removes all ranges from the selection.

empty(): Void
collapse(node: Node, ?offset: Int = 0): Void

Collapses the current selection to a single point.

Name Type Default
node Node
offset Int 0
setPosition(node: Node, ?offset: Int = 0): Void
Name Type Default
node Node
offset Int 0
collapseToStart(): Void

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

collapseToEnd(): Void

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

extend(node: Node, ?offset: Int = 0): Void

Moves the focus of the selection to a specified point.

Name Type Default
node Node
offset Int 0
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.

Name Type
anchorNode Node
anchorOffset Int
focusNode Node
focusOffset Int
selectAllChildren(node: Node): Void

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

Name Type
node Node
deleteFromDocument(): Void

Deletes the selection's content from the document.

containsNode(node: Node, ?allowPartialContainment: Bool = false): Bool

Indicates if a certain node is part of the selection.

Name Type Default
node Node
allowPartialContainment Bool false
Returns
Bool
modify(alter: String, direction: String, granularity: String): Void

Changes the current selection.

Name Type
alter String
direction String
granularity String