EditSession - Ace API

Stores all the data about Editor state providing easy way to change editors state. EditSession can be attached to only one Document. Same Document can be attached to several EditSessions.

- new EditSession(Document | String text, TextMode mode)

Sets up a new EditSession and associates it with the given Document and TextMode.

Arguments

text	Document \| String	Required. If `text` is a `Document`, it associates the `EditSession` with it. Otherwise, a new `Document` is created, with the initial text
mode	TextMode	Required. The inital language mode to use for the document

- EditSession.on("change", function(e))

Emitted when the document changes.

- EditSession.on("changeFold", function(e))

Emitted when a code fold added or removed.

- EditSession.on("changeScrollLeft", function())

Emitted when the scroll left changes.

- EditSession.on("changeScrollTop", function())

Emitted when the scroll top changes.

- EditSession.on("tokenizerUpdate", function(e))

Emitted when a background tokenizer asynchronousely processes new rows.

- EditSession.$computeWrapSplits(tokens, wrapLimit)
- - Array
- Internal

- EditSession.$constrainWrapLimit(wrapLimit)
- Internal

- EditSession.$detectNewLine(String text)
- Internal

If text contains either the newline (\n) or carriage-return ('\r') characters, $autoNewLine stores that value.

Arguments

text	String	Required. A block of text

- EditSession.$getDisplayTokens(String str, Number offset)
- - Array
- Internal

Given a string, returns an array of the display characters, including tabs and spaces.

Arguments

str	String	Required. The string to check
offset	Number	Required. The value to start at

- EditSession.$getStringScreenWidth(String str, Number maxScreenColumn, Number screenColumn)
- - Number
- Internal

Calculates the width of the string str on the screen while assuming that the string starts at the first column on the screen.

Arguments

str	String	Required. The string to calculate the screen width of
maxScreenColumn	Number	Required.
screenColumn	Number	Required.

- EditSession.$getUndoSelection(deltas, isUndo, lastUndoRange)
- - Range
- Internal

- EditSession.$resetRowCache(Number row)
- Internal

Arguments

row	Number	Required. The row to work with

- EditSession.$startWorker()
- Internal

- EditSession.$syncInformUndoManager()
- Internal

- EditSession.$updateInternalDataOnChange()
- Internal

- EditSession.$updateWrapData(firstRow, lastRow)
- Internal

- EditSession.addDynamicMarker(Object marker, Boolean inFront)
- - Object

Adds a dynamic marker to the session.

Arguments

marker	Object	Required. object with update method
inFront	Boolean	Required. Set to `true` to establish a front marker

- EditSession.addGutterDecoration(Number row, String className)
- - Void

Adds className to the row, to be used for CSS stylings and whatnot.

Arguments

row	Number	Required. The row number
className	String	Required. The class to add

- EditSession.addMarker(Range range, String clazz, Function | String type = "line", Boolean inFront)
- - Number

Adds a new marker to the given Range. If inFront is true, a front marker is defined, and the 'changeFrontMarker' event fires; otherwise, the 'changeBackMarker' event fires.

Arguments

range	Range	Required. Define the range of the marker
clazz	String	Required. Set the CSS class for the marker
type	Function \| String	Required. Identify the type of the marker
inFront	Boolean	Required. Set to `true` to establish a front marker

- EditSession.adjustWrapLimit(Number desiredLimit)
- - Boolean
- Internal

This should generally only be called by the renderer when a resize is detected.

Arguments

desiredLimit	Number	Required. The new wrap limit

- EditSession.clearAnnotations()

Clears all the annotations for this session. This function also triggers the 'changeAnnotation' event.

- EditSession.clearBreakpoint(Number row)

Removes a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

Arguments

row	Number	Required. A row index

- EditSession.clearBreakpoints()

Removes all breakpoints on the rows. This function also emites the 'changeBreakpoint' event.

- EditSession.documentToScreenColumn(row, docColumn)
- - Number
- Internal

- EditSession.documentToScreenPosition(Number docRow, Number docColumn)
- - Object
- Related to EditSession.screenToDocumentPosition

Converts document coordinates to screen coordinates. This takes into account code folding, word wrap, tab size, and any other visual modifications.

Arguments

