Class SubmenuImpl

Node representing a (sub)menu in the menu tree structure.

Hierarchy (View Summary)

AbstractCompoundMenuImpl
- SubmenuImpl

Implements

Submenu

Index

Constructors

constructor

new SubmenuImpl(
    id: string,
    label: string,
    contextKeyOverlays: undefined | Record<string, string>,
    orderString?: string,
    icon?: string,
    when?: string,
): SubmenuImpl
Parameters
- id: string
- label: string
- contextKeyOverlays: undefined | Record<string, string>
- OptionalorderString: string
- Optionalicon: string
- Optionalwhen: string
Returns SubmenuImpl
Overrides AbstractCompoundMenuImpl.constructor
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:130

Properties

`Readonly`children

children: MenuNode[] = []

`Readonly`contextKeyOverlays

contextKeyOverlays: undefined | Record<string, string>

`Optional` `Readonly`icon

icon?: string

`Readonly`id

id: string

technical identifier.

`Readonly`label

label: string

`Protected` `Optional` `Readonly`orderString

orderString?: string

`Optional` `Readonly`when

when?: string

When expression to determine if the menu node is visible.

Accessors

sortString

get sortString(): string
Menu nodes are sorted in ascending order based on their sortString.

Returns string
Implementation of Submenu.sortString
Inherited from AbstractCompoundMenuImpl.sortString
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:113

Methods

addNode

addNode(...node: MenuNode[]): void
Parameters
- ...node: MenuNode[]
Returns void
Inherited from AbstractCompoundMenuImpl.addNode
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:90

getNode

getNode(id: string): undefined | MenuNode
Parameters
- id: string
Returns undefined | MenuNode
Inherited from AbstractCompoundMenuImpl.getNode
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:95

getOrCreate

getOrCreate(
    menuPath: MenuPath,
    pathIndex: number,
    endIndex: number,
): CompoundMenuImpl
Parameters
- menuPath: MenuPath
- pathIndex: number
- endIndex: number
Returns CompoundMenuImpl
Inherited from AbstractCompoundMenuImpl.getOrCreate
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:55

isEmpty

isEmpty<T>(
    effectiveMenuPath: MenuPath,
    contextMatcher: ContextExpressionMatcher<T>,
    context: undefined | T,
    ...args: unknown[],
): boolean
Type Parameters
- T
Parameters
- effectiveMenuPath: MenuPath
- contextMatcher: ContextExpressionMatcher<T>
- context: undefined | T
- ...args: unknown[]
Returns boolean
Implementation of Submenu.isEmpty
Inherited from AbstractCompoundMenuImpl.isEmpty
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:79

isVisible

isVisible<T>(
    effectiveMenuPath: MenuPath,
    contextMatcher: ContextExpressionMatcher<T>,
    context: undefined | T,
    ...args: unknown[],
): boolean
Menu nodes are sorted in ascending order based on their sortString.
Type Parameters
- T
Parameters
- effectiveMenuPath: MenuPath
- contextMatcher: ContextExpressionMatcher<T>
- context: undefined | T
- ...args: unknown[]
Returns boolean
Implementation of Submenu.isVisible
Inherited from AbstractCompoundMenuImpl.isVisible
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:75

removeById

removeById(id: string): void
Parameters
- id: string
Returns void
Inherited from AbstractCompoundMenuImpl.removeById
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:99

removeNode

removeNode(node: MenuNode): void
Parameters
- node: MenuNode
Returns void
Inherited from AbstractCompoundMenuImpl.removeNode
- Defined in packages/core/src/browser/menu/composite-menu-node.ts:106

Class SubmenuImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SubmenuImpl

Properties

Readonlychildren

ReadonlycontextKeyOverlays

Optional Readonlyicon

Readonlyid

Readonlylabel

Protected Optional ReadonlyorderString

Optional Readonlywhen

Accessors

sortString

Returns string

Methods

addNode

Parameters

Returns void

getNode

Parameters

Returns undefined | MenuNode

getOrCreate

Parameters

Returns CompoundMenuImpl

isEmpty

Type Parameters

Parameters

Returns boolean

isVisible

Type Parameters

Parameters

Returns boolean

removeById

Parameters

Returns void

removeNode

Parameters

Returns void

Settings

On This Page

`Readonly`children

`Readonly`contextKeyOverlays

`Optional` `Readonly`icon

`Readonly`id

`Readonly`label

`Protected` `Optional` `Readonly`orderString

`Optional` `Readonly`when