Selection

Contains the cursor position and the text selection of an edit session.

The row/columns used in the selection are in document coordinates representing the coordinates as they appear in the document before applying soft wrap and folding.

Constructors

Creates a new Selection object.

Creates a new Selection object.

Arguments

sessionEditSession

Required. The session to use

Events

    • Selection.on("changeCursor", function())

Emitted when the cursor position changes.

Emitted when the cursor position changes.

    • Selection.on("changeSelection", function())

Emitted when the cursor selection changes.

Emitted when the cursor selection changes.

Methods

    • Selection.addRange(Range range, Boolean $blockChangeEvents)

Adds a range to a selection by entering multiselect mode, if necessary.

Adds a range to a selection by entering multiselect mode, if necessary.

Arguments

rangeRange

Required. The new range to add

$blockChangeEventsBoolean

Required. Whether or not to block changing events

    • Selection.clearSelection()

Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.

Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.

    • Selection.detach()
    • Undocumented
    • Selection.fromOrientedRange()
    • Undocumented
    • Selection.getAllRanges()

Returns a concatenation of all the ranges.

Returns a concatenation of all the ranges.

    • Selection.getCursor()

Gets the current position of the cursor.

Gets the current position of the cursor.

    • Selection.getLineRange()
    • Undocumented
    • Selection.getRange()

Returns the Range for the selected text.

Returns the Range for the selected text.

    • Selection.getSelectionAnchor()

Returns an object containing the row and column of the calling selection anchor.

Returns an object containing the row and column of the calling selection anchor.

    • Selection.getSelectionLead()

Returns an object containing the row and column of the calling selection lead.

Returns an object containing the row and column of the calling selection lead.

Moves the selection to highlight the entire word.

Moves the selection to highlight the entire word.

Arguments

rowObject

Required.

columnObject

Required.

Returns true if the selection is going backwards in the document.

Returns true if the selection is going backwards in the document.

Returns true if the selection is empty.

Returns true if the selection is empty.

Returns true if the selection is a multi-line.

Returns true if the selection is a multi-line.

    • Selection.mergeOverlappingRanges()

Merges overlapping ranges ensuring consistency after changes

Merges overlapping ranges ensuring consistency after changes

Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

Arguments

rowsNumber

Required. The number of rows to move by

charsNumber

Required. The number of characters to move by

    • Selection.moveCursorDown()

Moves the cursor down one row.

Moves the cursor down one row.

    • Selection.moveCursorFileEnd()

Moves the cursor to the end of the file.

Moves the cursor to the end of the file.

    • Selection.moveCursorFileStart()

Moves the cursor to the start of the file.

Moves the cursor to the start of the file.

    • Selection.moveCursorLeft()

Moves the cursor left one column.

Moves the cursor left one column.

    • Selection.moveCursorLineEnd()

Moves the cursor to the end of the line.

Moves the cursor to the end of the line.

    • Selection.moveCursorLineStart()

Moves the cursor to the start of the line.

Moves the cursor to the start of the line.

    • Selection.moveCursorLongWordLeft()

Moves the cursor to the word on the left.

Moves the cursor to the word on the left.

    • Selection.moveCursorLongWordRight()

Moves the cursor to the word on the right.

Moves the cursor to the word on the right.

    • Selection.moveCursorRight()

Moves the cursor right one column.

Moves the cursor right one column.

    • Selection.moveCursorShortWordLeft()
    • Undocumented
    • Selection.moveCursorShortWordRight()
    • Undocumented

Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

Arguments

rowNumber

Required. The row to move to

columnNumber

Required. The column to move to

keepDesiredColumnBoolean

Required. If true, the cursor move does not respect the previous column

    • Selection.moveCursorToPosition(Object position)

Moves the selection to the position indicated by its row and column.

Moves the selection to the position indicated by its row and column.

Arguments

positionObject

Required. The position to move to

Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

Arguments

rowNumber

Required. The row to move to

columnNumber

Required. The column to move to

keepDesiredColumnBoolean

Required. If true, the cursor move does not respect the previous column

    • Selection.moveCursorUp()

Moves the cursor up one row.

Moves the cursor up one row.

    • Selection.moveCursorWordLeft()
    • Undocumented
    • Selection.moveCursorWordRight()
    • Undocumented

Gets list of ranges composing rectangular block on the screen

Gets list of ranges composing rectangular block on the screen

Arguments

screenCursorCursor

Required. The cursor to use

screenAnchorAnchor

Required. The anchor to use

includeEmptyLinesBoolean

Required. If true, this includes ranges inside the block which are empty due to clipping

    • Selection.selectAll()

Selects all the text in the document.

Selects all the text in the document.

    • Selection.selectAWord()

Selects a word, including its right whitespace.

Selects a word, including its right whitespace.

    • Selection.selectDown()

Moves the selection down one row.

Moves the selection down one row.

    • Selection.selectFileEnd()

Moves the selection to the end of the file.

Moves the selection to the end of the file.

    • Selection.selectFileStart()

Moves the selection to the start of the file.

Moves the selection to the start of the file.

    • Selection.selectLeft()

Moves the selection left one column.

Moves the selection left one column.

    • Selection.selectLine()

Selects the entire line.

Selects the entire line.

    • Selection.selectLineEnd()

Moves the selection to the end of the current line.

Moves the selection to the end of the current line.

    • Selection.selectLineStart()

Moves the selection to the beginning of the current line.

Moves the selection to the beginning of the current line.

    • Selection.selectRight()

Moves the selection right one column.

Moves the selection right one column.

Moves the selection cursor to the indicated row and column.

Moves the selection cursor to the indicated row and column.

Arguments

rowNumber

Required. The row to select to

columnNumber

Required. The column to select to

    • Selection.selectToPosition(Object pos)

Moves the selection cursor to the row and column indicated by pos.

Moves the selection cursor to the row and column indicated by pos.

Arguments

posObject

Required. An object containing the row and column

    • Selection.selectUp()

Moves the selection up one row.

Moves the selection up one row.

    • Selection.selectWord()

Selects an entire word boundary.

Selects an entire word boundary.

    • Selection.selectWordLeft()

Moves the selection to the first word on the left.

Moves the selection to the first word on the left.

    • Selection.selectWordRight()

Moves the selection to the first word on the right.

Moves the selection to the first word on the right.

Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

Arguments

rowNumber

Required. The new row

columnNumber

Required. The new column

Sets the selection to the provided range.

Sets the selection to the provided range.

Arguments

rangeRange

Required. The range of text to select

reverseBoolean

Required. Indicates if the range should go backwards (true) or not

    • Selection.shiftSelection(Number columns)

Shifts the selection up (or down, if isBackwards() is true) the given number of columns.

Shifts the selection up (or down, if isBackwards() is true) the given number of columns.

Arguments

columnsNumber

Required. The number of columns to shift by

    • Selection.splitIntoLines()

Splits all the ranges into lines.

Splits all the ranges into lines.

    • Selection.substractPoint(Range pos)

Removes a Range containing pos (if it exists).

Removes a Range containing pos (if it exists).

Arguments

posRange

Required. The position to remove, as a {row, column} object

    • Selection.toggleBlockSelection()
    • Undocumented
    • Selection.toOrientedRange()
    • Undocumented
    • Selection.toSingleRange()
    • Undocumented