Editor [edit]

Creates a new Editor object.

Arguments

renderer	VirtualRenderer	Required. Associated VirtualRenderer that draws everything
session	EditSession	Required. The EditSession to refer to

Emitted once the editor has been blurred.

Emitted whenever the document is changed.

Arguments

e

Object

Required. Contains a single property, data, which has the delta of changes

Emitted when the selection changes.

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

Arguments

data

Object

Required. Contains one property, data, which indicates the new selection style

Emitted whenever the EditSession changes.

Arguments

e

Object

Required. An object with two properties, oldSession and session, that represent the old and new EditSessions.

Emitted when text is copied.

Arguments

text

String

Required. The copied text

Emitted once the editor comes into focus.

Emitted when text is pasted.

Arguments

text

String

Required. The pasted text

Returns an object indicating the currently selected rows. The object looks like this:

{ first: range.start.row, last: range.end.row }

Returns the number of currently visibile rows.

Executes a specific function, which can be anything that manipulates selected lines, such as copying them, duplicating them, or shifting them.

Arguments

mover

Function

Required. A method to call on each selected row

Adds the selection and cursor.

Arguments

orientedRange

Range

Required. A range containing a cursor

Outdents the current line.

Blurs the current textInput.

Attempts to center the current selection on the screen.

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

Copies all the selected lines down one row.

Returns

Number

On success, returns the number of new rows added; in other words, lastRow - firstRow + 1.

Copies all the selected lines up one row.

Returns

Number

On success, returns 0.

Cleans up the entire editor.

Removes all the selections except the last added one.

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

Arguments

needle	String	Required. The text to search for (optional)
options	Object	Required. An object defining various search properties
animate	Boolean	Required. If true animate scrolling

Finds and selects all the occurences of needle.

Arguments

needle	String	Required. The text to find
options	Object	Required. The search options
additive	Boolean	Required. keeps

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

Arguments

options	Object	Required. search options
animate	Boolean	Required. If true animate scrolling

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

Arguments

options	Object	Required. search options
animate	Boolean	Required. If true animate scrolling

Brings the current textInput into focus.

Executes a command for each selection range.

Arguments

cmd	String	Required. The command to execute
args	String	Required. Any arguments for the command

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.

Gets the current position of the cursor.

Returns

Object

This returns an object that looks something like this: { row: currRow, column: currCol }

Returns the screen position of the cursor.

Returns the current mouse drag delay.

Returns the index of the first visible row.

Returns true if current lines are always highlighted.

Returns true if currently highlighted words are to be highlighted.

Returns the keyboard handler.

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

Returns the index of the last visible row.

Returns true if overwrites are enabled; false otherwise.

Returns the column number of where the print margin is.

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

Returns the value indicating how fast the mouse scroll speed is.

Returns the currently highlighted selection.

Returns the Range for the selected text.

Returns the current selection style.

Returns the current session being used.

Returns true if the fold widgets are shown.

Returns true if invisible characters are being shown.

Returns true if the print margin is being shown.

Returns the path of the current theme.

Returns the current session's content.

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

Arguments

lineNumber	Number	Required. The line number to go to
column	Number	Required. A column number to go to
animate	Boolean	Required. If true animates scolling

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.

Indents the current line.

Inserts text into wherever the cursor is pointing.

Arguments

text

String

Required. The new text to add

Returns true if the current textInput is in focus.

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

Arguments

row

Number

Required. The row to check

Indicates if the row is currently visible on the screen.

Arguments

row

Number

Required. The row to check

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

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

Arguments

row	Number	Required. The new row number
column	Number	Required. The new column number

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

Arguments

pos

Object

Required. An object with two properties, row and column

Shifts all the selected lines down one row.

Returns

Number

On success, it returns -1.

Shifts all the selected lines up one row.

Returns

Number

On success, it returns -1.

Moves a range of text from the given range to the given position. toPosition is an object that looks like this:

{ row: newRowLocation, column: newColumnLocation }

Arguments

fromRange	Range	Required. The range of text you want moved within the document
toPosition	Object	Required. The location (row and column) where you want to move the text to

