Class TextEditorExt

Hierarchy

TextEditorExt

Implements

TextEditor

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TextEditorExt(proxy: TextEditorsMain, id: string, document: DocumentDataExt, _selections: Selection[], options: TextEditorConfiguration, _visibleRanges: Range[], viewColumn: undefined | Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine): TextEditorExt

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:30
Parameters
- proxy: TextEditorsMain
- id: string
- document: DocumentDataExt
- _selections: Selection[]
- options: TextEditorConfiguration
- _visibleRanges: Range[]
- viewColumn: undefined | Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine
Returns TextEditorExt

Properties

Private _document

_document: DocumentDataExt

Private _options

_options: TextEditorOptionsExt

Private _viewColumn

_viewColumn: undefined | Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine

Private disposed

disposed: boolean = false

Accessors

document

get document(): TextDocument
set document(doc: TextDocument): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:44
Returns TextDocument
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:48
Parameters
- doc: TextDocument
Returns void

options

get options(): TextEditorOptions
set options(val: TextEditorOptions): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:60
Returns TextEditorOptions
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:64
Parameters
- val: TextEditorOptions
Returns void

selection

get selection(): Selection
set selection(val: Selection): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:75
Returns Selection
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:79
Parameters
- val: Selection
Returns void

selections

get selections(): Selection[]
set selections(val: Selection[]): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:92
Returns Selection[]
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:96
Parameters
- val: Selection[]
Returns void

viewColumn

get viewColumn(): undefined | Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine
set viewColumn(value: undefined | Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:123
Returns undefined | Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:127
Parameters
- value: undefined | Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine
Returns void

visibleRanges

get visibleRanges(): Range[]
set visibleRanges(val: Range[]): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:110
Returns Range[]
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:114
Parameters
- val: Range[]
Returns void

Methods

_acceptViewColumn

_acceptViewColumn(value: ViewColumn): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:131
Parameters
- value: ViewColumn
Returns void

acceptOptions

acceptOptions(options: TextEditorConfiguration): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:70
Parameters
- options: TextEditorConfiguration
Returns void

acceptSelections

acceptSelections(selections: Selection[]): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:105
Parameters
- selections: Selection[]
Returns void

acceptViewColumn

acceptViewColumn(val: ViewColumn): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:52
Parameters
- val: ViewColumn
Returns void

acceptVisibleRanges

acceptVisibleRanges(range: Range[]): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:118
Parameters
- range: Range[]
Returns void

Private applyEdit

applyEdit(edit: TextEditorEdit): Promise<boolean>

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:207
Parameters
- edit: TextEditorEdit
Returns Promise<boolean>

dispose

dispose(): void

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:56
Returns void

edit

edit(callback: (editBuilder: TextEditorEdit) => void, options?: { undoStopAfter: boolean; undoStopBefore: boolean }): Promise<boolean>

Implementation of theia.TextEditor.edit
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:137
Parameters
- callback: (editBuilder: TextEditorEdit) => void
  - - (editBuilder: TextEditorEdit): void
    - Parameters
      - editBuilder: TextEditorEdit
      Returns void
- options: { undoStopAfter: boolean; undoStopBefore: boolean } = ...
  - undoStopAfter: boolean
  - undoStopBefore: boolean
Returns Promise<boolean>

insertSnippet

insertSnippet(snippet: SnippetString, location?: Position | Range | Range[] | Position[], options?: { undoStopAfter: boolean; undoStopBefore: boolean }): Promise<boolean>

Implementation of theia.TextEditor.insertSnippet
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:147
Parameters
- snippet: SnippetString
- Optional location: Position | Range | Range[] | Position[]
- options: { undoStopAfter: boolean; undoStopBefore: boolean } = ...
  - undoStopAfter: boolean
  - undoStopBefore: boolean
Returns Promise<boolean>

revealRange

revealRange(range: Range, revealType?: Default | InCenter | InCenterIfOutsideViewport | AtTop): void

Implementation of theia.TextEditor.revealRange
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:203
Parameters
- range: Range
- Optional revealType: Default | InCenter | InCenterIfOutsideViewport | AtTop
Returns void

Private runOnProxy

runOnProxy(callback: () => Promise<any>): Promise<undefined | TextEditorExt>

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:253
Parameters
- callback: () => Promise<any>
  - - (): Promise<any>
    - Returns Promise<any>
Returns Promise<undefined | TextEditorExt>

setDecorations

setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void

Implementation of theia.TextEditor.setDecorations
- Defined in packages/plugin-ext/src/plugin/text-editor.ts:176
Parameters
- decorationType: TextEditorDecorationType
- rangesOrOptions: Range[] | DecorationOptions[]
Returns void

Private trySetSelection

trySetSelection(): Promise<undefined | TextEditor>

- Defined in packages/plugin-ext/src/plugin/text-editor.ts:87
Returns Promise<undefined | TextEditor>