Class MonacoEditorService

Hierarchy

StandaloneCodeEditorService
- MonacoEditorService

Index

Constructors

constructor

Constructors

constructor

new MonacoEditorService(
contextKeyService: IContextKeyService,
themeService: IThemeService,
): MonacoEditorService
Parameters
- contextKeyService: IContextKeyService
- themeService: IThemeService
Returns MonacoEditorService
Overrides StandaloneCodeEditorService.constructor
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:71

Properties

`Protected`_globalStyleSheet

_globalStyleSheet: null | GlobalStyleSheet

`Protected` `Readonly`_onDecorationTypeRegistered

_onDecorationTypeRegistered: Emitter<string>

`Readonly`_serviceBrand

_serviceBrand: undefined

`Protected` `Readonly`_store

_store: DisposableStore

`Readonly`onCodeEditorAdd

onCodeEditorAdd: Event<ICodeEditor>

`Readonly`onCodeEditorRemove

onCodeEditorRemove: Event<ICodeEditor>

onDecorationTypeRegistered

onDecorationTypeRegistered: Event<string>

`Readonly`onDidChangeTransientModelProperty

onDidChangeTransientModelProperty: Event<ITextModel>

`Readonly`onDiffEditorAdd

onDiffEditorAdd: Event<IDiffEditor>

`Readonly`onDiffEditorRemove

onDiffEditorRemove: Event<IDiffEditor>

`Readonly`onWillCreateCodeEditor

onWillCreateCodeEditor: Event<void>

`Readonly`onWillCreateDiffEditor

