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.
Editor[edit]
Constructors
-
- new Editor(VirtualRenderer renderer, EditSession session)
Creates a new Editor object. ...
Arguments
| renderer | VirtualRenderer | Required. Associated VirtualRenderer that draws everything |
| session | EditSession | Required. The EditSession to refer to |
Events
-
- Editor.on("onBlur", function())
Emitted once the editor has been blurred. ...
-
- Editor.on("onChangeAnnotation", function())
Emitted when an annotation changes. ...
-
- Editor.on("onChangeBackMarker", function())
Emitted when a back marker changes. ...
-
- Editor.on("onChangeBreakpoint", function())
Emitted when a breakpoint changes. ...
-
- Editor.on("onChangeFold", function())
Emitted when the code folds change. ...
-
- Editor.on("onChangeFrontMarker", function())
Emitted when a front marker changes. ...
-
- Editor.on("onChangeMode", function())
Emitted when the mode changes. ...
-
- Editor.on("onChangeWrapLimit", function())
Emitted when the wrap limit changes. ...
-
- Editor.on("onChangeWrapMode", function())
Emitted when the wrap mode changes. ...
-
- Editor.on("onCommandKey", function(e, hashId, keyCode))
Emitted when the command-key is pressed. ...
-
- Editor.on("onCursorChange", function())
Emitted when the cursor changes. ...
-
- Editor.on("onFocus", function())
Emitted once the editor comes into focus. ...
-
- Editor.on("onScrollLeftChange", function())
Emitted when the scroll left changes. ...
-
- Editor.on("onScrollTopChange", function())
Emitted when the scroll top changes. ...
Methods
-
- Editor.$getSelectedRows()
Returns an object indicating the currently selected rows. The object looks like this: ...
{ first: range.start.row, last: range.end.row }
-
- Editor.$getVisibleRowCount()
Returns the number of currently visibile rows. ...
-
- Editor.blockOutdent()
Outdents the current line. ...
-
- Editor.blur()
Blurs the current textInput. ...
-
- Editor.centerSelection()
Attempts to center the current selection on the screen. ...
-
- Editor.clearSelection()
Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event. ...
-
- Editor.destroy()
Cleans up the entire editor. ...
-
- Editor.exitMultiSelectMode()
Removes all the selections except the last added one. ...
-
- Editor.findNext(options)
Performs another search for needle in the document. For more information on options, see Search. ...
-
- Editor.findPrevious(options)
-
- Editor.focus()
Brings the current textInput into focus. ...
-
- Editor.getBehavioursEnabled()
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. ...
-
- Editor.getCopyText()
Returns the string of text currently highlighted. ...
-
- Editor.getCursorPositionScreen()
Returns the screen position of the cursor. ...
-
- Editor.getDragDelay()
Returns the current mouse drag delay. ...
-
- Editor.getFirstVisibleRow()
Returns the index of the first visible row. ...
-
- Editor.getHighlightActiveLine()
Returns true if current lines are always highlighted. ...
-
- Editor.getHighlightSelectedWord()
Returns true if currently highlighted words are to be highlighted. ...
-
- Editor.getKeyboardHandler()
Returns the keyboard handler. ...
-
- Editor.getLastVisibleRow()
Returns the index of the last visible row. ...
-
- Editor.getOverwrite()
Returns true if overwrites are enabled; false otherwise. ...
-
- Editor.getPrintMarginColumn()
Returns the column number of where the print margin is. ...
-
- Editor.getReadOnly()
Returns true if the editor is set to read-only mode. ...
-
- Editor.getScrollSpeed()
Returns the value indicating how fast the mouse scroll speed is. ...
-
- Editor.getSelection()
Returns the currently highlighted selection. ...
-
- Editor.getSelectionStyle()
Returns the current selection style. ...
-
- Editor.getSession()
Returns the current session being used. ...
-
- Editor.getShowFoldWidgets()
Returns true if the fold widgets are shown. ...
-
- Editor.getShowInvisibles()
Returns true if invisible characters are being shown. ...
-
- Editor.getShowPrintMargin()
Returns true if the print margin is being shown. ...
-
- Editor.getTheme()
Returns the path of the current theme. ...
-
- Editor.gotoPageDown()
Shifts the document to wherever "page down" is, as well as moving the cursor position. ...
-
- Editor.gotoPageUp()
Shifts the document to wherever "page up" is, as well as moving the cursor position. ...
-
- Editor.indent()
Indents the current line. ...
-
- Editor.isFocused()
Returns true if the current textInput is in focus. ...
-
- Editor.jumpToMatching()
Moves the cursor's row and column to the next matching bracket. ...
Moves a range of text from the given range to the given position. toPosition is an object that looks like this:
...
-
- ()
-
- ()
-
- ()
-
- ()
-
- ()
-
- ()
-
- Editor.removeSelectionMarker(Range range)
Removes the selection marker. ...
Arguments
| range | Range | Required. The selection range added with addSelectionMarker(). |
-
- Editor.onCut()
Emitted whenever a text "cut" happens. ...
-
- Editor.redo()
Perform a redo operation on the document, reimplementing the last change. ...
-
- Editor.removeLines()
Removes all the lines in the current selection ...
-
- Editor.removeToLineEnd()
Removes all the words to the right of the current selection, until the end of the line. ...
-
- Editor.removeToLineStart()
Removes all the words to the left of the current selection, until the start of the line. ...
-
- Editor.removeWordLeft()
Removes the word directly to the left of the current selection. ...
-
- Editor.removeWordRight()
Removes the word directly to the right of the current selection. ...
-
- Editor.resize()
Triggers a resize of the editor. ...
-
- Editor.scrollPageDown()
Scrolls the document to wherever "page down" is, without changing the cursor position. ...
-
- Editor.scrollPageUp()
Scrolls the document to wherever "page up" is, without changing the cursor position. ...
-
- Editor.selectAll()
Selects all the text in editor. ...
-
- Editor.selectPageDown()
Selects the text from the current position of the document until where a "page down" finishes. ...
-
- Editor.selectPageUp()
Selects the text from the current position of the document until where a "page up" finishes. ...
-
- Editor.setBehavioursEnabled()
Specifies whether to use behaviors or not. ["Behaviors" in this case is the auto-pairing of special characters, like...
Arguments
| enabled | Boolean | Required. Enables or disables behaviors |
-
- Editor.setKeyboardHandler(keyboardHandler)
Sets a new keyboard handler. ...
-
- Editor.setSession(EditSession session)
Sets a new editsession to use. This method also emits the 'changeSession' event. ...
Arguments
| session | EditSession | Required. The new session to use |
-
- Editor.setStyle(style)
Adds a new class, style, to the editor. ...
-
- Editor.setTheme(theme)
Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate. ...
-
- Editor.splitLine()
Splits the line at the current selection (by inserting an '\n'). ...
-
- Editor.toggleCommentLines()
Given the currently selected range, this function either comments all lines or uncomments all lines (depending on wh...
-
- Editor.toggleOverwrite()
Sets the value of overwrite to the opposite of whatever it currently is. ...
-
- Editor.toLowerCase()
Converts the current selection entirely into lowercase. ...
-
- Editor.toUpperCase()
Converts the current selection entirely into uppercase. ...
-
- Editor.transposeLetters()
Transposes current line. ...
-
- Editor.undo()
Perform an undo operation on the document, reverting the last change. Returns the range of the undo. ...
-
- Editor.unsetStyle(style)
Removes the class style from the editor. ...