Contains the cursor position and the text selection of an edit session.
The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.
Selection[edit]
Constructors
- new Selection(EditSession session)
Creates a new Selection object.
Methods
- 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.getCursor()
Gets the current position of the cursor.
Gets the current position of the cursor.
- 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.
- Selection.isBackwards()
Returns true if the selection is going backwards in the document.
Returns true if the selection is going backwards in the document.
- Selection.isEmpty()
Returns true if the selection is empty.
Returns true if the selection is empty.
- Selection.isMultiLine()
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.
- 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.
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
| row | Number | Required. The row to move to |
| column | Number | Required. The column to move to |
| keepDesiredColumn | Boolean | Required. If true, the cursor move does not respect the previous column |
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
| row | Number | Required. The row to move to |
| column | Number | Required. The column to move to |
| keepDesiredColumn | Boolean | 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.
Gets list of ranges composing rectangular block on the screen
- 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.
- Selection.selectUp()
Moves the selection up one row.
Moves the selection up one row.
- Selection.selectWord()
Moves the selection to highlight the entire word.
Moves the selection to highlight the entire word.
- 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.
- 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
| columns | Number | Required. The number of columns to shift by |