Class: VscodeTextEditorImpl

ide/vscode/VscodeTextEditorImpl.VscodeTextEditorImpl

Implements

• TextEditor

Constructors

constructor

• new VscodeTextEditorImpl(id, ide, editor)

Parameters

Name	Type
id	string
ide	VscodeIDE
editor	TextEditor

Defined in

ide/vscode/VscodeTextEditorImpl.ts:28

Properties

document

• Readonly document: TextDocument

The document associated with this text editor. The document will be the same for the entire lifetime of this text editor.

Implementation of

TextEditor.document

Defined in

ide/vscode/VscodeTextEditorImpl.ts:26

---

id

• Readonly id: string

Unique identifier for this text editor

Implementation of

TextEditor.id

Accessors

isActive

• get isActive(): boolean

True if this text editor is active.

Returns

boolean

Implementation of

TextEditor.isActive

Defined in

ide/vscode/VscodeTextEditorImpl.ts:60

---

options

• get options(): TextEditorOptions

Text editor options.

Returns

TextEditorOptions

Implementation of

TextEditor.options

Defined in

ide/vscode/VscodeTextEditorImpl.ts:52

• set options(options): void

Text editor options.

Parameters

Name	Type
options	TextEditorOptions

Returns

void

Implementation of

TextEditor.options

Defined in

ide/vscode/VscodeTextEditorImpl.ts:56

---

selections

• get selections(): Selection[]

The selections in this text editor.

Returns

Selection[]

Implementation of

TextEditor.selections

Defined in

ide/vscode/VscodeTextEditorImpl.ts:40

• set selections(selections): void

The selections in this text editor.

Parameters

Name	Type
selections	Selection[]

Returns

void

Implementation of

TextEditor.selections

Defined in

ide/vscode/VscodeTextEditorImpl.ts:44

---

visibleRanges

• get visibleRanges(): Range[]

The current visible ranges in the editor (vertically). This accounts only for vertical scrolling, and not for horizontal scrolling.

Returns

Range[]

Implementation of

TextEditor.visibleRanges

Defined in

ide/vscode/VscodeTextEditorImpl.ts:48

---

vscodeEditor

• get vscodeEditor(): TextEditor

Returns

TextEditor

Defined in

ide/vscode/VscodeTextEditorImpl.ts:36

Methods

edit

▸ edit(callback, options?): Thenable<boolean>

Parameters

Name	Type
callback	(editBuilder: TextEditorEdit) => void
options?	Object
options.undoStopAfter	boolean
options.undoStopBefore	boolean

Returns

Thenable<boolean>

Defined in

ide/vscode/VscodeTextEditorImpl.ts:79

---

focus

▸ focus(): Promise<void>

Returns

Promise<void>

Defined in

ide/vscode/VscodeTextEditorImpl.ts:86

---

isEqual

▸ isEqual(other): boolean

Check if this text editor is equal to other.

Parameters

Name	Type
other	TextEditor

Returns

boolean

Implementation of

TextEditor.isEqual

Defined in

ide/vscode/VscodeTextEditorImpl.ts:64

---

openLink

▸ openLink(location): Promise<boolean>

Parameters

Name	Type
location	Range | Position

Returns

Promise<boolean>

Defined in

ide/vscode/VscodeTextEditorImpl.ts:90

---

revealRange

▸ revealRange(range): void

Parameters

Name	Type
range	Range

Returns

void

Defined in

ide/vscode/VscodeTextEditorImpl.ts:68

---

setDecorations

▸ setDecorations(decorationType, ranges): void

Parameters

Name	Type
decorationType	TextEditorDecorationType
ranges	readonly Range[]

Returns

void

Defined in

ide/vscode/VscodeTextEditorImpl.ts:72