Editor

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.

Constructors

• new Editor(VirtualRenderer renderer, EditSession session)

Creates a new Editor object.

Events

• Editor.on("blur", function())

Emitted once the editor has been blurred.

• Editor.on("change", function(Object e))

Emitted whenever the document is changed.

• Editor.on("changeSelectionStyle", function(Object data))

Emitted when the selection style changes, via Editor.setSelectionStyle().

• Editor.on("changeSession", function(Object e))

Emitted whenever the EditSession changes.

• Editor.on("copy", function(String text))

Emitted when text is copied.

• Editor.on("focus", function())

Emitted once the editor comes into focus.

• Editor.on("paste", function(Object e))

Emitted when text is pasted.

Methods

• Editor.addSelectionMarker(Range orientedRange)
• 返回值： Range

Adds the selection and cursor.

• Editor.alignCursors()

Aligns the cursors or selected text.

• 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.copyLinesDown()
• 返回值： Number

Copies all the selected lines down one row.

• Editor.copyLinesUp()
• 返回值： Number

Copies all the selected lines up one row.

• Editor.destroy()

Cleans up the entire editor.

• Editor.duplicateSelection()

• Undocumented

• Editor.execCommand()

• Undocumented

• Editor.exitMultiSelectMode()

Removes all the selections except the last added one.

• Editor.find(String needle, Object options, Boolean animate)

Attempts to find needle within the document. For more information on options, see Search.

• Editor.findAll(String The, Object The, Boolean keeps)
• 返回值： Number

Finds and selects all the occurrences of needle.

• Editor.findNext(Object options, Boolean animate)

Performs another search for needle in the document. For more information on options, see Search.

• Editor.findPrevious(Object options, Boolean animate)

Performs a search for needle backwards. For more information on options, see Search.

• Editor.focus()

Brings the current textInput into focus.

• Editor.forEachSelection(String cmd, String args)

Executes a command for each selection range.

• Editor.getAnimatedScroll()

• Undocumented

• Editor.getBehavioursEnabled()
• 返回值： Boolean

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()
• 返回值： String

Returns the string of text currently highlighted.

• Editor.getCursorPosition()
• 返回值： Object

Gets the current position of the cursor.

• Editor.getCursorPositionScreen()
• 返回值： Number

Returns the screen position of the cursor.

• Editor.getDisplayIndentGuides()

• Undocumented

• Editor.getDragDelay()
• 返回值： Number

Returns the current mouse drag delay.

• Editor.getFadeFoldWidgets()

• Undocumented

• Editor.getFirstVisibleRow()
• 返回值： Number

Returns the index of the first visible row.

• Editor.getHighlightActiveLine()
• 返回值： Boolean

Returns true if current lines are always highlighted.

• Editor.getHighlightGutterLine()

• Undocumented

• Editor.getHighlightSelectedWord()
• 返回值： Boolean

Returns true if currently highlighted words are to be highlighted.

• Editor.getKeyboardHandler()
• 返回值： String

Returns the keyboard handler, such as "vim" or "windows".

• Editor.getLastSearchOptions()
• 返回值： Object

Returns an object containing all the search options. For more information on options, see Search.

• Editor.getLastVisibleRow()
• 返回值： Number

Returns the index of the last visible row.

• Editor.getNumberAt(Object row, Object column)
• 返回值： Number

Works like EditSession.getTokenAt(), except it returns a number.

• Editor.getOverwrite()
• 返回值： Boolean

Returns true if overwrites are enabled; false otherwise.

• Editor.getPrintMarginColumn()
• 返回值： Number

Returns the column number of where the print margin is.

• Editor.getReadOnly()
• 返回值： Boolean

Returns true if the editor is set to read-only mode.

• Editor.getScrollSpeed()
• 返回值： Number

Returns the value indicating how fast the mouse scroll speed is (in milliseconds).

• Editor.getSelection()
• 返回值： Selection

Returns selection object.

• Editor.getSelectionRange()
• 返回值： Range

Returns the Range for the selected text.

