Class ToolbarActionWrapper

Hierarchy

AbstractToolbarMenuWrapper
- ToolbarActionWrapper

Implements

TabBarToolbarItem

Index

Constructors

constructor

new ToolbarActionWrapper(
    effectiveMenuPath: MenuPath,
    commandRegistry: CommandRegistry,
    menuRegistry: MenuModelRegistry,
    contextKeyService: ContextKeyService,
    contextMenuRenderer: ContextMenuRenderer,
    toolbarItem: RenderedToolbarAction,
): ToolbarActionWrapper
Parameters
- effectiveMenuPath: MenuPath
- commandRegistry: CommandRegistry
- menuRegistry: MenuModelRegistry
- contextKeyService: ContextKeyService
- contextMenuRenderer: ContextMenuRenderer
- toolbarItem: RenderedToolbarAction
Returns ToolbarActionWrapper
Overrides AbstractToolbarMenuWrapper.constructor
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:191

Properties

`Protected` `Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly`contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

`Readonly`effectiveMenuPath

effectiveMenuPath: MenuPath

`Optional`group

group?: string

`Protected` `Readonly`menuRegistry

menuRegistry: MenuModelRegistry

`Optional`priority

priority?: number

`Protected` `Readonly`toolbarItem

toolbarItem: RenderedToolbarAction

Accessors

icon

get icon(): undefined | string
Returns undefined | string
Overrides AbstractToolbarMenuWrapper.icon
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:239

id

get id(): string
Returns string
Implementation of TabBarToolbarItem.id
Overrides AbstractToolbarMenuWrapper.id
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:238

menuNode

get menuNode(): undefined | CompoundMenuNode
Returns undefined | CompoundMenuNode
Overrides AbstractToolbarMenuWrapper.menuNode
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:262

menuPath

get menuPath(): MenuPath
Returns MenuPath
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:258

onDidChange

get onDidChange(): undefined | Event<void>
Returns undefined | Event<void>
Implementation of TabBarToolbarItem.onDidChange
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:254

text

get text(): undefined | string
Returns undefined | string
Overrides AbstractToolbarMenuWrapper.text
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:253

get tooltip(): undefined | string
Returns undefined | string
Overrides AbstractToolbarMenuWrapper.tooltip
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:252

Methods

`Protected`executeCommand

executeCommand(widget: Widget, e: MouseEvent<HTMLElement>): void
Parameters
- widget: Widget
- e: MouseEvent<HTMLElement>
Returns void
Overrides AbstractToolbarMenuWrapper.executeCommand
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:206

isEnabled

isEnabled(widget?: Widget): boolean
Parameters
- Optionalwidget: Widget
Returns boolean
Implementation of TabBarToolbarItem.isEnabled
Overrides AbstractToolbarMenuWrapper.isEnabled
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:202

isToggled

isToggled(widget: Widget): boolean
Parameters
- widget: Widget
Returns boolean
Implementation of TabBarToolbarItem.isToggled
Inherited from AbstractToolbarMenuWrapper.isToggled
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:53

isVisible

isVisible(widget: Widget): boolean
Parameters
- widget: Widget
Returns boolean
Implementation of TabBarToolbarItem.isVisible
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:219

render

render(widget: Widget): ReactNode
Parameters
- widget: Widget
Returns ReactNode
Implementation of TabBarToolbarItem.render
Inherited from AbstractToolbarMenuWrapper.render
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:59

`Protected`renderMenuItem

renderMenuItem(widget: Widget): ReactNode
Renders a toolbar item that is a menu, presenting it as a button with a little chevron decoration that pops up a floating menu when clicked.
Parameters
- widget: Widget
Returns ReactNode
the rendered toolbar item
Inherited from AbstractToolbarMenuWrapper.renderMenuItem
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:94

showPopupMenu

showPopupMenu(
    widget: undefined | Widget,
    menuPath: MenuPath,
    event: MouseEvent,
    contextMatcher: ContextMatcher,
): void
Presents the menu to popup on the event that is the clicking of a menu toolbar item.
Parameters
- widget: undefined | Widget
- menuPath: MenuPath
  the path of the registered menu to show
- event: MouseEvent
  the mouse event triggering the menu
- contextMatcher: ContextMatcher
Returns void
Inherited from AbstractToolbarMenuWrapper.showPopupMenu
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:72

toMenuNode

toMenuNode(): undefined | MenuNode
Returns undefined | MenuNode
Implementation of TabBarToolbarItem.toMenuNode
Overrides AbstractToolbarMenuWrapper.toMenuNode
- Defined in packages/core/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.tsx:266

Class ToolbarActionWrapper

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ToolbarActionWrapper

Properties

Protected ReadonlycommandRegistry

Protected ReadonlycontextKeyService

Protected ReadonlycontextMenuRenderer

ReadonlyeffectiveMenuPath

Optionalgroup

Protected ReadonlymenuRegistry

Optionalpriority

Protected ReadonlytoolbarItem

Accessors

icon

Returns undefined | string

id

Returns string

menuNode

Returns undefined | CompoundMenuNode

menuPath

Returns MenuPath

onDidChange

Returns undefined | Event<void>

text

Returns undefined | string

tooltip

Returns undefined | string

Methods

ProtectedexecuteCommand

Parameters

Returns void

isEnabled

Parameters

Returns boolean

isToggled

Parameters

Returns boolean

isVisible

Parameters

Returns boolean

render

Parameters

Returns ReactNode

ProtectedrenderMenuItem

Parameters

Returns ReactNode

showPopupMenu

Parameters

Returns void

toMenuNode

Returns undefined | MenuNode

Settings

On This Page

`Protected` `Readonly`commandRegistry

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`contextMenuRenderer

`Readonly`effectiveMenuPath

`Optional`group

`Protected` `Readonly`menuRegistry

`Optional`priority

`Protected` `Readonly`toolbarItem

`Protected`executeCommand

`Protected`renderMenuItem