MonacoEditor | Theia TypeDoc

Hierarchy

MonacoEditorServices
- MonacoEditor
  - MonacoDiffEditor

Implements

TextEditor

Index

Constructors

constructor

Accessors

Constructors

constructor

new MonacoEditor(uri: URI, document: MonacoEditorModel, node: HTMLElement, services: MonacoEditorServices, options?: MonacoEditor.IOptions, override?: EditorServiceOverrides): MonacoEditor

Overrides MonacoEditorServices.constructor
- Defined in packages/monaco/src/browser/monaco-editor.ts:97
Parameters
- uri: URI
- document: MonacoEditorModel
- node: HTMLElement
- services: MonacoEditorServices
- Optional options: MonacoEditor.IOptions
- Optional override: EditorServiceOverrides
Returns MonacoEditor

Properties

Protected _languageAutoDetected

_languageAutoDetected: boolean = true

Protected Readonly autoSizing

autoSizing: boolean

Protected Readonly contextKeyService

contextKeyService: ContextKeyService

Readonly document

document: MonacoEditorModel

Readonly documents

documents: Set<MonacoEditorModel> = ...

Protected editor

editor: IStandaloneCodeEditor

Protected Readonly m2p

m2p: MonacoToProtocolConverter

Protected Readonly maxHeight

maxHeight: number

Protected Readonly minHeight

minHeight: number

Readonly node

node: HTMLElement

Protected Readonly onCursorPositionChangedEmitter

onCursorPositionChangedEmitter: Emitter<Position> = ...

Readonly onDidResize

onDidResize: Event<null | Dimension> = ...

Protected Readonly onDocumentContentChangedEmitter

onDocumentContentChangedEmitter: Emitter<TextDocumentChangeEvent> = ...

Readonly onEncodingChanged

onEncodingChanged: Event<string> = ...

Protected Readonly onFocusChangedEmitter

onFocusChangedEmitter: Emitter<boolean> = ...

Readonly onLanguageChanged

onLanguageChanged: Event<string> = ...

Protected Readonly onLanguageChangedEmitter

onLanguageChangedEmitter: Emitter<string> = ...

Protected Readonly onMouseDownEmitter

onMouseDownEmitter: Emitter<EditorMouseEvent> = ...

Protected Readonly onResizeEmitter

onResizeEmitter: Emitter<null | Dimension> = ...

Protected Readonly onScrollChangedEmitter

onScrollChangedEmitter: Emitter<void> = ...

Protected Readonly onSelectionChangedEmitter

onSelectionChangedEmitter: Emitter<Range> = ...

Protected Readonly p2m

p2m: ProtocolToMonacoConverter

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Readonly uri

uri: URI

Accessors

cursor

get cursor(): Position
set cursor(cursor: Position): void

Implementation of TextEditor.cursor
- Defined in packages/monaco/src/browser/monaco-editor.ts:227
Returns Position
Implementation of TextEditor.cursor
- Defined in packages/monaco/src/browser/monaco-editor.ts:232
Parameters
- cursor: Position
Returns void

isReadonly

get isReadonly(): boolean

Implementation of TextEditor.isReadonly
- Defined in packages/monaco/src/browser/monaco-editor.ts:223
Returns boolean

languageAutoDetected

get languageAutoDetected(): boolean

- Defined in packages/monaco/src/browser/monaco-editor.ts:552
Returns boolean

onCursorPositionChanged

get onCursorPositionChanged(): Event<Position>

Implementation of TextEditor.onCursorPositionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:237
Returns Event<Position>

onDispose

get onDispose(): Event<void>

- Defined in packages/monaco/src/browser/monaco-editor.ts:215
Returns Event<void>

onDocumentContentChanged

get onDocumentContentChanged(): Event<TextDocumentChangeEvent>

Implementation of TextEditor.onDocumentContentChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:219
Returns Event<TextDocumentChangeEvent>

onFocusChanged

get onFocusChanged(): Event<boolean>

Implementation of TextEditor.onFocusChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:323
Returns Event<boolean>

onMouseDown

get onMouseDown(): Event<EditorMouseEvent>

Implementation of TextEditor.onMouseDown
- Defined in packages/monaco/src/browser/monaco-editor.ts:327
Returns Event<EditorMouseEvent>

