The main entry point into the Ace functionality.
The Editor manages the EditSession (which manages Documents), as well as the VirtualRenderer, which draws everything to the screen.
Event sessions dealing with the mouse and keyboard are bubbled up from Document to the Editor, which decides what to do with them.
Creates a new Editor object.
Creates a new Editor object.
| renderer | VirtualRenderer | Required. Associated |
| session | EditSession | Required. The |
Emitted once the editor has been blurred.
Emitted once the editor has been blurred.
Emitted when the selection style changes, via Editor.setSelectionStyle().
Emitted when the selection style changes, via Editor.setSelectionStyle().
| data | Object | Required. Contains one property, |
Emitted whenever the EditSession changes.
Emitted whenever the EditSession changes.
| e | Object | Required. An object with two properties, |
Emitted once the editor comes into focus.
Emitted once the editor comes into focus.
Aligns the cursors or selected text.
Aligns the cursors or selected text.
Outdents the current line.
Outdents the current line.
Blurs the current textInput.
Blurs the current textInput.
Attempts to center the current selection on the screen.
Attempts to center the current selection on the screen.
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.
Copies all the selected lines down one row.
Copies all the selected lines down one row.
Copies all the selected lines up one row.
Copies all the selected lines up one row.
Cleans up the entire editor.
Cleans up the entire editor.
Removes all the selections except the last added one.
Removes all the selections except the last added one.
Attempts to find needle within the document. For more information on options, see Search.
Brings the current textInput into focus.
Brings the current textInput into focus.
Returns true if the behaviors are currently enabled. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.
Returns true if the behaviors are currently enabled. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.
Returns the string of text currently highlighted.
Returns the string of text currently highlighted.
Gets the current position of the cursor.
Gets the current position of the cursor.
Returns the screen position of the cursor.
Returns the screen position of the cursor.
Returns the current mouse drag delay.
Returns the current mouse drag delay.
Returns the index of the first visible row.
Returns the index of the first visible row.
Returns true if current lines are always highlighted.
Returns true if current lines are always highlighted.
Returns true if currently highlighted words are to be highlighted.
Returns true if currently highlighted words are to be highlighted.
Returns the keyboard handler, such as "vim" or "windows".
Returns the keyboard handler, such as "vim" or "windows".
Returns the index of the last visible row.
Returns the index of the last visible row.
Works like EditSession.getTokenAt(), except it returns a number.
Works like EditSession.getTokenAt(), except it returns a number.
| row | Object | Required. |
| column | Object | Required. |
Returns true if overwrites are enabled; false otherwise.
Returns true if overwrites are enabled; false otherwise.
Returns the column number of where the print margin is.
Returns the column number of where the print margin is.
Returns true if the editor is set to read-only mode.
Returns true if the editor is set to read-only mode.
Returns the value indicating how fast the mouse scroll speed is.
Returns the value indicating how fast the mouse scroll speed is.
Returns the currently highlighted selection.
Returns the currently highlighted selection.
Returns the current selection style.
Returns the current selection style.
Returns the current session being used.
Returns the current session being used.
Returns true if the fold widgets are shown.
Returns true if the fold widgets are shown.
Returns true if invisible characters are being shown.
Returns true if invisible characters are being shown.
Returns true if the print margin is being shown.
Returns true if the print margin is being shown.
Returns the path of the current theme.
Returns the path of the current theme.
Returns the current session's content.
Returns the current session's content.
Returns true if the wrapping behaviors are currently enabled.
Returns true if the wrapping behaviors are currently enabled.
Moves the cursor to the specified line number, and also into the indiciated column.
Shifts the document to wherever "page down" is, as well as moving the cursor position.
Shifts the document to wherever "page down" is, as well as moving the cursor position.
Shifts the document to wherever "page up" is, as well as moving the cursor position.
Shifts the document to wherever "page up" is, as well as moving the cursor position.
Indents the current line.
Indents the current line.
Returns true if the current textInput is in focus.
Returns true if the current textInput is in focus.
Moves the cursor to the specified row and column. Note that this does not de-select the current selection.
Shifts all the selected lines down one row.
Shifts all the selected lines down one row.
Shifts all the selected lines up one row.
Shifts all the selected lines up one row.
Moves the cursor to the end of the current file. Note that this does de-select the current selection.
Moves the cursor to the start of the current file. Note that this does de-select the current selection.
Moves the cursor to the end of the current line. Note that this does de-select the current selection.
Moves the cursor to the start of the current line. Note that this does de-select the current selection.
Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.
Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.
Called whenever a text "copy" happens.
Called whenever a text "copy" happens.
Emitted when the selection changes.
Emitted when the selection changes.
Called whenever a text "cut" happens.
Called whenever a text "cut" happens.
Perform a redo operation on the document, reimplementing the last change.
Perform a redo operation on the document, reimplementing the last change.
Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.
Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.
| dir | String | Required. The direction of the deletion to occur, either "left" or "right" |
Removes all the lines in the current selection
Removes all the lines in the current selection
Removes the selection marker.
Removes the selection marker.
| The | Range | Required. selection range added with |
Removes all the words to the right of the current selection, until the end of the line.
Removes all the words to the right of the current selection, until the end of the line.
Removes all the words to the left of the current selection, until the start of the line.
Removes all the words to the left of the current selection, until the start of the line.
Removes the word directly to the left of the current selection.
Removes the word directly to the left of the current selection.
Removes the word directly to the right of the current selection.
Removes the word directly to the right of the current selection.
Scrolls the document to wherever "page down" is, without changing the cursor position.
Scrolls the document to wherever "page down" is, without changing the cursor position.
Scrolls the document to wherever "page up" is, without changing the cursor position.
Scrolls the document to wherever "page up" is, without changing the cursor position.
Scrolls to a line. If center is true, it puts the line in middle of screen (or attempts to).
Scrolls to a line. If center is true, it puts the line in middle of screen (or attempts to).
| line | Number | Required. The line to scroll to |
| center | Boolean | Required. If |
| animate | Boolean | Required. If |
| callback | Function | Required. Function to be called when the animation has finished |
Selects all the text in editor.
Selects all the text in editor.
Finds the next occurence of text in an active selection and adds it to the selections.
Selects the text from the current position of the document until where a "page down" finishes.
Selects the text from the current position of the document until where a "page down" finishes.
Selects the text from the current position of the document until where a "page up" finishes.
Selects the text from the current position of the document until where a "page up" finishes.
Specifies whether to use behaviors or not. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.
Specifies whether to use behaviors or not. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.
| enabled | Boolean | Required. Enables or disables behaviors |
Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.
Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.
| overwrite | Boolean | Required. Defines wheter or not to set overwrites |
If readOnly is true, then the editor is set to read-only mode, and none of the content can change.
If readOnly is true, then the editor is set to read-only mode, and none of the content can change.
| readOnly | Boolean | Required. Specifies whether the editor can be modified or not |
Sets a new editsession to use. This method also emits the 'changeSession' event.
Sets a new editsession to use. This method also emits the 'changeSession' event.
| session | EditSession | Required. The new session to use |
If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor.
If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor.
| showInvisibles | Boolean | Required. Specifies whether or not to show invisible characters |
Editor.setWrapBehavioursEnabled(enabled)
Editor.setWrapBehavioursEnabled(enabled)
Specifies whether to use wrapping behaviors or not, i.e. automatically wrapping the selection with characters such as brackets when such a character is typed in.
| enabled | Object | Required. |
Splits the line at the current selection (by inserting an '\n').
Splits the line at the current selection (by inserting an '\n').
Given the currently selected range, this function either comments all the lines, or uncomments all of them.
Given the currently selected range, this function either comments all the lines, or uncomments all of them.
Sets the value of overwrite to the opposite of whatever it currently is.
Sets the value of overwrite to the opposite of whatever it currently is.
Converts the current selection entirely into lowercase.
Converts the current selection entirely into lowercase.
Converts the current selection entirely into uppercase.
Converts the current selection entirely into uppercase.
Transposes current line.
Transposes current line.
Perform an undo operation on the document, reverting the last change.
Perform an undo operation on the document, reverting the last change.
Updates the cursor and marker layers.
Updates the cursor and marker layers.