Class PluginContextMenu

Builder context menu descriptor.

Hierarchy

PluginContextMenu

Index

Properties

wrapId

Methods

Properties

wrapId

wrapId: string

Methods

addItem

addItem(id: string | null, name: string, func: function, icon?: undefined | string, index?: undefined | number): PluginContextMenuItem

Add item to this menu.

Parameters
- id: string | null
- name: string
- func: function
  - - (): void
    - Returns void
- Optional icon: undefined | string
- Optional index: undefined | number
Returns PluginContextMenuItem

addMenu

addMenu(id: string | null, name: string, icon?: undefined | string, index?: undefined | number): PluginContextMenu

Add item with sub-menu.

Parameters
- id: string | null
- name: string
- Optional icon: undefined | string
- Optional index: undefined | number
Returns PluginContextMenu

addSeparator

addSeparator(index: number): void

Add menu item separator.

Parameters
- index: number
Returns void

getId

getId(): string

Get identifier of this menu.

Returns string

getItem

getItem(id: string): PluginContextMenu | PluginContextMenuItem | null

Get item by ID from this menu.

Parameters
- id: string
Returns PluginContextMenu | PluginContextMenuItem | null

hasItemById

hasItemById(id: string): boolean

Test if this menu has item identified by this id.

Parameters
- id: string
Returns boolean

removeAllItems

removeAllItems(): void

Remove all item from this menu.

Returns void

removeItem

removeItem(item: PluginContextMenuItem | PluginContextMenu): void

Remove item from this menu.

Parameters
- item: PluginContextMenuItem | PluginContextMenu
Returns void

setVisible

setVisible(visible: boolean): void

Set visibility of menu item representing this menu.

Parameters
- visible: boolean
Returns void