onScrollChanged

get onScrollChanged(): Event<void>

Implementation of TextEditor.onScrollChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:254
Returns Event<void>

onSelectionChanged

get onSelectionChanged(): Event<Range>

Implementation of TextEditor.onSelectionChanged
- Defined in packages/monaco/src/browser/monaco-editor.ts:250
Returns Event<Range>

selection

get selection(): Range
set selection(selection: Range): void

Implementation of TextEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:241
Returns Range
Implementation of TextEditor.selection
- Defined in packages/monaco/src/browser/monaco-editor.ts:245
Parameters
- selection: Range
Returns void

Methods

Protected addHandlers

addHandlers(codeEditor: IStandaloneCodeEditor): void

- Defined in packages/monaco/src/browser/monaco-editor.ts:162
Parameters
- codeEditor: IStandaloneCodeEditor
Returns void

Protected autoresize

autoresize(): void

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

blur

blur(): void

Implementation of TextEditor.blur
- Defined in packages/monaco/src/browser/monaco-editor.ts:305
Returns void

Protected computeLayoutSize

computeLayoutSize(hostNode: HTMLElement, dimension: null | IDimension): IDimension

- Defined in packages/monaco/src/browser/monaco-editor.ts:394
Parameters
- hostNode: HTMLElement
- dimension: null | IDimension
Returns IDimension

Protected create

create(options?: IStandaloneEditorConstructionOptions | IStandaloneEditorConstructionOptions, override?: EditorServiceOverrides): Disposable

- Defined in packages/monaco/src/browser/monaco-editor.ts:131
Parameters
- Optional options: IStandaloneEditorConstructionOptions | IStandaloneEditorConstructionOptions
- Optional override: EditorServiceOverrides
Returns Disposable

createMoveToUri

createMoveToUri(resourceUri: URI): URI

Implementation of TextEditor.createMoveToUri
- Defined in packages/monaco/src/browser/monaco-editor.ts:579
Parameters
- resourceUri: URI
Returns URI

deltaDecorations

deltaDecorations(params: DeltaDecorationParams): string[]

Implementation of TextEditor.deltaDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:452
Parameters
- params: DeltaDecorationParams
Returns string[]

detectLanguage

detectLanguage(): Promise<void>

Implementation of TextEditor.detectLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:556
Returns Promise<void>

dispose

dispose(): void

Implementation of TextEditor.dispose
- Defined in packages/monaco/src/browser/monaco-editor.ts:352
Returns void

executeEdits

executeEdits(edits: TextEdit[]): boolean

Implementation of TextEditor.executeEdits
- Defined in packages/monaco/src/browser/monaco-editor.ts:537
Parameters
- edits: TextEdit[]
Returns boolean

Protected fireLanguageChanged

fireLanguageChanged(languageId: string): void

- Defined in packages/monaco/src/browser/monaco-editor.ts:571
Parameters
- languageId: string
Returns void

focus

focus(): void

Implementation of TextEditor.focus
- Defined in packages/monaco/src/browser/monaco-editor.ts:291
Returns void

Protected fromMarkdownToString

fromMarkdownToString(maybeMarkdown?: null | string | IMarkdownString | IMarkdownString[]): undefined | string

- Defined in packages/monaco/src/browser/monaco-editor.ts:479
Parameters
- Optional maybeMarkdown: null | string | IMarkdownString | IMarkdownString[]
Returns undefined | string

Protected fromStringToMarkdownString

fromStringToMarkdownString(hoverMessage?: string | IMarkdownString | IMarkdownString[]): undefined | IMarkdownString | IMarkdownString[]

- Defined in packages/monaco/src/browser/monaco-editor.ts:472
Parameters
- Optional hoverMessage: string | IMarkdownString | IMarkdownString[]
Returns undefined | IMarkdownString | IMarkdownString[]

getControl

getControl(): IStandaloneCodeEditor

- Defined in packages/monaco/src/browser/monaco-editor.ts:361
Returns IStandaloneCodeEditor

getEncoding

getEncoding(): string

Implementation of TextEditor.getEncoding
- Defined in packages/monaco/src/browser/monaco-editor.ts:123
Returns string