• Editor.getSelectionStyle()
• 返回值： String

Returns the current selection style.

• Editor.getSession()
• 返回值： EditSession

Returns the current session being used.

• Editor.getShowFoldWidgets()
• 返回值： Boolean

Returns true if the fold widgets are shown.

• Editor.getShowInvisibles()
• 返回值： Boolean

Returns true if invisible characters are being shown.

• Editor.getShowPrintMargin()
• 返回值： Boolean

Returns true if the print margin is being shown.

• Editor.getTheme()
• 返回值： String

Returns the path of the current theme.

• Editor.getValue()
• 返回值： String

Returns the current session's content.

• Editor.getWrapBehavioursEnabled()

Returns true if the wrapping behaviors are currently enabled.

• Editor.gotoLine(Number lineNumber, Number column, Boolean animate)

Moves the cursor to the specified line number, and also into the indicated column.

• 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.insert(String text)

Inserts text into wherever the cursor is pointing.

• Editor.isFocused()
• 返回值： Boolean

Returns true if the current textInput is in focus.

• Editor.isRowFullyVisible(Number row)
• 返回值： Boolean

Indicates if the entire row is currently visible on the screen.

• Editor.isRowVisible(Number row)
• 返回值： Boolean

Indicates if the row is currently visible on the screen.

• Editor.jumpToMatching(Object select)

Moves the cursor's row and column to the next matching bracket.

• Editor.modifyNumber(Number amount)

If the character before the cursor is a number, this functions changes its value by amount.

• Editor.moveCursorTo(Number row, Number column)

Moves the cursor to the specified row and column. Note that this does not de-select the current selection.

• Editor.moveCursorToPosition(Object pos)

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

• Editor.moveLinesDown()
• 返回值： Number

Shifts all the selected lines down one row.

• Editor.moveLinesUp()
• 返回值： Number

Shifts all the selected lines up one row.

• Editor.moveText()

• Undocumented

• Editor.navigateDown(Number times)

Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection.

• Editor.navigateFileEnd()

Moves the cursor to the end of the current file. Note that this does de-select the current selection.

• Editor.navigateFileStart()

Moves the cursor to the start of the current file. Note that this does de-select the current selection.

• Editor.navigateLeft(Number times)

Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection.

• Editor.navigateLineEnd()

Moves the cursor to the end of the current line. Note that this does de-select the current selection.

• Editor.navigateLineStart()

Moves the cursor to the start of the current line. Note that this does de-select the current selection.

• Editor.navigateRight(Number times)

Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection.

• Editor.navigateTo(Number row, Number column)

Moves the cursor to the specified row and column. Note that this does de-select the current selection.

• Editor.navigateUp(Number times)

Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection.

• Editor.navigateWordLeft()

Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.

• Editor.navigateWordRight()

Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.

• Editor.onBlur()

• Undocumented

• Editor.onChangeAnnotation()

• Undocumented

• Editor.onChangeBackMarker()

• Undocumented

• Editor.onChangeBreakpoint()

• Undocumented

• Editor.onChangeFold()

• Undocumented

• Editor.onChangeFrontMarker()

• Undocumented

• Editor.onChangeMode()

• Undocumented

• Editor.onChangeWrapLimit()

• Undocumented

• Editor.onChangeWrapMode()

• Undocumented

• Editor.onCommandKey()

• Undocumented

• Editor.onCompositionEnd()

• Undocumented

• Editor.onCompositionStart()

• Undocumented

• Editor.onCompositionUpdate()

• Undocumented

• Editor.onCopy()

Called whenever a text "copy" happens.

• Editor.onCursorChange()

Emitted when the selection changes.

• Editor.onCut()

Called whenever a text "cut" happens.

• Editor.onDocumentChange()

• Undocumented

• Editor.onFocus()

• Undocumented

• Editor.onPaste(String text)

Called whenever a text "paste" happens.

• Editor.onScrollLeftChange()

• Undocumented

• Editor.onScrollTopChange()

• Undocumented

