Class DynamicMenuWidget

A menu widget that would recompute its items on update.

Hierarchy

Menu
- DynamicMenuWidget

Constructors

constructor

new DynamicMenuWidget(effectiveMenuPath, menu, options, contextMatcher, services, args?): DynamicMenuWidget
Parameters
- effectiveMenuPath: MenuPath
- menu: CompoundMenuNode
- options: BrowserMenuOptions
- contextMatcher: ContextMatcher
- services: MenuServices
- Optional args: unknown[]
Returns DynamicMenuWidget
Overrides MenuWidget.constructor
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:228

Properties

`Protected` `Optional` args

args?: unknown[]

`Protected` contextMatcher

contextMatcher: ContextMatcher

`Protected` `Readonly` effectiveMenuPath

effectiveMenuPath: MenuPath

`Protected` menu

menu: CompoundMenuNode

`Protected` options

options: BrowserMenuOptions

`Protected` previousFocusedElement

previousFocusedElement: undefined | HTMLElement

We want to restore the focus after the menu closes.

`Protected` services

services: MenuServices

`Static` `Private` nextCommmandId

nextCommmandId: number = 0

Methods

aboutToShow

aboutToShow(__namedParameters): void
Parameters
- __namedParameters: {
  previousFocusedElement: undefined | HTMLElement;
  }
  - previousFocusedElement: undefined | HTMLElement
Returns void
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:290

`Protected` createItems

createItems(parentPath, nodes, phCommandRegistry, contextMatcher, context?): IItemOptions[]
Parameters
- parentPath: MenuPath
- nodes: MenuNode[]
- phCommandRegistry: CommandRegistry
- contextMatcher: ContextMatcher
- Optional context: HTMLElement
Returns IItemOptions[]
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:326

handleEvent

handleEvent(event): void
Parameters
- event: Event
Returns void
Overrides MenuWidget.handleEvent
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:258

handlePointerDown

handlePointerDown(event): void
Parameters
- event: PointerEvent
Returns void
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:265

`Private` hitTestMenus

hitTestMenus(menu, x, y): boolean
Parameters
- menu: Menu
- x: number
- y: number
Returns boolean
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:281

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Overrides MenuWidget.onAfterAttach
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:248

`Protected` onBeforeDetach

onBeforeDetach(msg): void
Parameters
- msg: Message
Returns void
Overrides MenuWidget.onBeforeDetach
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:253

open

open(x, y, options?): void
Parameters
- x: number
- y: number
- Optional options: IOpenOptions
Returns void
Overrides MenuWidget.open
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:298

`Protected` preserveFocusedElement

preserveFocusedElement(previousFocusedElement?): boolean
Parameters
- previousFocusedElement: null | Element = document.activeElement
Returns boolean
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:380

`Protected` restoreFocusedElement

restoreFocusedElement(): boolean
Returns boolean
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:388

`Protected` runWithPreservedFocusContext

runWithPreservedFocusContext(what): void
Parameters
- what: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:397

`Protected` updateSubMenus

updateSubMenus(parentPath, parent, menu, commands, contextMatcher, context?): void
Parameters
- parentPath: MenuPath
- parent: Menu
- menu: CompoundMenuNode
- commands: CommandRegistry
- contextMatcher: ContextMatcher
- Optional context: HTMLElement
Returns void
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:308