TextEditor

Calls your callback when the buffer's title has changed.

Calls your callback when the buffer's path, and therefore title, has changed.

Invoke the given callback synchronously when the content of the buffer changes.

Because observers are invoked synchronously, it's important not to perform any expensive operations via this method. Consider TextEditor::onDidStopChanging to delay expensive operations until after changes stop occurring.

Invoke callback when the buffer's contents change. It is emit asynchronously 300ms after the last buffer change. This is a good place to handle changes to the buffer without compromising typing performance.

Calls your callback when a Cursor is moved. If there are multiple cursors, your callback will be called for each cursor.

Calls your callback when a selection's screen range changes.

Calls your callback when soft wrap was enabled or disabled.

Calls your callback when the buffer's encoding has changed.

Calls your callback when the grammar that interprets and colorizes the text has been changed. Immediately calls your callback with the current grammar.

Calls your callback when the grammar that interprets and colorizes the text has been changed.

Calls your callback when the result of TextEditor::isModified changes.

Calls your callback when the buffer's underlying file changes on disk at a moment when the result of TextEditor::isModified is true.

Calls your callback before text has been inserted.

Calls your callback after text has been inserted.

Invoke the given callback after the buffer is saved to disk.

Invoke the given callback when the editor is destroyed.

Calls your callback when a Cursor is added to the editor. Immediately calls your callback for each existing cursor.

Calls your callback when a Cursor is added to the editor.

Calls your callback when a Cursor is removed from the editor.

Calls your callback when a Selection is added to the editor. Immediately calls your callback for each existing selection.

Calls your callback when a Selection is added to the editor.

Calls your callback when a Selection is removed from the editor.

Calls your callback with each Decoration added to the editor. Calls your callback immediately for any existing decorations.

Calls your callback when a Decoration is added to the editor.

Calls your callback when a Decoration is removed from the editor.

Calls your callback when the placeholder text is changed.

Calls your callback when a Gutter is added to the editor. Immediately calls your callback for each existing gutter.

Calls your callback when a Gutter is added to the editor.

Calls your callback when a Gutter is removed from the editor.

Retrieves the current TextBuffer.

Get the editor's title for display in other parts of the UI such as the tabs.

If the editor's buffer is saved, its title is the file name. If it is unsaved, its title is "untitled".

Get unique title for display in other parts of the UI, such as the window title.

If the editor's buffer is unsaved, its title is "untitled" If the editor's buffer is saved, its unique title is formatted as one of the following,

• "" when it is the only editing buffer with this file name.
• " — " when other buffers have this file name.

Set the character set encoding to use in this editor's text buffer.

Saves the editor's text buffer.

See TextBuffer::save for more details.

Saves the editor's text buffer as the given path.

See TextBuffer::saveAs for more details.

Get the text in the given Range in buffer coordinates.

Get the Range of the paragraph surrounding the most recently added cursor.

Replaces the entire contents of the buffer with the given String.

Set the text in the given Range in buffer coordinates.

For each selection, replace the selected text with the given text.

For each selection, replace the selected text with a newline.

For each selection, if the selection is empty, delete the character following the cursor. Otherwise delete the selected text.

For each selection, if the selection is empty, delete the character preceding the cursor. Otherwise delete the selected text.

Mutate the text of all the selections in a single transaction.

All the changes made inside the given Function can be reverted with a single call to TextEditor::undo.

For each selection, transpose the selected text.

If the selection is empty, the characters preceding and following the cursor are swapped. Otherwise, the selected characters are reversed.

Convert the selected text to upper case.

For each selection, if the selection is empty, converts the containing word to upper case. Otherwise convert the selected text to upper case.

Convert the selected text to lower case.

For each selection, if the selection is empty, converts the containing word to upper case. Otherwise convert the selected text to upper case.

Toggle line comments for rows intersecting selections.

If the current grammar doesn't support comments, does nothing.

For each cursor, insert a newline at beginning the following line.

For each cursor, insert a newline at the end of the preceding line.

For each selection, if the selection is empty, delete all characters of the containing word that precede the cursor. Otherwise delete the selected text.

Similar to TextEditor::deleteToBeginningOfWord, but deletes only back to the previous word boundary.

Similar to TextEditor::deleteToEndOfWord, but deletes only up to the next word boundary.