docRow	Number	Required. The document row to check
docColumn	Number	Required. The document column to check

- EditSession.documentToScreenRow(docRow, docColumn)
- - Number
- Internal

- EditSession.duplicateLines(Number firstRow, Number lastRow)
- - Number

Duplicates all the text between firstRow and lastRow.

Arguments

firstRow	Number	Required. The starting row to duplicate
lastRow	Number	Required. The final row to duplicate

- EditSession.getAnnotations()
- - Object

Returns the annotations for the EditSession.

- EditSession.getAWordRange(Number row, Number column)
- - Range

Gets the range of a word, including its right whitespace.

Arguments

row	Number	Required. The row number to start from
column	Number	Required. The column number to start from

- EditSession.getBreakpoints()
- - Array

Returns an array of numbers, indicating which rows have breakpoints.

- EditSession.getDocument()
- - Document

Returns the Document associated with this session.

- EditSession.getDocumentLastRowColumn(Number docRow, Number docColumn)
- - Number
- Internal

Arguments

docRow	Number	Required.
docColumn	Number	Required.

- EditSession.getDocumentLastRowColumnPosition(docRow, docColumn)
- - Number
- Internal

- EditSession.getLength()
- - Number
- Related to Document.getLength

Returns the number of rows in the document.

- EditSession.getLine(Number row)
- - String
- Related to Document.getLine

Returns a verbatim copy of the given line as it is in the document

Arguments

row	Number	Required. The row to retrieve from

- EditSession.getLines(Number firstRow, Number lastRow)
- - Array
- Related to Document.getLines

Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.

Arguments

firstRow	Number	Required. The first row index to retrieve
lastRow	Number	Required. The final row index to retrieve

- EditSession.getMarkers(Boolean inFront)
- - Array

Returns an array containing the IDs of all the markers, either front or back.

Arguments

inFront	Boolean	Required. If `true`, indicates you only want front markers; `false` indicates only back markers

- EditSession.getMode()
- - TextMode

Returns the current text mode.

- EditSession.getNewLineMode()
- - String
- Related to Document.getNewLineMode

Returns the current new line mode.

- EditSession.getOverwrite()
- - Boolean

Returns true if overwrites are enabled; false otherwise.

- EditSession.getRowLength(Number row)
- - Number

Returns number of screenrows in a wrapped line.

Arguments

row	Number	Required. The row number to check

- EditSession.getRowSplitData(row)
- - undefined
  - String
- Internal

- EditSession.getScreenLastRowColumn(Number screenRow)
- - Number
- Internal
- Related to EditSession.documentToScreenColumn

Returns the column position (on screen) for the last character in the provided row.

Arguments

screenRow	Number	Required. The screen row to check

- EditSession.getScreenLength()
- - Number

Returns the length of the screen.

- EditSession.getScreenTabSize(Number screenColumn)
- - Number

The distance to the next tab stop at the specified screen column.

Arguments

screenColumn	Number	Required. The screen column to check

- EditSession.getScreenWidth()
- - Number

Returns the width of the screen.

- EditSession.getScrollLeft()
- - Number

Returns the value of the distance between the left of the editor and the leftmost part of the visible content.

- EditSession.getScrollTop()
- - Number

Returns the value of the distance between the top of the editor and the topmost part of the visible content.

- EditSession.getSelection()
- - String

Returns the string of the current selection.

- EditSession.getState(Number row)
- - Array
- Related to BackgroundTokenizer.getState

Returns the state of tokenization at the end of a row.

Arguments

row	Number	Required. The row to start at

- EditSession.getTabSize()
- - Number

Returns the current tab size.

- EditSession.getTabString()
- - String

Returns the current value for tabs. If the user is using soft tabs, this will be a series of spaces (defined by getTabSize); otherwise it's simply '\t'.

- EditSession.getTextRange(String range)
- - Array
- Related to Document.getTextRange

Given a range within the document, this function returns all the text within that range as a single string.

Arguments

range	String	Required. The range to work with

- EditSession.getTokenAt(Number row, Number column)
- - Array

Returns an array of tokens at the indicated row and column.

Arguments

row	Number	Required. The row number to retrieve from
column	Number	Required. The column number to retrieve from

