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>;
    onShouldDisplayDirtyDiffChanged?: Event<boolean>;
    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[];
    handleVisibilityChanged(nowVisible): void;
    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>

`Optional` `Readonly` onShouldDisplayDirtyDiffChanged

onShouldDisplayDirtyDiffChanged?: Event<boolean>

This event is optional iff shouldDisplayDirtyDiff always returns the same result for this editor instance.

selection

selection: Selection

`Readonly` uri

uri: URI

Methods

blur

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

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:260

detectLanguage

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

executeEdits

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

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:232

getEncoding

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

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

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:268

getVisibleColumn

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

getVisibleRanges

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

handleVisibilityChanged

handleVisibilityChanged(nowVisible): void
Parameters
- nowVisible: boolean
Returns void
- Defined in packages/editor/src/browser/editor.ts:309

isFocused

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

refresh

refresh(): void
Rerender the editor.

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

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:276

resizeToFit

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

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

restoreViewState

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

revealPosition

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

revealRange

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

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:299

setLanguage

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

setSize

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

shouldDisplayDirtyDiff

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

storeViewState

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

Interface TextEditor

Hierarchy (view full)

Index

Properties

Methods

Properties

cursor

Readonly document

Readonly isReadonly

Readonly node

Readonly onCursorPositionChanged

Readonly onDidChangeReadOnly

Readonly onDocumentContentChanged

Readonly onEncodingChanged

Readonly onFocusChanged

Readonly onLanguageChanged

Readonly onMouseDown

Readonly onScrollChanged

Readonly onSelectionChanged

Optional Readonly onShouldDisplayDirtyDiffChanged

selection

Readonly uri

Methods

blur

Returns void

deltaDecorations

Parameters

Returns string[]

detectLanguage

Returns void

executeEdits

Parameters

Returns boolean

focus

Returns void

getEncoding

Returns string

getLinesDecorations

Parameters

Returns EditorDecoration[]

getVisibleColumn

Parameters

Returns number

getVisibleRanges

Returns Range[]

handleVisibilityChanged

Parameters

Returns void

isFocused

Returns boolean

refresh

Returns void

replaceText

Parameters

Returns Promise<boolean>

resizeToFit

Returns void

restoreViewState

Parameters

Returns void

revealPosition

Parameters

Returns void

revealRange

Parameters

Returns void

setEncoding

Parameters

Returns void

setLanguage

Parameters

Returns void

setSize

Parameters

Returns void

shouldDisplayDirtyDiff

Returns boolean

storeViewState

Returns object

Settings

`Readonly` document

`Readonly` isReadonly

`Readonly` node

`Readonly` onCursorPositionChanged

`Readonly` onDidChangeReadOnly

`Readonly` onDocumentContentChanged

`Readonly` onEncodingChanged

`Readonly` onFocusChanged

`Readonly` onLanguageChanged

`Readonly` onMouseDown

`Readonly` onScrollChanged

`Readonly` onSelectionChanged

`Optional` `Readonly` onShouldDisplayDirtyDiffChanged

`Readonly` uri