For each selection, if the selection is empty, delete all characters of the containing subword following the cursor. Otherwise delete the selected text.

For each selection, if the selection is empty, delete all characters of the containing subword following the cursor. Otherwise delete the selected text.

For each selection, if the selection is empty, delete all characters of the containing line that precede the cursor. Otherwise delete the selected text.

For each selection, if the selection is not empty, deletes the selection; otherwise, deletes all characters of the containing line following the cursor. If the cursor is already at the end of the line, deletes the following newline.

For each selection, if the selection is empty, delete all characters of the containing word following the cursor. Otherwise delete the selected text.

Delete all lines intersecting selections.

Undo the last change.

Redo the last change.

Batch multiple operations as a single undo/redo step.

Any group of operations that are logically grouped from the perspective of undoing and redoing should be performed in a transaction. If you want to abort the transaction, call TextEditor::abortTransaction to terminate the function's execution and revert any changes performed up to the abortion.

Abort an open transaction, undoing any operations performed so far within the transaction.

Create a pointer to the current state of the buffer for use with TextEditor::revertToCheckpoint and TextEditor::groupChangesSinceCheckpoint.

Revert the buffer to the state it was in when the given checkpoint was created.

The redo stack will be empty following this operation, so changes since the checkpoint will be lost. If the given checkpoint is no longer present in the undo history, no changes will be made to the buffer and this method will return false.

Group all changes since the given checkpoint into a single transaction for purposes of undo/redo.

If the given checkpoint is no longer present in the undo history, no grouping will be performed and this method will return false.

Convert a position in buffer-coordinates to screen-coordinates.

The position is clipped via TextEditor::clipBufferPosition prior to the conversion. The position is also clipped via TextEditor::clipScreenPosition following the conversion, which only makes a difference when options are supplied.

Convert a position in screen-coordinates to buffer-coordinates.

The position is clipped via TextEditor::clipScreenPosition prior to the conversion.

Convert a range in buffer-coordinates to screen-coordinates.

Convert a range in screen-coordinates to buffer-coordinates.

Clip the given Point to a valid position in the buffer.

If the given Point describes a position that is actually reachable by the cursor based on the current contents of the buffer, it is returned unchanged. If the Point does not describe a valid position, the closest valid position is returned instead.

Clip the start and end of the given range to valid positions in the buffer. See TextEditor::clipBufferPosition for more information.

Clip the given Point to a valid position on screen.

If the given Point describes a position that is actually reachable by the cursor based on the current contents of the screen, it is returned unchanged. If the Point does not describe a valid position, the closest valid position is returned instead.

Clip the start and end of the given range to valid positions on screen. See TextEditor::clipScreenPosition for more information.

Add a decoration that tracks a DisplayMarker. When the marker moves, is invalidated, or is destroyed, the decoration will be updated to reflect the marker's state.

The following are the supported decorations types:

• line: Adds the given CSS class to the lines overlapping the rows spanned by the marker.
• line-number: Adds the given CSS class to the line numbers overlapping the rows spanned by the marker
• text: Injects spans into all text overlapping the marked range, then adds the given class or style to these spans. Use this to manipulate the foreground color or styling of text in a range.
• highlight: Creates an absolutely-positioned .highlight div to the editor containing nested divs that cover the marked region. For example, when the user selects text, the selection is implemented with a highlight decoration. The structure of this highlight will be:

    <div class="highlight <your-class>">
      <!-- Will be one region for each row in the range. Spans 2 lines? There will be 2 regions. -->
      <div class="region"></div>
    </div>
  

• overlay: Positions the view associated with the given item at the head or tail of the given DisplayMarker, depending on the position property.
• gutter: Tracks a DisplayMarker in a Gutter. Gutter decorations are created by calling Gutter::decorateMarker on the desired Gutter instance.
• block: Positions the view associated with the given item before or after the row of the given DisplayMarker, depending on the position property. Block decorations at the same screen row are ordered by their order property.
• cursor: Render a cursor at the head of the DisplayMarker. If multiple cursor decorations are created for the same marker, their class strings and style objects are combined into a single cursor. This decoration type may be used to style existing cursors by passing in their markers or to render artificial cursors that don't actually exist in the model by passing a marker that isn't associated with a real cursor.

