Class MenuModelRegistry

The MenuModelRegistry allows to register and unregister menus, submenus and actions via strings and MenuActions without the need to access the underlying UI representation.

Constructors

constructor

new MenuModelRegistry(
    contributions: ContributionProvider<MenuContribution>,
    commands: CommandRegistry,
    menuNodeFactory: MenuNodeFactory,
): MenuModelRegistry
Parameters
- contributions: ContributionProvider<MenuContribution>
- commands: CommandRegistry
- menuNodeFactory: MenuNodeFactory
Returns MenuModelRegistry
- Defined in packages/core/src/common/menu/menu-model-registry.ts:104

Properties

`Protected` `Readonly`commands

commands: CommandRegistry

`Protected` `Readonly`contributions

contributions: ContributionProvider<MenuContribution>

`Protected`isReady

isReady: boolean = false

`Protected` `Readonly`menuNodeFactory

menuNodeFactory: MenuNodeFactory

`Protected` `Readonly`onDidChangeEmitter

onDidChangeEmitter: Emitter<MenuChangedEvent> = ...

`Protected`root

root: CompoundMenuNode & MutableCompoundMenuNode

Accessors

onDidChange

get onDidChange(): Event<MenuChangedEvent>
Returns Event<MenuChangedEvent>
- Defined in packages/core/src/common/menu/menu-model-registry.ts:115

Methods

`Protected`findInNode

findInNode(
    root: MenuNode,
    menuPath: MenuPath,
    pathIndex: number,
): undefined | MenuNode
Parameters
- root: MenuNode
- menuPath: MenuPath
- pathIndex: number
Returns undefined | MenuNode
- Defined in packages/core/src/common/menu/menu-model-registry.ts:303

`Protected`fireChangeEvent

fireChangeEvent<T extends MenuChangedEvent>(evt: T): void
Type Parameters
- T extends MenuChangedEvent
Parameters
- evt: T
Returns void
- Defined in packages/core/src/common/menu/menu-model-registry.ts:385

getMenu

getMenu(menuPath: MenuPath): undefined | CompoundMenuNode
Parameters
- menuPath: MenuPath
Returns undefined | CompoundMenuNode
- Defined in packages/core/src/common/menu/menu-model-registry.ts:320

getMenuNode

getMenuNode(menuPath: string[]): undefined | MenuNode
Parameters
- menuPath: string[]
Returns undefined | MenuNode
- Defined in packages/core/src/common/menu/menu-model-registry.ts:316

linkCompoundMenuNode

linkCompoundMenuNode(
    params: {
        newParentPath: MenuPath;
        order?: string;
        submenuPath: MenuPath;
        when?: string;
    },
): Disposable
Parameters
- params: {
      newParentPath: MenuPath;
      order?: string;
      submenuPath: MenuPath;
      when?: string;
  }
Returns Disposable
- Defined in packages/core/src/common/menu/menu-model-registry.ts:223

onStart

onStart(): void
Returns void
- Defined in packages/core/src/common/menu/menu-model-registry.ts:121

registerCommandMenu

registerCommandMenu(menuPath: MenuPath, item: CommandMenu): Disposable
Adds the given menu action to the menu denoted by the given path.
Parameters
- menuPath: MenuPath
- item: CommandMenu
Returns Disposable
a disposable which, when called, will remove the menu action again.
- Defined in packages/core/src/common/menu/menu-model-registry.ts:133

registerMenuAction

registerMenuAction(menuPath: MenuPath, item: MenuAction): Disposable
Adds the given menu action to the menu denoted by the given path.
Parameters
- menuPath: MenuPath
- item: MenuAction
Returns Disposable
a disposable which, when called, will remove the menu action again.
- Defined in packages/core/src/common/menu/menu-model-registry.ts:151

registerSubmenu

registerSubmenu(
    menuPath: MenuPath,
    label: string,
    options?: {
        contextKeyOverlay?: Record<string, string>;
        icon?: string;
        sortString?: string;
        when?: string;
    },
): Disposable
Register a new menu at the given path with the given label. (If the menu already exists without a label, iconClass or order this method can be used to set them.)
Parameters
- menuPath: MenuPath
  the path for which a new submenu shall be registered.
- label: string
  the label to be used for the new submenu.
- options: {
      contextKeyOverlay?: Record<string, string>;
      icon?: string;
      sortString?: string;
      when?: string;
  } = {}
  optionally allows to set an icon class and specify the order of the new menu.
