akasha

Class Selection

java.lang.Object

akasha.core.JsObject

akasha.Selection

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Selection")
public class Selection
extends JsObject

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 manipulation, call window.getSelection().

See Also:

Selection - MDN, # selection-interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Selection()

Method Summary

Modifier and Type	Method and Description
void	addRange(Range range) The Selection.addRange() method adds a Range to a Selection.
Node	anchorNode() The Selection.anchorNode read-only property returns the Node in which the selection begins.
int	anchorOffset() The Selection.anchorOffset read-only property returns the number of characters that the selection's anchor is offset within the Selection.anchorNode.
void	collapse(Node node) The Selection.collapse() method collapses the current selection to a single point.
void	collapse(Node node, int offset) The Selection.collapse() method collapses the current selection to a single point.
void	collapseToEnd() The Selection.collapseToEnd() method collapses the selection to the end of the last range in the selection.
void	collapseToStart() The Selection.collapseToStart() method collapses the selection to the start of the first range in the selection.
boolean	containsNode(Node node) The Selection.containsNode() method indicates whether a specfied node is part of the selection.
boolean	containsNode(Node node, boolean allowPartialContainment) The Selection.containsNode() method indicates whether a specfied node is part of the selection.
void	deleteFromDocument() The deleteFromDocument() method of the Selection interface deletes the selected text from the document's DOM.
void	empty() The Selection.removeAllRanges() method removes all ranges from the selection, leaving the anchorNode and focusNode properties equal to null and leaving nothing selected.
void	extend(Node node) The Selection.extend() method moves the focus of the selection to a specified point.
void	extend(Node node, int offset) The Selection.extend() method moves the focus of the selection to a specified point.
Node	focusNode() The Selection.focusNode read-only property returns the Node in which the selection ends.
int	focusOffset() The Selection.focusOffset read-only property returns the number of characters that the selection's focus is offset within the Selection.focusNode.
Range	getRangeAt(int index) The Selection.getRangeAt() method returns a range object representing one of the ranges currently selected.
boolean	isCollapsed() The Selection.isCollapsed read-only property returns a Boolean which indicates whether or not there is currently any text selected.
int	rangeCount() The Selection.rangeCount read-only property returns the number of ranges in the selection.
void	removeAllRanges() The Selection.removeAllRanges() method removes all ranges from the selection, leaving the anchorNode and focusNode properties equal to null and leaving nothing selected.
void	removeRange(Range range) The Selection.removeRange() method removes a range from a selection.
void	selectAllChildren(Node node) The Selection.selectAllChildren() method adds all the children of the specified node to the selection.
void	setBaseAndExtent(Node anchorNode, int anchorOffset, Node focusNode, int focusOffset) The setBaseAndExtent() method of the Selection interface sets the selection to be a range including all or parts of two specified DOM nodes, and any content located between them.
void	setPosition(Node node) The Selection.collapse() method collapses the current selection to a single point.
void	setPosition(Node node, int offset) The Selection.collapse() method collapses the current selection to a single point.
java.lang.String	type() The type read-only property of the Selection interface returns a DOMString describing the type of the current selection.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Selection

protected Selection()

Method Detail

anchorNode

@JsProperty(name="anchorNode")
 @Nullable
public Node anchorNode()

The Selection.anchorNode read-only property returns the Node in which the selection begins.

See Also:

Selection.anchorNode - MDN, Selection.anchorNode - Selection API

anchorOffset

@JsProperty(name="anchorOffset")
public int anchorOffset()

The Selection.anchorOffset read-only property returns the number of characters that the selection's anchor is offset within the Selection.anchorNode.

See Also:

Selection.anchorOffset - MDN, Selection.anchorOffset - Selection API

focusNode

@JsProperty(name="focusNode")
 @Nullable
public Node focusNode()

The Selection.focusNode read-only property returns the Node in which the selection ends.

See Also:

Selection.focusNode - MDN, Selection.focusNode - Selection API

focusOffset

@JsProperty(name="focusOffset")
public int focusOffset()

The Selection.focusOffset read-only property returns the number of characters that the selection's focus is offset within the Selection.focusNode.

See Also:

Selection.focusOffset - MDN, Selection.focusOffset - Selection API

isCollapsed

@JsProperty(name="isCollapsed")
public boolean isCollapsed()

The Selection.isCollapsed read-only property returns a Boolean which indicates whether or not there is currently any text selected. No text is selected when the selection's start and end points are at the same position in the content.

See Also:

Selection.isCollapsed - MDN, Selection.isCollapsed - Selection API

rangeCount

@JsProperty(name="rangeCount")
public int rangeCount()

The Selection.rangeCount read-only property returns the number of ranges in the selection.

See Also:

Selection.rangeCount - MDN, Selection.rangeCount - Selection API

type

@JsProperty(name="type")
 @Nonnull
public java.lang.String type()

The type read-only property of the Selection interface returns a DOMString describing the type of the current selection.