Add a decoration to every marker in the given marker layer. Can be used to decorate a large number of markers without having to create and manage many individual decorations.

Get all decorations.

Get all decorations of type 'line'.

Get all decorations of type 'line-number'.

Get all decorations of type 'highlight'.

Get all decorations of type 'overlay'.

Create a marker on the default marker layer with the given range in buffer coordinates. This marker will maintain its logical location as the buffer is changed, so if you mark a particular word, the marker will remain over that word even if the word's location in the buffer changes.

Create a marker on the default marker layer with the given range in screen coordinates. This marker will maintain its logical location as the buffer is changed, so if you mark a particular word, the marker will remain over that word even if the word's location in the buffer changes.

Create a marker on the default marker layer with the given buffer position and no tail. To group multiple markers together in their own private layer, see TextEditor::addMarkerLayer.

Create a marker on the default marker layer with the given screen position and no tail. To group multiple markers together in their own private layer, see TextEditor::addMarkerLayer.

Find all DisplayMarkers on the default marker layer that match the given properties.

This method finds markers based on the given properties. Markers can be associated with custom properties that will be compared with basic equality. In addition, there are several special properties that will be compared with the range of the markers rather than their properties.

Get the DisplayMarker on the default layer for the given marker id.

Get all DisplayMarkers on the default marker layer. Consider using TextEditor::findMarkers

Get the number of markers in the default marker layer.

Create a marker layer to group related markers.

Get a DisplayMarkerLayer by id.

Get the default DisplayMarkerLayer.

All marker APIs not tied to an explicit layer interact with this default layer.

Get the position of the most recently added cursor in buffer coordinates.

Get the position of all the cursor positions in buffer coordinates.

Move the cursor to the given position in buffer coordinates.

If there are multiple cursors, they will be consolidated to a single cursor.

Get a Cursor at given screen coordinates Point

Get the position of the most recently added cursor in screen coordinates.

Get the position of all the cursor positions in screen coordinates.

Move the cursor to the given position in screen coordinates.

If there are multiple cursors, they will be consolidated to a single cursor.

Add a cursor at the given position in buffer coordinates.

Add a cursor at the position in screen coordinates.

Move every cursor up one row in screen coordinates.

Move every cursor down one row in screen coordinates.

Move every cursor left one column.

Move every cursor right one column.

Move every cursor to the beginning of its line in buffer coordinates.

Move every cursor to the beginning of its line in screen coordinates.

Move every cursor to the first non-whitespace character of its line.

Move every cursor to the end of its line in buffer coordinates.

Move every cursor to the end of its line in screen coordinates.

Move every cursor to the beginning of its surrounding word.

Move every cursor to the end of its surrounding word.

Move every cursor to the top of the buffer.

If there are multiple cursors, they will be merged into a single cursor.

Move every cursor to the bottom of the buffer.

If there are multiple cursors, they will be merged into a single cursor.

Move every cursor to the beginning of the next word.

Move every cursor to the previous word boundary.

Move every cursor to the next word boundary.

Move every cursor to the previous subword boundary.

Move every cursor to the next subword boundary.

Move every cursor to the beginning of the next paragraph.

Move every cursor to the beginning of the previous paragraph.

Get an Array of all Cursors.

Get all Cursors, ordered by their position in the buffer instead of the order in which they were added.

Get the selected text of the most recently added selection.

Get the Range of the most recently added selection in buffer coordinates.

Get the Ranges of all selections in buffer coordinates.

The ranges are sorted by when the selections were added. Most recent at the end.

Set the selected range in buffer coordinates. If there are multiple selections, they are reduced to a single selection with the given range.

Set the selected ranges in buffer coordinates. If there are multiple selections, they are replaced by new selections with the given ranges.

Get the Range of the most recently added selection in screen coordinates.

Get the Ranges of all selections in screen coordinates.

The ranges are sorted by when the selections were added. Most recent at the end.

Set the selected range in screen coordinates. If there are multiple selections, they are reduced to a single selection with the given range.

Set the selected ranges in screen coordinates. If there are multiple selections, they are replaced by new selections with the given ranges.

Add a selection for the given range in buffer coordinates.

Add a selection for the given range in screen coordinates.

Select from the current cursor position to the given position in buffer coordinates.

This method may merge selections that end up intersecting.

Select from the current cursor position to the given position in screen coordinates.

