Implemented by
Interface for manipulating and querying the current selected range of nodes within the document. @status FROZEN @version 1.0
[scriptable, uuid(b2c7ed59-8634-4352-9e37-5484c8b6e4e1)]
interface nsISelection : nsISupports
Attributes
The node representing one end of the selection.
readonly attribute
nsIDOMNode
anchorNode
The offset within the (text) node where the selection begins.
readonly attribute
long
anchorOffset
The node with keyboard focus.
readonly attribute
nsIDOMNode
focusNode
The offset within the (text) node where focus starts.
readonly attribute
long
focusOffset
Indicates if the selection is collapsed or not.
readonly attribute
boolean
isCollapsed
Returns the number of ranges in the selection.
readonly attribute
long
rangeCount
Methods
Adds a range to the current selection.
void
addRange(in nsIDOMRange range)
Collapses the selection to a single point, at the specified offset in the given DOM node. When the selection is collapsed, and the content is focused and editable, the caret will blink there. @param parentNode The given dom node where the selection will be set @param offset Where in given dom node to place the selection (the offset into the given node)
void
collapse(in nsIDOMNode parentNode, in long offset)
Collapses the whole selection to a single point at the end of the current selection (irrespective of direction). If content is focused and editable, the caret will blink there.
void
collapseToEnd()
Collapses the whole selection to a single point at the start of the current selection (irrespective of direction). If content is focused and editable, the caret will blink there.
void
collapseToStart()
The value of entirelyContained determines the detail of the search to determine if the selection contains the node. If entirelyContained is set to PR_TRUE, t or false if @param node The node where the selection will be extended to @param entirelyContained Whether
boolean
containsNode(in nsIDOMNode node, in boolean entirelyContained)
Deletes this selection from document the nodes belong to.
void
deleteFromDocument()
Extends the selection by moving the focus to the specified node and offset, preserving the anchor postion. The new selection end result will always be from the anchor to the new focus, regardless of direction. @param parentNode The node where the selection will be extended to @param offset Where in node to place the offset in the new focused node
void
extend(in nsIDOMNode parentNode, in long offset)
Returns the range at the specified index.
nsIDOMRange
getRangeAt(in long index)
Removes all ranges from the current selection.
void
removeAllRanges()
Removes a range from the current selection.
void
removeRange(in nsIDOMRange range)
Adds all children of the specified node to the selection. @param parentNode the parent of the children to be added to the selection.
void
selectAllChildren(in nsIDOMNode parentNode)
Modifies the cursor Bidi level after a change in keyboard direction
@param langRTL is PR_TRUE if the new language is right-to-left or
PR_FALSE if the new language is left-to-right.
void
selectionLanguageChange(in boolean langRTL)
Returns the whole selection into a plain text string.
wstring
toString()
Compare to: