Interface TextEditor

interface TextEditor {
    cursor: Position;
    document: TextEditorDocument;
    isReadonly: boolean | MarkdownString;
    node: HTMLElement;
    onCursorPositionChanged: Event<Position>;
    onDidChangeReadOnly: Event<boolean | MarkdownString>;
    onDocumentContentChanged: Event<TextDocumentChangeEvent>;
    onEncodingChanged: Event<string>;
    onFocusChanged: Event<boolean>;
    onLanguageChanged: Event<string>;
    onMouseDown: Event<EditorMouseEvent>;
    onScrollChanged: Event<void>;
    onSelectionChanged: Event<Selection>;
    selection: Selection;
    uri: URI;
    blur(): void;
    deltaDecorations(params): string[];
    detectLanguage(): void;
    executeEdits(edits): boolean;
    focus(): void;
    getEncoding(): string;
    getLinesDecorations(startLineNumber, endLineNumber): EditorDecoration[];
    getVisibleColumn(position): number;
    getVisibleRanges(): Range[];
    isFocused(): boolean;
    refresh(): void;
    replaceText(params): Promise<boolean>;
    resizeToFit(): void;
    restoreViewState(state): void;
    revealPosition(position, options?): void;
    revealRange(range, options?): void;
    setEncoding(encoding, mode): void;
    setLanguage(languageId): void;
    setSize(size): void;
    shouldDisplayDirtyDiff(): boolean;
    storeViewState(): object;
}

Hierarchy (view full)

Disposable
TextEditorSelection
Navigatable
- TextEditor

Properties

cursor

cursor: Position

`Readonly` document

document: TextEditorDocument

`Readonly` isReadonly

isReadonly: boolean | MarkdownString

`Readonly` node

node: HTMLElement

`Readonly` onCursorPositionChanged

onCursorPositionChanged: Event<Position>

`Readonly` onDidChangeReadOnly

onDidChangeReadOnly: Event<boolean | MarkdownString>

`Readonly` onDocumentContentChanged

onDocumentContentChanged: Event<TextDocumentChangeEvent>

`Readonly` onEncodingChanged

onEncodingChanged: Event<string>

`Readonly` onFocusChanged

onFocusChanged: Event<boolean>

`Readonly` onLanguageChanged

onLanguageChanged: Event<string>

`Readonly` onMouseDown

onMouseDown: Event<EditorMouseEvent>

`Readonly` onScrollChanged

onScrollChanged: Event<void>

`Readonly` onSelectionChanged

onSelectionChanged: Event<Selection>

selection

selection: Selection

`Readonly` uri

uri: URI

Methods

blur

blur(): void
Returns void
- Defined in packages/editor/src/browser/editor.ts:227

deltaDecorations

deltaDecorations(params): string[]
Applies given new decorations, and removes old decorations identified by ids.
Parameters
- params: DeltaDecorationParams
Returns string[]
identifiers of applied decorations, which can be removed in next call.
- Defined in packages/editor/src/browser/editor.ts:254

detectLanguage

detectLanguage(): void
Returns void
- Defined in packages/editor/src/browser/editor.ts:281

executeEdits

executeEdits(edits): boolean
Execute edits on the editor.
Parameters
- edits: TextEdit[]
Returns boolean
- Defined in packages/editor/src/browser/editor.ts:276

focus

focus(): void
The text editor should be revealed, otherwise it won't receive the focus.

Returns void
- Defined in packages/editor/src/browser/editor.ts:226

getEncoding

getEncoding(): string
Gets the encoding of the input if known.

Returns string
- Defined in packages/editor/src/browser/editor.ts:288

getLinesDecorations

getLinesDecorations(startLineNumber, endLineNumber): EditorDecoration[]
Gets all the decorations for the lines between startLineNumber and endLineNumber as an array.
Parameters
- startLineNumber: number
  The start line number.
- endLineNumber: number
  The end line number.
Returns EditorDecoration[]
An array with the decorations.
- Defined in packages/editor/src/browser/editor.ts:262

getVisibleColumn

getVisibleColumn(position): number
Parameters
- position: Position
Returns number
- Defined in packages/editor/src/browser/editor.ts:264

getVisibleRanges

getVisibleRanges(): Range[]
Returns Range[]
- Defined in packages/editor/src/browser/editor.ts:234

isFocused

isFocused(): boolean
Returns boolean
- Defined in packages/editor/src/browser/editor.ts:228

refresh

refresh(): void
Rerender the editor.

Returns void
- Defined in packages/editor/src/browser/editor.ts:242

replaceText

replaceText(params): Promise<boolean>
Replaces the text of source given in ReplaceTextParams.
Parameters
- params: ReplaceTextParams
Returns Promise<boolean>
- Defined in packages/editor/src/browser/editor.ts:270

resizeToFit

resizeToFit(): void
Resize the editor to fit its node.

Returns void
- Defined in packages/editor/src/browser/editor.ts:246

restoreViewState

restoreViewState(state): void
Parameters
- state: object
Returns void
- Defined in packages/editor/src/browser/editor.ts:279

revealPosition

revealPosition(position, options?): void
Parameters
- position: Position
- Optional options: RevealPositionOptions
Returns void
- Defined in packages/editor/src/browser/editor.ts:236

revealRange

revealRange(range, options?): void
Parameters
- range: Range
- Optional options: RevealRangeOptions
Returns void
- Defined in packages/editor/src/browser/editor.ts:237

setEncoding

setEncoding(encoding, mode): void
Sets the encoding for the input for saving.
Parameters
- encoding: string
- mode: EncodingMode
Returns void
- Defined in packages/editor/src/browser/editor.ts:293

setLanguage

setLanguage(languageId): void
Parameters
- languageId: string
Returns void
- Defined in packages/editor/src/browser/editor.ts:282

setSize

setSize(size): void
Parameters
- size: Dimension
Returns void
- Defined in packages/editor/src/browser/editor.ts:247

shouldDisplayDirtyDiff

shouldDisplayDirtyDiff(): boolean
Returns boolean
- Defined in packages/editor/src/browser/editor.ts:297

storeViewState

storeViewState(): object
Returns object
- Defined in packages/editor/src/browser/editor.ts:278