- EditSession.getTokens(Number row)
- - Array
- Related to BackgroundTokenizer.getTokens

Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows.

Arguments

row	Number	Required. The row to start at

- EditSession.getUndoManager()
- - UndoManager

Returns the current undo manager.

- EditSession.getUseSoftTabs()
- - Boolean

Returns true if soft tabs are being used, false otherwise.

- EditSession.getUseWorker()
- - Boolean

Returns true if workers are being used.

- EditSession.getUseWrapMode()
- - Boolean

Returns true if wrap mode is being used; false otherwise.

- EditSession.getValue()
- - String
- Aliased as: EditSession.toString

Returns the current Document as a string.

- EditSession.getWordRange(Number row, Number column)
- - Range

Given a starting row and column, this method returns the Range of the first word boundary it finds.

Arguments

row	Number	Required. The row to start at
column	Number	Required. The column to start at

- EditSession.getWrapLimit()
- - Number

Returns the value of wrap limit.

- EditSession.getWrapLimitRange()
- - Object

Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this:

{ min: wrapLimitRange_min, max: wrapLimitRange_max }

- EditSession.indentRows(Number startRow, Number endRow, String indentString)

Indents all the rows, from startRow to endRow (inclusive), by prefixing each row with the token in indentString.

If indentString contains the '\t' character, it's replaced by whatever is defined by getTabString.

Arguments

startRow	Number	Required. Starting row
endRow	Number	Required. Ending row
indentString	String	Required. The indent token

- EditSession.insert(Number position, String text)
- - Number
- Related to Document.insert

Inserts a block of text and the indicated position.

Arguments

position	Number	Required. The position to start inserting at
text	String	Required. A chunk of text to insert

- EditSession.isTabStop(Object position)
- - Boolean

Returns true if the character at the position is a soft tab.

Arguments

position	Object	Required. The position to check

- EditSession.moveLinesDown(Number firstRow, Number lastRow)
- - Number
- Related to Document.insertLines

Arguments

firstRow	Number	Required. The starting row to move down
lastRow	Number	Required. The final row to move down

- EditSession.moveLinesUp(Number firstRow, Number lastRow)
- - Number
- Related to Document.insertLines

Shifts all the lines in the document up one, starting from firstRow and ending at lastRow.

Arguments

firstRow	Number	Required. The starting row to move up
lastRow	Number	Required. The final row to move up

- EditSession.moveText(Range fromRange, Object toPosition)
- - Range

