Class ElectronMenuContribution

The command contribution should be implemented to register custom commands and handler.

Hierarchy (View Summary)

BrowserMenuBarContribution
- ElectronMenuContribution

Implements

Constructors

constructor

new ElectronMenuContribution(
factory: ElectronMainMenuFactory,
): ElectronMenuContribution
Parameters
- factory: ElectronMainMenuFactory
Returns ElectronMenuContribution
Overrides BrowserMenuBarContribution.constructor
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:104

Properties

`Protected` `Readonly`customTitleWidgetFactory

customTitleWidgetFactory: CustomTitleWidgetFactory

`Protected` `Readonly`factory

factory: ElectronMainMenuFactory

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`stateService

stateService: FrontendApplicationStateService

`Protected` `Readonly`themeService

themeService: ThemeService

`Protected` `Optional`titleBarStyle

titleBarStyle?: string

`Protected`titleBarStyleChangeFlag

titleBarStyleChangeFlag: boolean = false

`Protected` `Readonly`windowService

windowService: WindowService

Accessors

menuBar

get menuBar(): undefined | MenuBarWidget
Returns undefined | MenuBarWidget
Inherited from BrowserMenuBarContribution.menuBar
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:428

Methods

`Protected`createControlButton

createControlButton(id: string, handler: () => void): HTMLElement
Parameters
- id: string
- handler: () => void
Returns HTMLElement
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:255

`Protected`createCustomTitleBar

createCustomTitleBar(app: FrontendApplication): void
Parameters
- app: FrontendApplication
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:216

`Protected`createCustomTitleWidget

createCustomTitleWidget(app: FrontendApplication): void
Parameters
- app: FrontendApplication
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:234

`Protected`createLogo

createLogo(): Widget
Returns Widget
Inherited from BrowserMenuBarContribution.createLogo
- Defined in packages/core/src/browser/menu/browser-menu-plugin.ts:451

`Protected`handleFullScreen

handleFullScreen(menuBarVisibility: string): void
Parameters
- menuBarVisibility: string
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:413

`Protected`handleRequiredRestart

handleRequiredRestart(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:263

`Protected`handleThemeChange

handleThemeChange(e: ThemeChangeEvent): void
Parameters
- e: ThemeChangeEvent
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:424

handleTitleBarStyling

handleTitleBarStyling(app: FrontendApplication): void
Parameters
- app: FrontendApplication
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:153

handleToggleMaximized

handleToggleMaximized(): void
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:178

`Protected`handleWindowControls

handleWindowControls(): void
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:241

`Protected`hideTopPanel

hideTopPanel(app: FrontendApplication): void
Hides the theia-top-panel depending on the selected titleBarStyle. The theia-top-panel is used as the container of the main, application menu-bar for the browser. Native Electron has its own. By default, this method is called on application onStart.
Parameters
- app: FrontendApplication
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:191

onStart

onStart(app: FrontendApplication): void
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.
Parameters
- app: FrontendApplication
Returns void
Implementation of FrontendApplicationContribution.onStart
Overrides BrowserMenuBarContribution.onStart
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:110

registerCommands

registerCommands(registry: CommandRegistry): void
Register commands and handlers.
Parameters
- registry: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:284

registerKeybindings

registerKeybindings(registry: KeybindingRegistry): void
Registers keybindings.
Parameters
- registry: KeybindingRegistry
  the keybinding registry.
Returns void
Implementation of KeybindingContribution.registerKeybindings
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:334

registerMenus

registerMenus(registry: MenuModelRegistry): void
Registers menus.
Parameters
- registry: MenuModelRegistry
  the menu model registry.
Returns void
Implementation of MenuContribution.registerMenus
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:375

`Protected`setMenu

setMenu(app: FrontendApplication): void
Parameters
- app: FrontendApplication
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:205

`Protected`toggleFullScreen

toggleFullScreen(): void
Returns void
- Defined in packages/core/src/electron-browser/menu/electron-menu-contribution.ts:407

Class ElectronMenuContribution

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ElectronMenuContribution

Properties

Protected ReadonlycustomTitleWidgetFactory

Protected Readonlyfactory

Protected ReadonlypreferenceService

Protected Readonlyshell

Protected ReadonlystateService

Protected ReadonlythemeService

Protected OptionaltitleBarStyle

ProtectedtitleBarStyleChangeFlag

Protected ReadonlywindowService

Accessors

menuBar

Returns undefined | MenuBarWidget

Methods

ProtectedappendMenu

Parameters

Returns void

ProtectedattachMenuBarVisibilityListener

Returns void

ProtectedattachWindowFocusListener

Parameters

Returns void

ProtectedcreateControlButton

Parameters

Returns HTMLElement

ProtectedcreateCustomTitleBar

Parameters

Returns void

ProtectedcreateCustomTitleWidget

Parameters

Returns void

ProtectedcreateLogo

Returns Widget

ProtectedhandleFullScreen

Parameters

Returns void

ProtectedhandleRequiredRestart

Returns Promise<void>

ProtectedhandleThemeChange

Parameters

Returns void

handleTitleBarStyling

Parameters

Returns void

handleToggleMaximized

Returns void

ProtectedhandleWindowControls

Returns void

ProtectedhideTopPanel

Parameters

Returns void

onStart

Parameters

Returns void

registerCommands

Parameters

Returns void

registerKeybindings

Parameters

Returns void

registerMenus

Parameters

Returns void

ProtectedsetMenu

Parameters

Returns void

ProtectedtoggleFullScreen

Returns void

`Protected` `Readonly`customTitleWidgetFactory

`Protected` `Readonly`factory

`Protected` `Readonly`preferenceService

`Protected` `Readonly`shell

`Protected` `Readonly`stateService

`Protected` `Readonly`themeService

`Protected` `Optional`titleBarStyle

`Protected`titleBarStyleChangeFlag

`Protected` `Readonly`windowService

`Protected`appendMenu

`Protected`attachMenuBarVisibilityListener

`Protected`attachWindowFocusListener

`Protected`createControlButton

`Protected`createCustomTitleBar

`Protected`createCustomTitleWidget

`Protected`createLogo

`Protected`handleFullScreen

`Protected`handleRequiredRestart

`Protected`handleThemeChange

`Protected`handleWindowControls

`Protected`hideTopPanel

`Protected`setMenu

`Protected`toggleFullScreen