EditSession

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.

Constructors

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

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

Events

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

Emitted when the document changes.

• EditSession.on("changeAnnotation", function())

Emitted when an annotation changes, like through EditSession.setAnnotations().

• EditSession.on("changeBackMarker", function())

Emitted when a back marker changes.

• EditSession.on("changeBreakpoint", function())

Emitted when the gutter changes, either by setting or removing breakpoints, or when the gutter decorations change.

• EditSession.on("changeFold", function())

Emitted when a code fold is added or removed.

• EditSession.on("changeFrontMarker", function())

Emitted when a front marker changes.

• EditSession.on("changeMode", function())

Emitted when the current mode changes.

• EditSession.on("changeOverwrite", function())

Emitted when the ability to overwrite text changes, via EditSession.setOverwrite().

• EditSession.on("changeScrollLeft", function(Number scrollLeft))

Emitted when the scroll left changes.

• EditSession.on("changeScrollTop", function(Number scrollTop))

Emitted when the scroll top changes.

• EditSession.on("changeTabSize", function())

Emitted when the tab size changes, via EditSession.setTabSize().

• EditSession.on("changeWrapLimit", function())

Emitted when the wrapping limit changes.

• EditSession.on("changeWrapMode", function())

Emitted when the wrap mode changes.

• EditSession.on("tokenizerUpdate", function(Object e))

Emitted when a background tokenizer asynchronously processes new rows.

Methods

• EditSession.addDynamicMarker(Object marker, Boolean inFront)
• 返回值： Object

Adds a dynamic marker to the session.

• EditSession.addGutterDecoration(Number row, String className)

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

• EditSession.addMarker(Range range, String clazz, Function | String type, 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.

• 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 emits the 'changeBreakpoint' event.

• EditSession.clearBreakpoints()

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

• EditSession.documentToScreenColumn(Number row, Number docColumn)
• 返回值： Number

For the given document row and column, returns the screen column.

• EditSession.documentToScreenPosition(Number docRow, Number docColumn)
• 返回值： Object

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

• EditSession.documentToScreenRow(Number docRow, Number docColumn)

For the given document row and column, returns the screen row.

• EditSession.duplicateLines(Number firstRow, Number lastRow)
• 返回值： Number

Duplicates all the text between firstRow and lastRow.

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

• EditSession.getBreakpoints()
• 返回值： Number

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)

For the given document row and column, this returns the column position of the last screen row.

• EditSession.getDocumentLastRowColumnPosition(Number docRow, Number docColumn)

For the given document row and column, this returns the document position of the last row.

• EditSession.getLength()
• 返回值： Number

Returns the number of rows in the document.

• EditSession.getLine(Number row)
• 返回值： String

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

• EditSession.getLines(Number firstRow, Number lastRow)
• 返回值： String

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

• EditSession.getMarkers(Boolean inFront)
• 返回值： Array

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

• EditSession.getMode()
• 返回值： TextMode

Returns the current text mode.

• EditSession.getNewLineMode()
• 返回值： String

Returns the current new line mode.

• EditSession.getOverwrite()

Returns true if overwrites are enabled; false otherwise.

• EditSession.getRowLength(Number row)
• 返回值： Number

Returns number of screenrows in a wrapped line.

• EditSession.getRowSplitData(Object row)
• 返回值： String

For the given row, this returns the split data.

• EditSession.getScreenLastRowColumn(Number screenRow)
• 返回值： Number

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

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

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

Returns selection object.

• EditSession.getState(Number row)

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

• EditSession.getTabSize()

Returns the current tab size.

• EditSession.getTabString()

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

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

• EditSession.getTokenAt(Number row, Number column)

Returns an object indicating the token at the current row. The object has two properties: index and start.

• EditSession.getTokens(Number row)

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

• EditSession.getUndoManager()

Returns the current undo manager.

• EditSession.getUseSoftTabs()
• 返回值： Boolean

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

• EditSession.getUseWorker()

Returns true if workers are being used.

• EditSession.getUseWrapMode()
• 返回值： Boolean

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

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

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.

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

• Undocumented

• EditSession.highlightLines()

• Undocumented

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

• EditSession.insert(Object position, String text)
• 返回值： Object

Inserts a block of text and the indicated position.

• EditSession.isTabStop(Object position)

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

• EditSession.moveLinesDown(Number firstRow, Number lastRow)
• 返回值： Number

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

• EditSession.moveLinesUp(Number firstRow, Number lastRow)
• 返回值： Number

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

• EditSession.moveText(Range fromRange, Object toPosition)
• 返回值： Range

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 }

• EditSession.onChange()

• Undocumented

• EditSession.onChangeFold()

• Undocumented

• EditSession.onReloadTokenizer(Object e)

Reloads all the tokens on the current session. This function calls BackgroundTokenizer.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.

• EditSession.redo()

• Undocumented

• EditSession.redoChanges(Array deltas, Boolean dontSelect)
• 返回值： Range

Re-implements a previously undone change to your document.

• EditSession.remove(Range range)
• 返回值： Object

Removes the range from the document.

• EditSession.removeGutterDecoration(Number row, String className)

Removes className from the row.

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

• EditSession.replace(Range range, String text)
• 返回值： Object

Replaces a range in the document with the new text.

• EditSession.reset()

• Undocumented

• EditSession.resetCaches()

• Undocumented

• EditSession.screenToDocumentColumn()

• Undocumented

• EditSession.screenToDocumentPosition(Number screenRow, Number screenColumn)
• 返回值： Object

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.

• EditSession.screenToDocumentRow()

• Undocumented

• EditSession.setAnnotations(Array annotations)

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

• EditSession.setBreakpoint(Number row, String className)

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

• EditSession.setBreakpoints(Array rows)

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

• EditSession.setDocument(Document doc)

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

• EditSession.setMode()

• Undocumented

• EditSession.setNewLineMode(String newLineMode)

Sets the new line mode.

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

• EditSession.setScrollLeft(Object 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.

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

• EditSession.setUndoManager(UndoManager undoManager)

Sets the undo manager.

• EditSession.setUndoSelect(Boolean enable)

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

• 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').

• EditSession.setUseWorker(Boolean useWorker)

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

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

• EditSession.setValue(String text)

Sets the session text.

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

• EditSession.toggleOverwrite()

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

• EditSession.toString()
• 返回值： String

Returns the current Document as a string.

• EditSession.undo()

• Undocumented

• EditSession.undoChanges(Array deltas, Boolean dontSelect)
• 返回值： Range

Reverts previous changes to your document.