This method may merge selections that end up intersecting.

Move the cursor of each selection one character upward while preserving the selection's tail position.

This method may merge selections that end up intersecting.

Move the cursor of each selection one character downward while preserving the selection's tail position.

This method may merge selections that end up intersecting.

Move the cursor of each selection one character leftward while preserving the selection's tail position.

This method may merge selections that end up intersecting.

Move the cursor of each selection one character rightward while preserving the selection's tail position.

This method may merge selections that end up intersecting.

Select from the top of the buffer to the end of the last selection in the buffer.

This method merges multiple selections into a single selection.

Selects from the top of the first selection in the buffer to the end of the buffer.

This method merges multiple selections into a single selection.

Select all text in the buffer.

This method merges multiple selections into a single selection.

Move the cursor of each selection to the beginning of its line while preserving the selection's tail position.

This method may merge selections that end up intersecting.

Move the cursor of each selection to the first non-whitespace character of its line while preserving the selection's tail position. If the cursor is already on the first character of the line, move it to the beginning of the line.

This method may merge selections that end up intersecting.

Move the cursor of each selection to the end of its line while preserving the selection's tail position.

This method may merge selections that end up intersecting.

Expand selections to the beginning of their containing word.

Operates on all selections. Moves the cursor to the beginning of the containing word while preserving the selection's tail position.

Expand selections to the end of their containing word.

Operates on all selections. Moves the cursor to the end of the containing word while preserving the selection's tail position.

For each selection, move its cursor to the preceding subword boundary while maintaining the selection's tail position.

This method may merge selections that end up intersecting.

For each selection, move its cursor to the next subword boundary while maintaining the selection's tail position.

This method may merge selections that end up intersecting.

For each cursor, select the containing line.

This method merges selections on successive lines.

Select the word surrounding each cursor.

For each selection, move its cursor to the preceding word boundary while maintaining the selection's tail position.

This method may merge selections that end up intersecting.

For each selection, move its cursor to the next word boundary while maintaining the selection's tail position.

This method may merge selections that end up intersecting.

Expand selections to the beginning of the next word.

Operates on all selections. Moves the cursor to the beginning of the next word while preserving the selection's tail position.

Expand selections to the beginning of the next paragraph.

Operates on all selections. Moves the cursor to the beginning of the next paragraph while preserving the selection's tail position.

Expand selections to the beginning of the next paragraph.

Operates on all selections. Moves the cursor to the beginning of the next paragraph while preserving the selection's tail position.

For each selection, select the syntax node that contains that selection.

Undo the effect of a preceding call to TextEditor::selectLargerSyntaxNode.

Select the range of the given marker if it is valid.

Get the most recently added Selection.

Get current Selections.

Get all Selections, ordered by their position in the buffer instead of the order in which they were added.

Determine if a given range in buffer coordinates intersects a selection.

Scan regular expression matches in the entire buffer, calling the given iterator function on each match.

::scan functions as the replace method as well via the replace

If you're programmatically modifying the results, you may want to try TextEditor::backwardsScanInBufferRange to avoid tripping over your own changes.

Scan regular expression matches in a given range, calling the given iterator function on each match.

Scan regular expression matches in a given range in reverse order, calling the given iterator function on each match.

Enable or disable soft tabs for this editor.

Toggle soft tabs for this editor

Get the on-screen length of tab characters.

Set the on-screen length of tab characters. Setting this to a Number This will override the editor.tabLength setting.

Determine if the buffer uses hard or soft tabs.

Get the text representing a single level of indent.

If soft tabs are enabled, the text is composed of N spaces, where N is the tab length. Otherwise the text is a tab character (\t).

Determine whether lines in this editor are soft-wrapped.

Enable or disable soft wrapping for this editor.

Toggle soft wrapping for this editor

Gets the column at which column will soft wrap

Get the indentation level of the given buffer row.

Determines how deeply the given row is indented based on the soft tabs and tab length settings of this editor. Note that if soft tabs are enabled and the tab length is 2, a row with 4 leading spaces would have an indentation level of 2.

Set the indentation level for the given buffer row.

Inserts or removes hard tabs or spaces based on the soft tabs and tab length settings of this editor in order to bring it to the given indentation level. Note that if soft tabs are enabled and the tab length is 2, a row with 4 leading spaces would have an indentation level of 2.