onWillCreateDiffEditor: Event<void>

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`preferencesService

preferencesService: PreferenceService

`Protected` `Readonly`shell

shell: ApplicationShell

`Static` `Readonly`ENABLE_PREVIEW_PREFERENCE

ENABLE_PREVIEW_PREFERENCE: string = 'editor.enablePreview'

`Static` `Readonly`None

None: Readonly<IDisposable>

A disposable that does nothing when it is disposed of.

TODO: This should not be a static property.

Methods

`Protected`_createGlobalStyleSheet

_createGlobalStyleSheet(): GlobalStyleSheet
Returns GlobalStyleSheet
Inherited from StandaloneCodeEditorService._createGlobalStyleSheet
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:46

`Protected`_register

_register<T extends IDisposable>(o: T): T
Adds o to the collection of disposables managed by this object.
Type Parameters
- T extends IDisposable
Parameters
- o: T
Returns T
Inherited from StandaloneCodeEditorService._register
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/base/common/lifecycle.d.ts:142

_removeEditorStyleSheets

_removeEditorStyleSheets(editorId: string): void
Parameters
- editorId: string
Returns void
Inherited from StandaloneCodeEditorService._removeEditorStyleSheets
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:48

_removeWatcher

_removeWatcher(w: ModelTransientSettingWatcher): void
Parameters
- w: ModelTransientSettingWatcher
Returns void
Inherited from StandaloneCodeEditorService._removeWatcher
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:61

addCodeEditor

addCodeEditor(editor: ICodeEditor): void
Parameters
- editor: ICodeEditor
Returns void
Inherited from StandaloneCodeEditorService.addCodeEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:37

addDiffEditor

addDiffEditor(editor: IDiffEditor): void
Parameters
- editor: IDiffEditor
Returns void
Inherited from StandaloneCodeEditorService.addDiffEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:41

`Protected`createEditorOpenerOptions

createEditorOpenerOptions(
    input: IResourceEditorInput | ITextResourceEditorInput,
    source: null | ICodeEditor,
    sideBySide?: boolean,
): EditorOpenerOptions
Parameters
- input: IResourceEditorInput | ITextResourceEditorInput
- source: null | ICodeEditor
- OptionalsideBySide: boolean
Returns EditorOpenerOptions
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:130

dispose

dispose(): void
Returns void
Inherited from StandaloneCodeEditorService.dispose
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/base/common/lifecycle.d.ts:138

`Protected`findEditorWidgetByUri

findEditorWidgetByUri(
widget: undefined | object,
uriAsString: string,
): Promise<undefined | EditorWidget>
Parameters
- widget: undefined | object
- uriAsString: string
Returns Promise<undefined | EditorWidget>
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:112

getActiveCodeEditor

getActiveCodeEditor(): null | ICodeEditor
Monaco active editor is either focused or last focused editor.

Returns null | ICodeEditor
Overrides StandaloneCodeEditorService.getActiveCodeEditor
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:78

`Protected`getEditorOpenMode

getEditorOpenMode(input: IResourceEditorInput): WidgetOpenMode
Parameters
- input: IResourceEditorInput
Returns WidgetOpenMode
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:144

getFocusedCodeEditor

getFocusedCodeEditor(): null | ICodeEditor
Returns the current focused code editor (if the focus is in the editor or in an editor widget) or null.

Returns null | ICodeEditor
Inherited from StandaloneCodeEditorService.getFocusedCodeEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:44

getModelProperty

getModelProperty(resource: URI, key: string): any
Parameters
- resource: URI
- key: string
Returns any
Inherited from StandaloneCodeEditorService.getModelProperty
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:57

`Protected`getSelection

getSelection(
input: IResourceEditorInput | ITextResourceEditorInput,
): undefined | RecursivePartial<Range>
Parameters
- input: IResourceEditorInput | ITextResourceEditorInput
Returns undefined | RecursivePartial<Range>
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:138

getTransientModelProperties

getTransientModelProperties(model: ITextModel): undefined | [string, any][]
Parameters
- model: ITextModel
Returns undefined | [string, any][]
Inherited from StandaloneCodeEditorService.getTransientModelProperties
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:60

getTransientModelProperty

getTransientModelProperty(model: ITextModel, key: string): any
Parameters
- model: ITextModel
- key: string
Returns any
Inherited from StandaloneCodeEditorService.getTransientModelProperty
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:59

`Protected`getWidgetOptions

getWidgetOptions(
source: null | ICodeEditor,
sideBySide?: boolean,
): undefined | ApplicationShell.WidgetOptions
Parameters
- source: null | ICodeEditor
- OptionalsideBySide: boolean
Returns undefined | ApplicationShell.WidgetOptions
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:156

listCodeEditors

listCodeEditors(): ICodeEditor[]
Returns ICodeEditor[]
Inherited from StandaloneCodeEditorService.listCodeEditors
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:39

listDecorationTypes

listDecorationTypes(): string[]
Returns string[]
Inherited from StandaloneCodeEditorService.listDecorationTypes
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:50

listDiffEditors

listDiffEditors(): IDiffEditor[]
Returns IDiffEditor[]
Inherited from StandaloneCodeEditorService.listDiffEditors
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:43

openCodeEditor

openCodeEditor(
    input: IResourceEditorInput,
    source: null | ICodeEditor,
    sideBySide?: boolean,
): Promise<null | ICodeEditor>
Parameters
- input: IResourceEditorInput
- source: null | ICodeEditor
- OptionalsideBySide: boolean
Returns Promise<null | ICodeEditor>
Overrides StandaloneCodeEditorService.openCodeEditor
- Defined in packages/monaco/src/browser/monaco-editor-service.ts:101

registerCodeEditorOpenHandler

registerCodeEditorOpenHandler(handler: ICodeEditorOpenHandler): IDisposable
Parameters
- handler: ICodeEditorOpenHandler
Returns IDisposable
Inherited from StandaloneCodeEditorService.registerCodeEditorOpenHandler
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:64

registerDecorationType

registerDecorationType(
    description: string,
    key: string,
    options: IDecorationRenderOptions,
    parentTypeKey?: string,
    editor?: ICodeEditor,
): IDisposable
Parameters
- description: string
- key: string
- options: IDecorationRenderOptions
- OptionalparentTypeKey: string
- Optionaleditor: ICodeEditor
Returns IDisposable
Inherited from StandaloneCodeEditorService.registerDecorationType
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:49

removeCodeEditor

removeCodeEditor(editor: ICodeEditor): void
Parameters
- editor: ICodeEditor
Returns void
Inherited from StandaloneCodeEditorService.removeCodeEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:38

removeDecorationType

removeDecorationType(key: string): void
Parameters
- key: string
Returns void
Inherited from StandaloneCodeEditorService.removeDecorationType
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:51

removeDiffEditor

removeDiffEditor(editor: IDiffEditor): void
Parameters
- editor: IDiffEditor
Returns void
Inherited from StandaloneCodeEditorService.removeDiffEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:42

resolveDecorationCSSRules

resolveDecorationCSSRules(decorationTypeKey: string): null | CSSRuleList
Parameters
- decorationTypeKey: string
Returns null | CSSRuleList
Inherited from StandaloneCodeEditorService.resolveDecorationCSSRules
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:53

resolveDecorationOptions

resolveDecorationOptions(
decorationTypeKey: string,
writable: boolean,
): IModelDecorationOptions
Parameters
- decorationTypeKey: string
- writable: boolean
Returns IModelDecorationOptions
Inherited from StandaloneCodeEditorService.resolveDecorationOptions
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:52

setActiveCodeEditor

setActiveCodeEditor(activeCodeEditor: null | ICodeEditor): void
Parameters
- activeCodeEditor: null | ICodeEditor
Returns void
Inherited from StandaloneCodeEditorService.setActiveCodeEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/standalone/browser/standaloneCodeEditorService.d.ts:10

setModelProperty

setModelProperty(resource: URI, key: string, value: any): void
Parameters
- resource: URI
- key: string
- value: any
Returns void
Inherited from StandaloneCodeEditorService.setModelProperty
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:56

setTransientModelProperty

setTransientModelProperty(model: ITextModel, key: string, value: any): void
Parameters
- model: ITextModel
- key: string
- value: any
Returns void
Inherited from StandaloneCodeEditorService.setTransientModelProperty
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:58

willCreateCodeEditor

willCreateCodeEditor(): void
Returns void
Inherited from StandaloneCodeEditorService.willCreateCodeEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:36

willCreateDiffEditor

willCreateDiffEditor(): void
Returns void
Inherited from StandaloneCodeEditorService.willCreateDiffEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/browser/services/abstractCodeEditorService.d.ts:40

Class MonacoEditorService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MonacoEditorService

Properties

Protected_globalStyleSheet

Protected Readonly_onDecorationTypeRegistered

Readonly_serviceBrand

Protected Readonly_store

Protected ReadonlyactiveMonacoEditorContribution

Protected Readonlyeditors

Protected Readonlym2p

ReadonlyonCodeEditorAdd

ReadonlyonCodeEditorRemove

onDecorationTypeRegistered

ReadonlyonDidChangeTransientModelProperty

ReadonlyonDiffEditorAdd

ReadonlyonDiffEditorRemove

ReadonlyonWillCreateCodeEditor

ReadonlyonWillCreateDiffEditor

Protected ReadonlyopenerService

Protected ReadonlypreferencesService

Protected Readonlyshell

Static ReadonlyENABLE_PREVIEW_PREFERENCE

Static ReadonlyNone

Methods

Protected_createGlobalStyleSheet

Returns GlobalStyleSheet

Protected_register

Type Parameters

Parameters

Returns T

_removeEditorStyleSheets

Parameters

Returns void

_removeWatcher

Parameters

Returns void

addCodeEditor

Parameters

Returns void

addDiffEditor

Parameters

Returns void

ProtectedcreateEditorOpenerOptions

Parameters

Returns EditorOpenerOptions

dispose

Returns void

ProtectedfindEditorWidgetByUri

Parameters

Returns Promise<undefined | EditorWidget>

getActiveCodeEditor

Returns null | ICodeEditor

ProtectedgetEditorOpenMode

Parameters

Returns WidgetOpenMode

getFocusedCodeEditor

Returns null | ICodeEditor

getModelProperty

Parameters

Returns any

ProtectedgetSelection

Parameters

Returns undefined | RecursivePartial<Range>

getTransientModelProperties

Parameters

Returns undefined | [string, any][]

getTransientModelProperty

Parameters

Returns any

ProtectedgetWidgetOptions

Parameters

Returns undefined | ApplicationShell.WidgetOptions

`Protected`_globalStyleSheet

`Protected` `Readonly`_onDecorationTypeRegistered

`Readonly`_serviceBrand

`Protected` `Readonly`_store

`Protected` `Readonly`activeMonacoEditorContribution

`Protected` `Readonly`editors

`Protected` `Readonly`m2p

`Readonly`onCodeEditorAdd

`Readonly`onCodeEditorRemove

`Readonly`onDidChangeTransientModelProperty

`Readonly`onDiffEditorAdd

`Readonly`onDiffEditorRemove

`Readonly`onWillCreateCodeEditor

`Readonly`onWillCreateDiffEditor

`Protected` `Readonly`openerService

`Protected` `Readonly`preferencesService

`Protected` `Readonly`shell

`Static` `Readonly`ENABLE_PREVIEW_PREFERENCE

`Static` `Readonly`None

`Protected`_createGlobalStyleSheet

`Protected`_register

`Protected`createEditorOpenerOptions

`Protected`findEditorWidgetByUri

`Protected`getEditorOpenMode

`Protected`getSelection

`Protected`getWidgetOptions