Class MonacoEditorProvider

Hierarchy

MonacoEditorProvider

Constructors

constructor

new MonacoEditorProvider(codeEditorService: MonacoEditorService, textModelService: MonacoTextModelService, contextMenuService: MonacoContextMenuService, m2p: MonacoToProtocolConverter, p2m: ProtocolToMonacoConverter, workspace: MonacoWorkspace, commandServiceFactory: MonacoCommandServiceFactory, editorPreferences: EditorPreferences, diffNavigatorFactory: MonacoDiffNavigatorFactory, applicationServer: ApplicationServer, contextKeyService: ContextKeyService): MonacoEditorProvider

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:101
Parameters
- codeEditorService: MonacoEditorService
- textModelService: MonacoTextModelService
- contextMenuService: MonacoContextMenuService
- m2p: MonacoToProtocolConverter
- p2m: ProtocolToMonacoConverter
- workspace: MonacoWorkspace
- commandServiceFactory: MonacoCommandServiceFactory
- editorPreferences: EditorPreferences
- diffNavigatorFactory: MonacoDiffNavigatorFactory
- applicationServer: ApplicationServer
- contextKeyService: ContextKeyService
Returns MonacoEditorProvider

Properties

Protected _current

_current: undefined | MonacoEditor

Protected Readonly applicationServer

applicationServer: ApplicationServer

Protected Readonly bulkEditService

bulkEditService: MonacoBulkEditService

Protected Readonly codeEditorService

codeEditorService: MonacoEditorService

Protected Readonly commandServiceFactory

commandServiceFactory: MonacoCommandServiceFactory

Protected Readonly contextKeyService

contextKeyService: ContextKeyService

Protected Readonly contextMenuService

contextMenuService: MonacoContextMenuService

Protected Readonly diffNavigatorFactory

diffNavigatorFactory: MonacoDiffNavigatorFactory

Protected Readonly editorPreferences

editorPreferences: EditorPreferences

Protected Readonly factories

factories: ContributionProvider<MonacoEditorFactory>

Protected Readonly filePreferences

filePreferences: FileSystemPreferences

Protected Readonly keybindingRegistry

keybindingRegistry: KeybindingRegistry

Protected Readonly m2p

m2p: MonacoToProtocolConverter

Protected Readonly openerService

openerService: OpenerService

Protected Readonly p2m

p2m: ProtocolToMonacoConverter

Protected Readonly quickInputService

quickInputService: MonacoQuickInputImplementation

Protected Readonly services

services: MonacoEditorServices

Protected Readonly textModelService

textModelService: MonacoTextModelService

Protected Readonly workspace

workspace: MonacoWorkspace

Static inlineOptions

inlineOptions: IEditorConstructionOptions = ...

Accessors

current

get current(): undefined | MonacoEditor

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:97
Returns the last focused MonacoEditor. It takes into account inline editors as well. If you are interested only in standalone editors then use MonacoEditor.getCurrent(EditorManager)

Returns undefined | MonacoEditor

Protected diffPreferencePrefixes

get diffPreferencePrefixes(): string[]

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:309
Returns string[]

Protected preferencePrefixes

get preferencePrefixes(): string[]

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:235
Returns string[]

Methods

Protected createEditor

createEditor(uri: URI, override: EditorServiceOverrides, toDispose: DisposableCollection): Promise<MonacoEditor>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:228
Parameters
- uri: URI
- override: EditorServiceOverrides
- toDispose: DisposableCollection
Returns Promise<MonacoEditor>

createInline

createInline(uri: URI, node: HTMLElement, options?: MonacoEditor.IOptions): Promise<MonacoEditor>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:401
Parameters
- uri: URI
- node: HTMLElement
- Optional options: MonacoEditor.IOptions
Returns Promise<MonacoEditor>

Protected createMonacoDiffEditor

createMonacoDiffEditor(uri: URI, override: EditorServiceOverrides, toDispose: DisposableCollection): Promise<MonacoDiffEditor>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:312
Parameters
- uri: URI
- override: EditorServiceOverrides
- toDispose: DisposableCollection
Returns Promise<MonacoDiffEditor>

Protected createMonacoDiffEditorOptions

createMonacoDiffEditorOptions(original: MonacoEditorModel, modified: MonacoEditorModel): MonacoDiffEditor.IOptions

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:335
Parameters
- original: MonacoEditorModel
- modified: MonacoEditorModel
Returns MonacoDiffEditor.IOptions

Protected createMonacoEditor

