Class KeymapsService

Constructors

constructor

new KeymapsService(): KeymapsService
Returns KeymapsService

Properties

`Protected` `Readonly` changeKeymapEmitter

changeKeymapEmitter: Emitter<void> = ...

`Protected` `Readonly` deferredModel

deferredModel: Deferred<MonacoEditorModel> = ...

`Protected` `Readonly` jsoncEditor

jsoncEditor: MonacoJSONCEditor

`Protected` `Readonly` keybindingRegistry

keybindingRegistry: KeybindingRegistry

`Protected` `Readonly` messageService

messageService: MessageService

`Protected` model

model: undefined | MonacoEditorModel

`Readonly` onDidChangeKeymaps

onDidChangeKeymaps: Event<void> = ...

`Protected` `Readonly` opener

opener: OpenerService

`Protected` `Readonly` textModelService

textModelService: MonacoTextModelService

`Protected` `Readonly` workspace

workspace: MonacoWorkspace

Methods

`Protected` doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/keymaps/src/browser/keymaps-service.ts:67

hasKeybinding

hasKeybinding(commandId): boolean
Whether there is a keybinding with the given command id in the JSON.
Parameters
- commandId: string
  the keybinding command id
Returns boolean
- Defined in packages/keymaps/src/browser/keymaps-service.ts:179

`Protected` init

init(): void
Initialize the keybinding service.

Returns void
- Defined in packages/keymaps/src/browser/keymaps-service.ts:63

open

open(ref?): Promise<void>
Open the keybindings widget.
Parameters
- Optional ref: Widget
  the optional reference for opening the widget.
Returns Promise<void>
- Defined in packages/keymaps/src/browser/keymaps-service.ts:112

`Protected` reconcile

reconcile(): void
Reconcile all the keybindings, registering them to the registry.

Returns void
- Defined in packages/keymaps/src/browser/keymaps-service.ts:82

removeKeybinding

removeKeybinding(commandId): Promise<void>
Remove the keybindings with the given command id from the JSON. This includes disabled keybindings.
Parameters
- commandId: string
  the keybinding command id.
Returns Promise<void>
- Defined in packages/keymaps/src/browser/keymaps-service.ts:189

setKeybinding

setKeybinding(newKeybinding, oldKeybinding): Promise<void>
Set the keybinding in the JSON.
Parameters
- newKeybinding: Keybinding
  the new JSON keybinding
- oldKeybinding: undefined | ScopedKeybinding
  the old JSON keybinding
Returns Promise<void>
- Defined in packages/keymaps/src/browser/keymaps-service.ts:129

unsetKeybinding

unsetKeybinding(keybinding): Promise<void>
Unset the given keybinding in the JSON. If the given keybinding has a default scope, it will be disabled in the JSON. Otherwise, it will be removed from the JSON.
Parameters
- keybinding: ScopedKeybinding
  the keybinding to unset
Returns Promise<void>
- Defined in packages/keymaps/src/browser/keymaps-service.ts:155

`Protected` updateKeymap

updateKeymap(op): Promise<void>
Parameters
- op: (() => void | Keybinding[])
  - - (): void | Keybinding[]
    - Returns void | Keybinding[]
Returns Promise<void>
- Defined in packages/keymaps/src/browser/keymaps-service.ts:200