• Editor.onSelectionChange()

• Undocumented

• Editor.onTextInput()

• Undocumented

• Editor.onTokenizerUpdate()

• Undocumented

• Editor.redo()

Perform a redo operation on the document, reimplementing the last change.

• Editor.remove(String dir)

Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.

• Editor.removeLines()

Removes all the lines in the current selection

• Editor.removeSelectionMarker(Range The)

Removes the selection marker.

• 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.replace(String replacement, Object options)

Replaces the first occurrence of options.needle with the value in replacement.

• Editor.replaceAll(String replacement, Object options)

Replaces all occurrences of options.needle with the value in replacement.

• Editor.resize(Boolean force)

Triggers a resize of the editor.

• Editor.revealRange()

• Undocumented

• 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.scrollToLine(Number line, Boolean center, Boolean animate, Function callback)

Scrolls to a line. If center is true, it puts the line in middle of screen (or attempts to).

• Editor.scrollToRow(Object row)

Moves the editor to the specified row.

• Editor.selectAll()

Selects all the text in editor.

• Editor.selectMore(Number dir, Boolean skip)

Finds the next occurrence of text in an active selection and adds it to the selections.

• Editor.selectMoreLines(Number dir, Boolean skip)

Adds a cursor above or below the active cursor.

• 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.setAnimatedScroll()

• Undocumented

• Editor.setBehavioursEnabled(Boolean enabled)

Specifies whether to use behaviors or not. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.

• Editor.setDisplayIndentGuides()

• Undocumented

• Editor.setDragDelay(Number dragDelay)

Sets the delay (in milliseconds) of the mouse drag.

• Editor.setFadeFoldWidgets()

• Undocumented

• Editor.setFontSize(Number size)

Set a new font size (in pixels) for the editor text.

• Editor.setHighlightActiveLine(Boolean shouldHighlight)

Determines whether or not the current line should be highlighted.

• Editor.setHighlightGutterLine()

• Undocumented

• Editor.setHighlightSelectedWord(Boolean shouldHighlight)

Determines if the currently selected word should be highlighted.

• Editor.setKeyboardHandler(String keyboardHandler)

Sets a new key handler, such as "vim" or "windows".

• Editor.setOverwrite(Boolean overwrite)

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 emits the changeOverwrite event.

• Editor.setPrintMarginColumn(Number showPrintMargin)

Sets the column defining where the print margin should be.

• Editor.setReadOnly(Boolean readOnly)

If readOnly is true, then the editor is set to read-only mode, and none of the content can change.

• Editor.setScrollSpeed(Number speed)

Sets how fast the mouse scrolling should do.

• Editor.setSelectionStyle(String style)

Indicates how selections should occur.

By default, selections are set to "line". There are no other styles at the moment, although this code change in the future.

This function also emits the 'changeSelectionStyle' event.

• Editor.setSession(EditSession session)

Sets a new editsession to use. This method also emits the 'changeSession' event.

• Editor.setShowFoldWidgets(Boolean show)

Indicates whether the fold widgets are shown or not.

• Editor.setShowInvisibles(Boolean showInvisibles)

If showInvisibles is set to true, invisible characters—like spaces or new lines—are show in the editor.

• Editor.setShowPrintMargin(Boolean showPrintMargin)

If showPrintMargin is set to true, the print margin is shown in the editor.

• Editor.setStyle(String style)

Adds a new class, style, to the editor.

• Editor.setTheme(String theme)

Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.

• Editor.setValue(String val, Number cursorPos)
• 返回值： String

Sets the current document to val.

• Editor.setWrapBehavioursEnabled(Boolean 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.

• Editor.sortLines()

• Undocumented

• 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 the lines, or uncomments all of them.

• 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.transposeSelections(Number dir)

Transposes the selected ranges.

• Editor.undo()

Perform an undo operation on the document, reverting the last change.

• Editor.unsetStyle(Object style)

Removes the class style from the editor.

• Editor.updateSelectionMarkers()

Updates the cursor and marker layers.