Interface TextEditor

Navigatable provides an access to an URI of an underlying instance of Resource.

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;
    createMoveToUri(resourceUri: URI): undefined | URI;
    deltaDecorations(params: DeltaDecorationParams): string[];
    detectLanguage(): void;
    dispose(): void;
    executeEdits(edits: TextEdit[]): boolean;
    focus(): void;
    getEncoding(): string;
    getLinesDecorations(
        startLineNumber: number,
        endLineNumber: number,
    ): EditorDecoration[];
    getResourceUri(): undefined | URI;
    getVisibleColumn(position: Position): number;
    getVisibleRanges(): Range[];
    handleVisibilityChanged(nowVisible: boolean): void;
    isFocused(): boolean;
    refresh(): void;
    replaceText(params: ReplaceTextParams): Promise<boolean>;
    resizeToFit(): void;
    restoreViewState(state: object): void;
    revealPosition(position: Position, options?: RevealPositionOptions): void;
    revealRange(range: Range, options?: RevealRangeOptions): void;
    setEncoding(encoding: string, mode: EncodingMode): void;
    setLanguage(languageId: string): void;
    setSize(size: Dimension): void;
    shouldDisplayDirtyDiff(): boolean;
    storeViewState(): object;
}

Hierarchy (View Summary)

Implemented by

MonacoEditor

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

createMoveToUri

createMoveToUri(resourceUri: URI): undefined | URI
Creates a new URI to which this navigatable should moved based on the given target resource URI.
Parameters
- resourceUri: URI
Returns undefined | URI
Inherited from Navigatable.createMoveToUri
- Defined in packages/core/lib/browser/navigatable-types.d.ts:14

deltaDecorations

deltaDecorations(params: DeltaDecorationParams): 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

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from Disposable.dispose
- Defined in packages/core/lib/common/disposable.d.ts:6

executeEdits

executeEdits(edits: TextEdit[]): 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: number,
endLineNumber: number,
): 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

getResourceUri

getResourceUri(): undefined | URI
Return an underlying resource URI.

Returns undefined | URI
Inherited from Navigatable.getResourceUri
- Defined in packages/core/lib/browser/navigatable-types.d.ts:10

getVisibleColumn

getVisibleColumn(position: 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: boolean): 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: ReplaceTextParams): 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: object): void
Parameters
- state: object
Returns void
- Defined in packages/editor/src/browser/editor.ts:285

revealPosition

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

revealRange

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

setEncoding

setEncoding(encoding: string, mode: EncodingMode): 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: string): void
Parameters
- languageId: string
Returns void
- Defined in packages/editor/src/browser/editor.ts:288

setSize

setSize(size: Dimension): 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