createMonacoEditor(uri: URI, override: EditorServiceOverrides, toDispose: DisposableCollection): Promise<MonacoEditor>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:238
Parameters
- uri: URI
- override: EditorServiceOverrides
- toDispose: DisposableCollection
Returns Promise<MonacoEditor>

Protected createMonacoEditorOptions

createMonacoEditorOptions(model: MonacoEditorModel): MonacoEditor.IOptions

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:254
Parameters
- model: MonacoEditorModel
Returns MonacoEditor.IOptions

Protected createOptions

createOptions(prefixes: string[], uri: string): Record<string, any>
createOptions(prefixes: string[], uri: string, overrideIdentifier: string): Record<string, any>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:354
deprecated
always pass a language as an overrideIdentifier

Parameters
- prefixes: string[]
- uri: string
Returns Record<string, any>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:355
Parameters
- prefixes: string[]
- uri: string
- overrideIdentifier: string
Returns Record<string, any>

Protected doCreateEditor

doCreateEditor(uri: URI, factory: ((override: EditorServiceOverrides, toDispose: DisposableCollection) => Promise<MonacoEditor>)): Promise<MonacoEditor>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:139
Parameters
- uri: URI
- factory: ((override: EditorServiceOverrides, toDispose: DisposableCollection) => Promise<MonacoEditor>)
  - - (override: EditorServiceOverrides, toDispose: DisposableCollection): Promise<MonacoEditor>
    - Parameters
      - override: EditorServiceOverrides
      - toDispose: DisposableCollection
      Returns Promise<MonacoEditor>
Returns Promise<MonacoEditor>

Protected doSetOption

doSetOption(obj: Record<string, any>, value: any, names: string[]): void

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:379
Parameters
- obj: Record<string, any>
- value: any
- names: string[]
Returns void

Protected formatOnSave

formatOnSave(editor: MonacoEditor, event: WillSaveMonacoModelEvent): Promise<IIdentifiedSingleEditOperation[]>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:288
Parameters
- editor: MonacoEditor
- event: WillSaveMonacoModelEvent
Returns Promise<IIdentifiedSingleEditOperation[]>

get

get(uri: URI): Promise<MonacoEditor>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:134
Parameters
- uri: URI
Returns Promise<MonacoEditor>

getDiffNavigator

getDiffNavigator(editor: TextEditor): DiffNavigator

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:394
Parameters
- editor: TextEditor
Returns DiffNavigator

Protected getModel

getModel(uri: URI, toDispose: DisposableCollection): Promise<MonacoEditorModel>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:120
Parameters
- uri: URI
- toDispose: DisposableCollection
Returns Promise<MonacoEditorModel>

Protected injectKeybindingResolver

injectKeybindingResolver(editor: MonacoEditor): void

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:213
Parameters
- editor: MonacoEditor
Returns void

Protected interceptOpen

interceptOpen(monacoUri: string | Uri, monacoOptions?: OpenInternalOptions | OpenExternalOptions): Promise<boolean>

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:187
Intercept internal Monaco open calls and delegate to OpenerService.

Parameters
- monacoUri: string | Uri
- Optional monacoOptions: OpenInternalOptions | OpenExternalOptions
Returns Promise<boolean>

Protected setOption

setOption(preferenceName: string, value: any, prefixes: string[], options?: Record<string, any>): {}

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:364
Parameters
- preferenceName: string
- value: any
- prefixes: string[]
- options: Record<string, any> = {}
Returns {}
- [name: string]: any

Protected shouldFormat

shouldFormat(editor: MonacoEditor, event: WillSaveMonacoModelEvent): boolean

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:274
Parameters
- editor: MonacoEditor
- event: WillSaveMonacoModelEvent
Returns boolean

Protected toOptionName

toOptionName(preferenceName: string, prefixes: string[]): string

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:371
Parameters
- preferenceName: string
- prefixes: string[]
Returns string

Protected updateMonacoDiffEditorOptions

updateMonacoDiffEditorOptions(editor: MonacoDiffEditor, event?: EditorPreferenceChange, resourceUri?: string): void

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:341
Parameters
- editor: MonacoDiffEditor
- Optional event: EditorPreferenceChange
- Optional resourceUri: string
Returns void

Protected updateMonacoEditorOptions

updateMonacoEditorOptions(editor: MonacoEditor, event?: EditorPreferenceChange): void

- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:261
Parameters
- editor: MonacoEditor
- Optional event: EditorPreferenceChange
Returns void