See Also:

Selection.type - MDN, Selection.type - Selection API

addRange

public void addRange(@Nonnull
                     Range range)

The Selection.addRange() method adds a Range to a Selection.

See Also:

Selection.addRange - MDN, Selection.addRange() - Selection API

collapse

public void collapse(@Nullable
                     Node node,
                     int offset)

The Selection.collapse() method collapses the current selection to a single point. The document is not modified. If the content is focused and editable, the caret will blink there.

See Also:

Selection.collapse - MDN, Selection.collapse() - Selection API

collapse

public void collapse(@Nullable
                     Node node)

The Selection.collapse() method collapses the current selection to a single point. The document is not modified. If the content is focused and editable, the caret will blink there.

See Also:

Selection.collapse - MDN, Selection.collapse() - Selection API

collapseToEnd

public void collapseToEnd()

The Selection.collapseToEnd() method collapses the selection to the end of the last range in the selection. If the content of the selection is focused and editable, the caret will blink there.

See Also:

Selection.collapseToEnd - MDN, Selection.collapseToEnd() - Selection API

collapseToStart

public void collapseToStart()

The Selection.collapseToStart() method collapses the selection to the start of the first range in the selection. If the content of the selection is focused and editable, the caret will blink there.

See Also:

Selection.collapseToStart - MDN, Selection.collapseToStart() - Selection API

containsNode

public boolean containsNode(@Nonnull
                            Node node,
                            boolean allowPartialContainment)

The Selection.containsNode() method indicates whether a specfied node is part of the selection.

See Also:

Selection.containsNode - MDN, Selection.containsNode() - Selection API

containsNode

public boolean containsNode(@Nonnull
                            Node node)

The Selection.containsNode() method indicates whether a specfied node is part of the selection.

See Also:

Selection.containsNode - MDN, Selection.containsNode() - Selection API

deleteFromDocument

public void deleteFromDocument()

The deleteFromDocument() method of the Selection interface deletes the selected text from the document's DOM.

See Also:

Selection.deleteFromDocument - MDN, Selection.deleteFromDocument() - Selection API

empty

public void empty()

The Selection.removeAllRanges() method removes all ranges from the selection, leaving the anchorNode and focusNode properties equal to null and leaving nothing selected.

See Also:

Selection.empty - MDN, Selection.removeAllRanges() - Selection API

extend

public void extend(@Nonnull
                   Node node,
                   int offset)

The Selection.extend() method moves the focus of the selection to a specified point. The anchor of the selection does not move. The selection will be from the anchor to the new focus, regardless of direction.

See Also:

Selection.extend - MDN, Selection.extend() - Selection API

extend

public void extend(@Nonnull
                   Node node)

The Selection.extend() method moves the focus of the selection to a specified point. The anchor of the selection does not move. The selection will be from the anchor to the new focus, regardless of direction.

See Also:

Selection.extend - MDN, Selection.extend() - Selection API

getRangeAt

@Nonnull
public Range getRangeAt(int index)

The Selection.getRangeAt() method returns a range object representing one of the ranges currently selected.

See Also:

Selection.getRangeAt - MDN, Selection: getRangeAt() - Selection API

removeAllRanges

public void removeAllRanges()

The Selection.removeAllRanges() method removes all ranges from the selection, leaving the anchorNode and focusNode properties equal to null and leaving nothing selected.

See Also:

Selection.removeAllRanges - MDN, Selection.removeAllRanges() - Selection API

removeRange

public void removeRange(@Nonnull
                        Range range)

The Selection.removeRange() method removes a range from a selection.

See Also:

Selection.removeRange - MDN, Selection.removeRange() - Selection API

selectAllChildren

public void selectAllChildren(@Nonnull
                              Node node)

The Selection.selectAllChildren() method adds all the children of the specified node to the selection. Previous selection is lost.

See Also:

Selection.selectAllChildren - MDN, Selection.selectAllChildren() - Selection API

setBaseAndExtent

public void setBaseAndExtent(@Nonnull
                             Node anchorNode,
                             int anchorOffset,
                             @Nonnull
                             Node focusNode,
                             int focusOffset)

The setBaseAndExtent() method of the Selection interface sets the selection to be a range including all or parts of two specified DOM nodes, and any content located between them.

See Also:

Selection.setBaseAndExtent - MDN, Selection.setBaseAndExtent() - Selection API

setPosition

public void setPosition(@Nullable
                        Node node,
                        int offset)

The Selection.collapse() method collapses the current selection to a single point. The document is not modified. If the content is focused and editable, the caret will blink there.

See Also:

Selection.setPosition - MDN, Selection.collapse() - Selection API

setPosition

public void setPosition(@Nullable
                        Node node)

The Selection.collapse() method collapses the current selection to a single point. The document is not modified. If the content is focused and editable, the caret will blink there.

See Also:

Selection.setPosition - MDN, Selection.collapse() - Selection API