class TextEditor

The variant used to style the ListView child component in a theme.

Creates a new TextEditor object.

Indicates if the user is allowed to toggle breakpoints by clicking inside a line's gutter.

Defines sets of auto-closing character pairs for the current language.

The default background skin to display behind the text editor's content.

The opening and closing strings that define a block comment. The array must contain exactly two items. The first item is the opening string of the block comment, and the second item is the closing string of the block comment.

Defines sets of brackets for the current language.

Each item in the Array must be an Array<String> containing exactly two items. The first item is the opening bracket, and the second item is the closing bracket.

The current set of breakpoints.

The character index of the caret.

To set caretCharIndex, use setSelection() with both char values equal

The data displayed for the line where the caret is currently located.

The line index of the caret.

To set caretLineIndex, use setSelection() with both char values equal

A custom variant to set on the text line renderers.

The line index where the debugger is currently stopped. If the debugger is not currently stopped on a line, the value is -1.

The default lineDelimeter to use when none can be detected.

The background skin to display behind the text editor's content when the text editor is disabled.

Indicates if the file has been edited.

Determines if an embedded font is used for the text displayed by the text editor.

Used by the SelectionManager for smarter caret placement when moving the caret between multiple lines.

The width of the gutter to the left of the lines.

Indicates if there is currently a selected range.

See also:

• TextEditor.selectedText

• TextEditor.selectionStartLineIndex

• TextEditor.selectionStartCharIndex

• TextEditor.selectionEndLineIndex

• TextEditor.selectionEndCharIndex

Indicates if a special background appears behind all results when find() is called.

Determines if the tab key should insert spaces instead of the tab \t character.

See also:

• TextEditor.tabWidth

The string that defines the start of a line comment.

The string used to indicate line breaks. May be \n, \r, or \r\n.

The height of each line, measured in pixels, if wordWrap is false. When wordWrap is true, lines may have different heights.

Allows the width of line numbers to be set to an exact value, instead of being calculated dynamically.

The current scroll position, as measured in lines.

The text divided into lines, with extra metadata.

Determines if Keyboard.HOME and Keyboard.END behave like native macOS text editors (scroll to top or bottom, without changing the cursor position), or if they change the cursor position to the beginning or end of the current line (like most code editors).

The maximum value currently allowed for lineScrollY.

The maximum value currently allowed for scrollX.

The maximum value currently allowed for scrollY.

When the line number widths are calculated automatically, this is the minimum number of characters required for the calculation. This value is ignored if lineNumberWidth is set.

The minimum value currently allowed for scrollX.

The minimum value currently allowed for scrollY.

The code parser used for syntax highlighting.

Indicates if the editor allows editing or not.

The current horizontal scroll position, as measured in pixels.

The current vertical scroll position, as measured in pixels.

The currently selected text. If no text is selected, returns an empty string.

The character index of the end of the selection.

To set selectionEndCharIndex, call setSelection().

The line index of the end of the selection.

To set selectionEndLineIndex, call setSelection().

The character index of the start of the selection.

To set selectionStartCharIndex, call setSelection().

The line index of the start of the selection.

To set selectionStartLineIndex, call setSelection().

Determines if line numbers are displayed or not.

The number of spaces that make up a tab character.

The text to be displayed by the editor.

The text styles used for syntax highlighting. The key corresponds to the syntax identifiers from the parser.

The number of lines that are currently visible.

Determines if the lines wrap or scroll horizontally.

Warning: The wordWrap property is currently supported only when the readOnly property is true.

Used to customize how new TextLineModel objects are created.

Clears any result of find().

Searches for the specified String or EReg in the editor's text.

Makes the next find() result into the current result.

Must be called after find()

Returns the TextFormat for the parser's default context.

Returns the boundaries of the specified character index.

Similar to TextField.getCharBoundaries()

Gets the TextFormat for the specified text style id.

Returns the visible bounds of the view port.

Converts a Point in the local coordinate system to a TextEditorPosition object.

Removes the current selection.

Replaces all find() results with the specified text.

Must be called after find()

Replaces the current find() result with the specified text.

Must be called after find()

To be called when the file is saved. Updates the undo/redo manager appropriately.

Scrolls the view to display the caret, if it is not currently visible.

Selects the entire text.

Updates the code parser used for syntax highlighting.

Selects the specified range. If the start and end positions are the same, nothing will be selected, but the caret will move.

Used by SelectionManager to preserve the expanded caret char index.

Converts a TextEditorPosition object to a Point in the local coordinate sytem.

Toggles line comments for the currently selected lines (or the line with the caret, if no lines are selected).

Toggles a breakpoint at the specified line index. If no line index is specified, toggles a breakpoint at the current caret line index.

Toggles line comments for the currently selected lines (or the line with the caret, if no lines are selected).