Returns

Range

The new range where the text was moved to.

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

Arguments

times

Number

Required. The number of times to change navigation

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 left in the document the specified number of times. Note that this does de-select the current selection.

Arguments

times

Number

Required. The number of times to change navigation

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 right in the document the specified number of times. Note that this does de-select the current selection.

Arguments

times

Number

Required. The number of times to change navigation

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

Arguments

row	Number	Required. The new row number
column	Number	Required. The new column number

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

Arguments

times

Number

Required. The number of times to change navigation

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 "cut" happens.

Called whenever a text "paste" happens.

Arguments

text

String

Required. The pasted text

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.

Arguments

dir

String

Required. The direction of the deletion to occur, either "left" or "right"

Removes all the lines in the current selection

Removes the selection marker.

Arguments

range

Range

Required. The selection range added with addSelectionMarker().

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 the word directly to the left of the current selection.

Removes the word directly to the right of the current selection.

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

Arguments

replacement	String	Required. The text to replace with
options	Object	Required. The Search options to use

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

Arguments

replacement	String	Required. The text to replace with
options	Object	Required. The Search options to use

Triggers a resize of the editor.

Arguments

force

Boolean

Required. If true, recomputes the size, even if the height and width haven't changed

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.

TODO scrolls a to line, if center == true, puts line in middle of screen or attempts to)

Arguments

line	Number	Required. The line to scroll to
center	Boolean	Required. If true
animate	Boolean	Required. If true animates scrolling
callback	Function	Required. Function to be called when the animation has finished

Moves the editor to the specified row.

Arguments

row

Number

Required. The row to move to

Selects all the text in editor.

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

Arguments

dir	Number	Required. The direction of lines to select: -1 for up, 1 for down
skip	Boolean	Required. If true, removes the active selection range

Adds a cursor above or below the active cursor.

Arguments

dir	Number	Required. The direction of lines to select: -1 for up, 1 for down
skip	Boolean	Required. If true, removes the active selection range

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.

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

Arguments

enabled

Boolean

Required. Enables or disables behaviors

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

Arguments

dragDelay

Number

Required. A value indicating the new delay

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

Arguments

size

Number

Required. A font size

Determines whether or not the current line should be highlighted.

Arguments

shouldHighlight

Boolean

Required. Set to true to highlight the current line

Determines if the currently selected word should be highlighted.

Arguments

shouldHighlight

Boolean

Required. Set to true to highlight the currently selected word

Sets a new keyboard handler.

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.

Arguments

overwrite

Boolean

Required. Defines wheter or not to set overwrites

Sets the column defining where the print margin should be.

Arguments

showPrintMargin

Number

Required. Specifies the new print margin

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

Arguments

readOnly

Boolean

Required. Specifies whether the editor can be modified or not

Sets how fast the mouse scrolling should do.

Arguments

speed

Number

Required. A value indicating the new speed

Indicates how selections should occur. By default, selections are set to "line". This function also emits the 'changeSelectionStyle' event.

Arguments

style

String

Required. The new selection style

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

Arguments

session

EditSession

Required. The new session to use

Indicates whether the fold widgets are shown or not.

Arguments

show

Boolean

Required. Specifies whether the fold widgets are shown

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

Arguments

showInvisibles

Boolean

Required. Specifies whether or not to show invisible characters

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

Arguments

showPrintMargin

Boolean

Required. Specifies whether or not to show the print margin

Adds a new class, style, to the editor.

Arguments

style

String

Required. A class name

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

Arguments

theme

String

Required. The path to a theme

Sets the current document to val.

Arguments

val	String	Required. The new value to set for the document
cursorPos	Number	Required. Where to set the new value. undefined or 0 is selectAll, -1 is at the document start, and 1 is at the end

Splits the line at the current selection (by inserting an '\n').

Given the currently selected range, this function either comments all lines or uncomments all lines (depending on whether it's commented or not).

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 uppercase.

Transposes current line.

Transposes the selected ranges.

Arguments

dir

Number

Required. The direction to rotate selections

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

Removes the class style from the editor.

Updates the cursor and marker layers.