Protected getHeight

getHeight(hostNode: HTMLElement, boxSizing: IBoxSizing): number

- Defined in packages/monaco/src/browser/monaco-editor.ts:415
Parameters
- hostNode: HTMLElement
- boxSizing: IBoxSizing
Returns number

Protected getInstantiatorWithOverrides

getInstantiatorWithOverrides(override?: EditorServiceOverrides): IInstantiationService

- Defined in packages/monaco/src/browser/monaco-editor.ts:153
Parameters
- Optional override: EditorServiceOverrides
Returns IInstantiationService

getLinesDecorations

getLinesDecorations(startLineNumber: number, endLineNumber: number): (EditorDecoration & Readonly<{ id: string }>)[]

Implementation of TextEditor.getLinesDecorations
- Defined in packages/monaco/src/browser/monaco-editor.ts:492
Parameters
- startLineNumber: number
- endLineNumber: number
Returns (EditorDecoration & Readonly<{ id: string }>)[]

getResourceUri

getResourceUri(): URI

Implementation of TextEditor.getResourceUri
- Defined in packages/monaco/src/browser/monaco-editor.ts:576
Returns URI

getVisibleColumn

getVisibleColumn(position: Position): number

Implementation of TextEditor.getVisibleColumn
- Defined in packages/monaco/src/browser/monaco-editor.ts:517
Parameters
- position: Position
Returns number

getVisibleRanges

getVisibleRanges(): Range[]

Implementation of TextEditor.getVisibleRanges
- Defined in packages/monaco/src/browser/monaco-editor.ts:203
Returns Range[]

Protected getWidth

getWidth(hostNode: HTMLElement, boxSizing: IBoxSizing): number

- Defined in packages/monaco/src/browser/monaco-editor.ts:411
Parameters
- hostNode: HTMLElement
- boxSizing: IBoxSizing
Returns number

isActionSupported

isActionSupported(id: string): boolean

- Defined in packages/monaco/src/browser/monaco-editor.ts:440
Parameters
- id: string
Returns boolean

isFindWidgetVisible

isFindWidgetVisible(): boolean

- Defined in packages/monaco/src/browser/monaco-editor.ts:341
true if the find (and replace) widget is visible in the editor. Otherwise, false.

Returns boolean

isFocused

isFocused(__namedParameters?: { strict: boolean }): boolean

Implementation of TextEditor.isFocused
- Defined in packages/monaco/src/browser/monaco-editor.ts:313
Parameters
- __namedParameters: { strict: boolean } = ...
  - strict: boolean
Returns boolean

isRenameInputVisible

isRenameInputVisible(): boolean

- Defined in packages/monaco/src/browser/monaco-editor.ts:348
true if the name rename refactoring input HTML element is visible. Otherwise, false.

Returns boolean

isSuggestWidgetVisible

isSuggestWidgetVisible(): boolean

- Defined in packages/monaco/src/browser/monaco-editor.ts:334
true if the suggest widget is visible in the editor. Otherwise, false.

Returns boolean

Protected mapModelContentChange

mapModelContentChange(change: IModelContentChange): TextDocumentContentChangeDelta

- Defined in packages/monaco/src/browser/monaco-editor.ts:207
Parameters
- change: IModelContentChange
Returns TextDocumentContentChangeDelta

refresh

refresh(): void

Implementation of TextEditor.refresh
- Defined in packages/monaco/src/browser/monaco-editor.ts:365
Returns void

replaceText

replaceText(params: ReplaceTextParams): Promise<boolean>

Implementation of TextEditor.replaceText
- Defined in packages/monaco/src/browser/monaco-editor.ts:521
Parameters
- params: ReplaceTextParams
Returns Promise<boolean>

Protected resize

resize(dimension: null | Dimension): void

- Defined in packages/monaco/src/browser/monaco-editor.ts:387
Parameters
- dimension: null | Dimension
Returns void

resizeToFit

resizeToFit(): void

Implementation of TextEditor.resizeToFit
- Defined in packages/monaco/src/browser/monaco-editor.ts:369
Returns void

restoreViewState

restoreViewState(state: ICodeEditorViewState): void

Implementation of TextEditor.restoreViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:545
Parameters
- state: ICodeEditorViewState
Returns void