Indent rows intersecting selections by one level.

Outdent rows intersecting selections by one level.

Get the indentation level of the given line of text.

Determines how deeply the given line is indented based on the soft tabs and tab length settings of this editor. Note that if soft tabs are enabled and the tab length is 2, a row with 4 leading spaces would have an indentation level of 2.

Indent rows intersecting selections based on the grammar's suggested indent level.

Get the current Grammar of this editor.

Get the syntactic ScopeDescriptor for the given position in buffer coordinates. Useful with Config::get.

For example, if called with a position inside the parameter list of an anonymous CoffeeScript function, this method returns a ScopeDescriptor with the following scopes array: ["source.coffee", "meta.function.inline.coffee", "meta.parameters.coffee", "variable.parameter.function.coffee"]

Get the syntactic tree ScopeDescriptor for the given position in buffer coordinates or the syntactic ScopeDescriptor for TextMate language mode

For example, if called with a position inside the parameter list of a JavaScript class function, this method returns a ScopeDescriptor with the following syntax nodes array: ["source.js", "program", "expression_statement", "assignment_expression", "class", "class_body", "method_definition", "formal_parameters", "identifier"] if tree-sitter is used and the following scopes array: ["source.js"] if textmate is used

Get the range in buffer coordinates of all tokens surrounding the cursor that match the given scope selector.

For example, if you wanted to find the string surrounding the cursor, you could call editor.bufferRangeForScopeAtCursor(".string.quoted").

Get the range in buffer coordinates of all tokens surrounding the given position in buffer coordinates that match the given scope selector.

For example, if you wanted to find the string surrounding the cursor, you could call editor.bufferRangeForScopeAtPosition(".string.quoted", this.getCursorBufferPosition()).

Determine if the given row is entirely a comment

For each selection, copy the selected text.

For each selection, cut the selected text.

For each selection, replace the selected text with the contents of the clipboard.

If the clipboard contains the same number of selections as the current editor, each selection will be replaced with the content of the corresponding clipboard selection text.

For each selection, if the selection is empty, cut all characters of the containing screen line following the cursor. Otherwise cut the selected text.

For each selection, if the selection is empty, cut all characters of the containing buffer line following the cursor. Otherwise cut the selected text.

Fold the most recent cursor's row based on its indentation level.

The fold will extend from the nearest preceding line with a lower indentation level up to the nearest following row with a lower indentation level.

Unfold the most recent cursor's row by one level.

Fold the given row in buffer coordinates based on its indentation level.

If the given row is foldable, the fold will begin there. Otherwise, it will begin at the first foldable row preceding the given row.

Unfold all folds containing the given row in buffer coordinates.

For each selection, fold the rows it intersects.

Fold all foldable lines.

Unfold all existing folds.

Fold all foldable lines at the given indent level.

Determine whether the given row in buffer coordinates is foldable.

A foldable row is a row that starts a row range that can be folded.

Determine whether the given row in screen coordinates is foldable.

A foldable row is a row that starts a row range that can be folded.

Fold the given buffer row if it isn't currently folded, and unfold it otherwise.

Determine whether the most recently added cursor's row is folded.

Determine whether the given row in buffer coordinates is folded.

Determine whether the given row in screen coordinates is folded.

Add a custom Gutter.

Get this editor's gutters.

Get the gutter with the given name.

Scroll the editor to reveal the most recently added cursor if it is off-screen.

Scrolls the editor to the given buffer position.

Scrolls the editor to the given screen position.

Retrieves the greyed out placeholder of a mini editor.

Set the greyed out placeholder of a mini editor. Placeholder text will be displayed when the editor has no content.

Return information about the appropriate comment delimiters to use at a given point in the buffer.

Pulsar allows language bundles to define comment delimiters in several places. For instance, a grammar author can place delimiter metadata in the grammar definition file, or as scope-specific settings in the ordinary config system — or a combination of the two.

In some languages, comment delimiters vary based on position in the buffer. (For instance, line comments can't always be used in JavaScript JSX blocks, so block comments are much safer.) This method will look for any such overrides and return what it thinks are the best delimiters to use at a given point.

Some languages don't specify all their delimiters in their configuration, but this method will return all the information that it can discern.

• point - A Point or point-compatible Array.