Returns Disposable
if the menu was successfully created a disposable will be returned which, when called, will remove the menu again. If the menu already existed a no-op disposable will be returned.

Note that if the menu already existed and was registered with a different label an error will be thrown.
- Defined in packages/core/src/common/menu/menu-model-registry.ts:181

`Protected`removeActionInSubtree

removeActionInSubtree(parent: MenuNode, id: string): void
Parameters
- parent: MenuNode
- id: string
Returns void
- Defined in packages/core/src/common/menu/menu-model-registry.ts:293

unregisterMenuAction

unregisterMenuAction(item: MenuAction, menuPath?: MenuPath): void
Unregister all menu nodes with the same id as the given menu action.
Parameters
- item: MenuAction
  the item whose id will be used.
- OptionalmenuPath: MenuPath
  if specified only nodes within the path will be unregistered.
Returns void
- Defined in packages/core/src/common/menu/menu-model-registry.ts:267
unregisterMenuAction(command: Command, menuPath?: MenuPath): void
Unregister all menu nodes with the same id as the given command.
Parameters
- command: Command
  the command whose id will be used.
- OptionalmenuPath: MenuPath
  if specified only nodes within the path will be unregistered.
Returns void
- Defined in packages/core/src/common/menu/menu-model-registry.ts:274
unregisterMenuAction(id: string, menuPath?: MenuPath): void
Unregister all menu nodes with the given id.
Parameters
- id: string
  the id which shall be removed.
- OptionalmenuPath: MenuPath
  if specified only nodes within the path will be unregistered.
Returns void
- Defined in packages/core/src/common/menu/menu-model-registry.ts:281

`Static`isEmpty

isEmpty(node: MenuNode): boolean
Parameters
- node: MenuNode
Returns boolean
- Defined in packages/core/src/common/menu/menu-model-registry.ts:369

`Static`removeSingleRootNode

removeSingleRootNode(fullMenuModel: CompoundMenuNode): CompoundMenuNode
Checks the given menu model whether it will show a menu with a single submenu.
Parameters
- fullMenuModel: CompoundMenuNode
  the menu model to analyze
Returns CompoundMenuNode
if the menu will show a single submenu this returns a menu that will show the child elements of the submenu, otherwise the given fullMenuModel is return
- Defined in packages/core/src/common/menu/menu-model-registry.ts:349

`Static`removeSingleRootNodes

removeSingleRootNodes(fullMenuModel: CompoundMenuNode): CompoundMenuNode
Parameters
- fullMenuModel: CompoundMenuNode
Returns CompoundMenuNode
- Defined in packages/core/src/common/menu/menu-model-registry.ts:331

Class MenuModelRegistry

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MenuModelRegistry

Properties

Protected Readonlycommands

Protected Readonlycontributions

ProtectedisReady

Protected ReadonlymenuNodeFactory

Protected ReadonlyonDidChangeEmitter

Protectedroot

Accessors

onDidChange

Returns Event<MenuChangedEvent>

Methods

ProtectedfindInNode

Parameters

Returns undefined | MenuNode

ProtectedfireChangeEvent

Type Parameters

Parameters

Returns void

getMenu

Parameters

Returns undefined | CompoundMenuNode

getMenuNode

Parameters

Returns undefined | MenuNode

linkCompoundMenuNode

Parameters

Returns Disposable

onStart

Returns void

registerCommandMenu

Parameters

Returns Disposable

registerMenuAction

Parameters

Returns Disposable

registerSubmenu

Parameters

Returns Disposable

ProtectedremoveActionInSubtree

Parameters

Returns void

unregisterMenuAction

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

StaticisEmpty

Parameters

Returns boolean

StaticremoveSingleRootNode

Parameters

Returns CompoundMenuNode

StaticremoveSingleRootNodes

Parameters

Returns CompoundMenuNode

Settings

On This Page

`Protected` `Readonly`commands

`Protected` `Readonly`contributions

`Protected`isReady

`Protected` `Readonly`menuNodeFactory

`Protected` `Readonly`onDidChangeEmitter

`Protected`root

`Protected`findInNode

`Protected`fireChangeEvent

`Protected`removeActionInSubtree

`Static`isEmpty

`Static`removeSingleRootNode

`Static`removeSingleRootNodes