revealPosition

revealPosition(raw: Position, options?: RevealPositionOptions): void

Implementation of TextEditor.revealPosition
- Defined in packages/monaco/src/browser/monaco-editor.ts:258
Parameters
- raw: Position
- options: RevealPositionOptions = ...
Returns void

revealRange

revealRange(raw: Range, options?: RevealRangeOptions): void

Implementation of TextEditor.revealRange
- Defined in packages/monaco/src/browser/monaco-editor.ts:273
Parameters
- raw: Range
- options: RevealRangeOptions = ...
Returns void

runAction

runAction(id: string): Promise<void>

- Defined in packages/monaco/src/browser/monaco-editor.ts:445
Parameters
- id: string
Returns Promise<void>

setEncoding

setEncoding(encoding: string, mode: EncodingMode): Promise<void>

Implementation of TextEditor.setEncoding
- Defined in packages/monaco/src/browser/monaco-editor.ts:127
Parameters
- encoding: string
- mode: EncodingMode
Returns Promise<void>

setLanguage

setLanguage(languageId: string): void

Implementation of TextEditor.setLanguage
- Defined in packages/monaco/src/browser/monaco-editor.ts:565
Parameters
- languageId: string
Returns void

setSize

setSize(dimension: Dimension): void

Implementation of TextEditor.setSize
- Defined in packages/monaco/src/browser/monaco-editor.ts:375
Parameters
- dimension: Dimension
Returns void

storeViewState

storeViewState(): object

Implementation of TextEditor.storeViewState
- Defined in packages/monaco/src/browser/monaco-editor.ts:541
Returns object

Protected toDeltaDecorations

toDeltaDecorations(params: DeltaDecorationParams): IModelDeltaDecoration[]

- Defined in packages/monaco/src/browser/monaco-editor.ts:458
Parameters
- params: DeltaDecorationParams
Returns IModelDeltaDecoration[]

Protected toEditorDecoration

toEditorDecoration(decoration: IModelDecoration): EditorDecoration & Readonly<{ id: string }>

- Defined in packages/monaco/src/browser/monaco-editor.ts:502
Parameters
- decoration: IModelDecoration
Returns EditorDecoration & Readonly<{ id: string }>

trigger

trigger(source: string, handlerId: string, payload: any): void

- Defined in packages/monaco/src/browser/monaco-editor.ts:357
Parameters
- source: string
- handlerId: string
- payload: any
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

uri: URI

document: MonacoEditorModel

node: HTMLElement

services: MonacoEditorServices

Optional options: MonacoEditor.IOptions

Optional override: EditorServiceOverrides

Returns MonacoEditor

Properties

Protected _languageAutoDetected

Protected Readonly autoSizing

Protected Readonly contextKeyService

Readonly document

Readonly documents

Protected editor

Protected Readonly m2p

Protected Readonly maxHeight

Protected Readonly minHeight

Readonly node

Protected Readonly onCursorPositionChangedEmitter

Readonly onDidResize

Protected Readonly onDocumentContentChangedEmitter

Readonly onEncodingChanged

Protected Readonly onFocusChangedEmitter

Readonly onLanguageChanged

Protected Readonly onLanguageChangedEmitter

Protected Readonly onMouseDownEmitter

Protected Readonly onResizeEmitter

Protected Readonly onScrollChangedEmitter

Protected Readonly onSelectionChangedEmitter

Protected Readonly p2m

Protected Readonly toDispose

Readonly uri

Accessors

cursor

Returns Position

Parameters

cursor: Position

Returns void

isReadonly

Returns boolean

languageAutoDetected

Returns boolean

onCursorPositionChanged

Returns Event<Position>

onDispose

Returns Event<void>

onDocumentContentChanged

Returns Event<TextDocumentChangeEvent>

onFocusChanged

Returns Event<boolean>

onMouseDown

Returns Event<EditorMouseEvent>

onScrollChanged

Returns Event<void>

onSelectionChanged

Returns Event<Range>

selection

Returns Range

Parameters

selection: Range

Returns void

Methods

Protected addHandlers

Parameters

codeEditor: IStandaloneCodeEditor

Returns void

Protected autoresize

Returns void

blur

Returns void