{ 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

- EditSession.onReloadTokenizer(e)

Reloads all the tokens on the current session. This function calls start to all the rows; it also emits the 'tokenizerUpdate' event.

- EditSession.outdentRows(Range range)

Outdents all the rows defined by the start and end properties of range.

Arguments

range	Range	Required. A range of rows

- EditSession.redoChanges(Array deltas, Boolean dontSelect)
- - Range

Re-implements a previously undone change to your document.

Arguments

deltas	Array	Required. An array of previous changes
dontSelect	Boolean	Required. If `true`, doesn't select the range of where the change occured

- EditSession.remove(Range range)
- - Object
- Related to Document.remove

Removes the range from the document.

Arguments

range	Range	Required. A specified Range to remove

- EditSession.removeGutterDecoration(Number row, String className)
- - Void

Removes className from the row.

Arguments

row	Number	Required. The row number
className	String	Required. The class to add

- EditSession.removeMarker(Number markerId)

Removes the marker with the specified ID. If this marker was in front, the 'changeFrontMarker' event is emitted. If the marker was in the back, the 'changeBackMarker' event is emitted.

Arguments

markerId	Number	Required. A number representing a marker

- EditSession.replace(Range range, String text)
- - Object
- Related to Document.replace

Replaces a range in the document with the new text.

Arguments

range	Range	Required. A specified Range to replace
text	String	Required. The new text to use as a replacement

- EditSession.screenToDocumentColumn(screenRow, screenColumn)
- - Number
- Internal

- EditSession.screenToDocumentPosition(Number screenRow, Number screenColumn)
- - Object
- Related to EditSession.documentToScreenPosition

Converts characters coordinates on the screen to characters coordinates within the document. This takes into account code folding, word wrap, tab size, and any other visual modifications.

Arguments

screenRow	Number	Required. The screen row to check
screenColumn	Number	Required. The screen column to check

- EditSession.screenToDocumentRow(screenRow, screenColumn)
- - Number
- Internal

- EditSession.setAnnotations(Array annotations)

Sets annotations for the EditSession. This functions emits the 'changeAnnotation' event.

Arguments

annotations	Array	Required. A list of annotations

- EditSession.setBreakpoint(Number row, String className)

Sets a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

Arguments

row	Number	Required. A row index
className	String	Required. Class of the breakpoint

- EditSession.setBreakpoints(Array rows)

Sets a breakpoint on every row number given by rows. This function also emites the 'changeBreakpoint' event.

Arguments

rows	Array	Required. An array of row indicies

- EditSession.setDocument(Document doc)

Sets the EditSession to point to a new Document. If a BackgroundTokenizer exists, it also points to doc.

Arguments

doc	Document	Required. The new `Document` to use

- EditSession.setMode(TextMode mode)

Sets a new text mode for the EditSession. This method also emits the 'changeMode' event. If a BackgroundTokenizer is set, the 'tokenizerUpdate' event is also emitted.

Arguments

mode	TextMode	Required. Set a new text mode

- EditSession.setNewLineMode(String newLineMode)
- Related to Document.setNewLineMode

Sets the new line mode.

Arguments

newLineMode	String	Required. The newline mode to use; can be either `windows`, `unix`, or `auto`

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

Arguments

overwrite	Boolean	Required. Defines wheter or not to set overwrites

- EditSession.setScrollLeft(scrollLeft)

Sets the value of the distance between the left of the editor and the leftmost part of the visible content.

- EditSession.setScrollTop(Number scrollTop)

This function sets the scroll top value. It also emits the 'changeScrollTop' event.

Arguments

scrollTop	Number	Required. The new scroll top value

- EditSession.setTabSize(Number tabSize)

Set the number of spaces that define a soft tab; for example, passing in 4 transforms the soft tabs to be equivalent to four spaces. This function also emits the changeTabSize event.

Arguments

tabSize	Number	Required. The new tab size

- EditSession.setUndoManager(UndoManager undoManager)

Sets the undo manager.

Arguments

undoManager	UndoManager	Required. The new undo manager

- EditSession.setUndoSelect(Boolean enable)

ENables or disables highlighting of the range where an undo occured.

Arguments

enable	Boolean	Required. If `true`, selects the range of the reinserted change

- EditSession.setUseSoftTabs(Boolean useSoftTabs)

Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character ('\t').

Arguments

useSoftTabs	Boolean	Required. Value indicating whether or not to use soft tabs

- EditSession.setUseWorker(Boolean useWorker)

Identifies if you want to use a worker for the EditSession.

Arguments

useWorker	Boolean	Required. Set to `true` to use a worker

- EditSession.setUseWrapMode(Boolean useWrapMode)

Sets whether or not line wrapping is enabled. If useWrapMode is different than the current value, the 'changeWrapMode' event is emitted.

Arguments

useWrapMode	Boolean	Required. Enable (or disable) wrap mode

- EditSession.setValue(String text)

Sets the session text.

Arguments

text	String	Required. The new text to place

- EditSession.setWrapLimitRange(Number min, Number max)

Sets the boundaries of wrap. Either value can be null to have an unconstrained wrap, or, they can be the same number to pin the limit. If the wrap limits for min or max are different, this method also emits the 'changeWrapMode' event.

Arguments

min	Number	Required. The minimum wrap value (the left side wrap)
max	Number	Required. The maximum wrap value (the right side wrap)

- EditSession.stopWorker()
- Internal

- EditSession.toggleOverwrite()

Sets the value of overwrite to the opposite of whatever it currently is.

- EditSession.toString()
- - String
- Aliased as: EditSession.getValue

Returns the current Document as a string.

- EditSession.undoChanges(Array deltas, Boolean dontSelect)
- - Range

Reverts previous changes to your document.

Arguments

deltas	Array	Required. An array of previous changes
dontSelect	Boolean	Required. If `true`, doesn't select the range of where the change occured

Ace Reference

EditSession[edit]

Constructors

Arguments

Events

Methods

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments