MockMenuModelRegistry | Theia TypeDoc

Hierarchy

MenuModelRegistry
- MockMenuModelRegistry

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MockMenuModelRegistry(): MockMenuModelRegistry

Overrides MenuModelRegistry.constructor
- Defined in packages/core/src/common/test/mock-menu.ts:23
Returns MockMenuModelRegistry

Properties

Protected Readonly commands

commands: CommandRegistry

Protected Readonly contributions

contributions: ContributionProvider<MenuContribution>

Protected Readonly independentSubmenus

independentSubmenus: Map<string, MutableCompoundMenuNode> = ...

Protected Readonly root

root: CompositeMenuNode = ...

Methods

Protected findGroup

findGroup(menuPath: MenuPath, options?: SubMenuOptions): MutableCompoundMenuNode

Inherited from MenuModelRegistry.findGroup
- Defined in packages/core/src/common/menu/menu-model-registry.ts:220
Finds a submenu as a descendant of the root node. See findSubMenu.

Parameters
- menuPath: MenuPath
- Optional options: SubMenuOptions
Returns MutableCompoundMenuNode

Protected findSubMenu

findSubMenu(current: MutableCompoundMenuNode, menuId: string, options?: SubMenuOptions): MutableCompoundMenuNode

Inherited from MenuModelRegistry.findSubMenu
- Defined in packages/core/src/common/menu/menu-model-registry.ts:232
Finds or creates a submenu as an immediate child of current.

throws
if a node with the given menuId exists but is not a MutableCompoundMenuNode.

Parameters
- current: MutableCompoundMenuNode
- menuId: string
- Optional options: SubMenuOptions
Returns MutableCompoundMenuNode

getMenu

getMenu(menuPath?: MenuPath): MutableCompoundMenuNode

Inherited from MenuModelRegistry.getMenu
- Defined in packages/core/src/common/menu/menu-model-registry.ts:253
Returns the menu at the given path.

Parameters
- menuPath: MenuPath = []
  
  the path specifying the menu to return. If not given the empty path will be used.
Returns MutableCompoundMenuNode
the root menu when menuPath is empty. If menuPath is not empty the specified menu is returned if it exists, otherwise an error is thrown.

getMenuNode

getMenuNode(menuPath: string | MenuPath, group?: string): MutableCompoundMenuNode

Inherited from MenuModelRegistry.getMenuNode
- Defined in packages/core/src/common/menu/menu-model-registry.ts:103
Parameters
- menuPath: string | MenuPath
- Optional group: string
Returns MutableCompoundMenuNode

getPath

getPath(node: MenuNode): undefined | MenuPath

Inherited from MenuModelRegistry.getPath
- Defined in packages/core/src/common/menu/menu-model-registry.ts:261
Returns the path at which a given menu node can be accessed from this registry, if it can be determined. Returns undefined if the parent of any node in the chain is unknown.

Parameters
- node: MenuNode
Returns undefined | MenuPath

linkSubmenu

linkSubmenu(parentPath: string | MenuPath, childId: string | MenuPath, options?: SubMenuOptions, group?: string): Disposable

Inherited from MenuModelRegistry.linkSubmenu
- Defined in packages/core/src/common/menu/menu-model-registry.ts:157
Parameters
- parentPath: string | MenuPath
- childId: string | MenuPath
- Optional options: SubMenuOptions
- Optional group: string
Returns Disposable

onStart

onStart(): void

Inherited from MenuModelRegistry.onStart
- Defined in packages/core/src/common/menu/menu-model-registry.ts:77
Returns void

registerIndependentSubmenu

registerIndependentSubmenu(id: string, label: string, options?: SubMenuOptions): Disposable

Inherited from MenuModelRegistry.registerIndependentSubmenu
- Defined in packages/core/src/common/menu/menu-model-registry.ts:149
Parameters
- id: string
- label: string
- Optional options: SubMenuOptions
Returns Disposable

registerMenuAction

registerMenuAction(menuPath: MenuPath, item: MenuAction): Disposable

Overrides MenuModelRegistry.registerMenuAction
- Defined in packages/core/src/common/test/mock-menu.ts:28
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.

registerMenuNode

registerMenuNode(menuPath: string | MenuPath, menuNode: MenuNode, group?: string): Disposable

Inherited from MenuModelRegistry.registerMenuNode
- Defined in packages/core/src/common/menu/menu-model-registry.ts:98
Adds the given menu node to the menu denoted by the given path.

Parameters
- menuPath: string | MenuPath
- menuNode: MenuNode
- Optional group: string
Returns Disposable
a disposable which, when called, will remove the menu node again.

registerSubmenu

registerSubmenu(menuPath: MenuPath, label: string): Disposable

Overrides MenuModelRegistry.registerSubmenu
- Defined in packages/core/src/common/test/mock-menu.ts:32
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
- label: string
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.

unregisterMenuAction

unregisterMenuAction(item: MenuAction, menuPath?: MenuPath): void
unregisterMenuAction(command: Command, menuPath?: MenuPath): void
unregisterMenuAction(id: string, menuPath?: MenuPath): void

Inherited from MenuModelRegistry.unregisterMenuAction
- Defined in packages/core/src/common/menu/menu-model-registry.ts:170
Unregister all menu nodes with the same id as the given menu action.

Parameters
- item: MenuAction
  
  the item whose id will be used.
- Optional menuPath: MenuPath
  
  if specified only nodes within the path will be unregistered.
Returns void
Inherited from MenuModelRegistry.unregisterMenuAction
- Defined in packages/core/src/common/menu/menu-model-registry.ts:177
Unregister all menu nodes with the same id as the given command.

Parameters
- command: Command
  
  the command whose id will be used.
- Optional menuPath: MenuPath
  
  if specified only nodes within the path will be unregistered.
Returns void
Inherited from MenuModelRegistry.unregisterMenuAction
- Defined in packages/core/src/common/menu/menu-model-registry.ts:184
Unregister all menu nodes with the given id.

Parameters
- id: string
  
  the id which shall be removed.
- Optional menuPath: MenuPath
  
  if specified only nodes within the path will be unregistered.
Returns void

unregisterMenuNode

unregisterMenuNode(id: string): void

Inherited from MenuModelRegistry.unregisterMenuNode
- Defined in packages/core/src/common/menu/menu-model-registry.ts:204
Recurse all menus, removing any menus matching the id.

Parameters
- id: string
  
  technical identifier of the MenuNode.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MockMenuModelRegistry

Properties

Protected Readonly commands

Protected Readonly contributions

Protected Readonly independentSubmenus

Protected Readonly root

Methods

Protected findGroup

Parameters

menuPath: MenuPath

Optional options: SubMenuOptions

Returns MutableCompoundMenuNode

Protected findSubMenu

Parameters

current: MutableCompoundMenuNode

menuId: string

Optional options: SubMenuOptions

Returns MutableCompoundMenuNode

getMenu

Parameters

menuPath: MenuPath = []

Returns MutableCompoundMenuNode

getMenuNode

Parameters

menuPath: string | MenuPath

Optional group: string

Returns MutableCompoundMenuNode

getPath

Parameters

node: MenuNode

Returns undefined | MenuPath

linkSubmenu

Parameters

parentPath: string | MenuPath

childId: string | MenuPath

Optional options: SubMenuOptions

Optional group: string

Returns Disposable

onStart

Returns void

registerIndependentSubmenu

Parameters

id: string

label: string

Optional options: SubMenuOptions

Returns Disposable

registerMenuAction

Parameters

menuPath: MenuPath

item: MenuAction

Returns Disposable

registerMenuNode

Parameters

menuPath: string | MenuPath

menuNode: MenuNode

Optional group: string

Returns Disposable

registerSubmenu

Parameters

menuPath: MenuPath

label: string

Returns Disposable

unregisterMenuAction

Parameters

item: MenuAction

Optional menuPath: MenuPath

Returns void

Parameters

command: Command

Optional menuPath: MenuPath

Returns void

Parameters

id: string