Class CommonFrontendContribution

Representation of a menu contribution.

Note that there are also convenience classes which combine multiple contributions into one. For example to register a view together with a menu and keybinding you could use AbstractViewContribution instead.

Example usage

import { MenuContribution, MenuModelRegistry, MAIN_MENU_BAR } from '@theia/core';

@injectable()
export class NewMenuContribution implements MenuContribution {
   registerMenus(menus: MenuModelRegistry): void {
        const menuPath = [...MAIN_MENU_BAR, '99_mymenu'];
        menus.registerSubmenu(menuPath, 'My Menu');

        menus.registerMenuAction(menuPath, {
           commandId: MyCommand.id,
           label: 'My Action'
        });
    }
}

Implements

Index

Constructors

constructor

Constructors

constructor

new CommonFrontendContribution(
    shell: ApplicationShell,
    selectionService: SelectionService,
    messageService: MessageService,
    openerService: OpenerService,
    aboutDialog: AboutDialog,
    localizationProvider: AsyncLocalizationProvider,
    saveResourceService: SaveableService,
): CommonFrontendContribution
Parameters
- shell: ApplicationShell
- selectionService: SelectionService
- messageService: MessageService
- openerService: OpenerService
- aboutDialog: AboutDialog
- localizationProvider: AsyncLocalizationProvider
- saveResourceService: SaveableService
Returns CommonFrontendContribution
- Defined in packages/core/src/browser/common-frontend-contribution.ts:396

Properties

`Protected` `Readonly`aboutDialog

aboutDialog: AboutDialog

`Protected` `Readonly`authenticationService

authenticationService: AuthenticationService

`Protected` `Readonly`clipboardService

clipboardService: ClipboardService

`Protected` `Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected`commonDecorationsStyleSheet

commonDecorationsStyleSheet: CSSStyleSheet = ...

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly`encodingRegistry

encodingRegistry: EncodingRegistry

`Protected` `Readonly`environments

environments: EnvVariablesServer

`Protected` `Readonly`iconThemes

iconThemes: IconThemeService

`Protected`inputFocus

inputFocus: ContextKey<boolean>

`Protected` `Readonly`languageQuickPickService

languageQuickPickService: LanguageQuickPickService

`Protected` `Readonly`localizationProvider

localizationProvider: AsyncLocalizationProvider

`Protected` `Readonly`menuRegistry

menuRegistry: MenuModelRegistry

`Protected` `Readonly`messageService

messageService: MessageService

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected`pinnedKey

pinnedKey: ContextKey<boolean>

`Protected` `Readonly`preferences

preferences: CorePreferences

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`quickInputService

quickInputService: QuickInputService

`Protected` `Readonly`resourceContextKey

resourceContextKey: ResourceContextKey

`Protected` `Readonly`saveResourceService

saveResourceService: SaveableService

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected`shouldPreventClose

shouldPreventClose: boolean = false

`Protected` `Readonly`storageService

storageService: StorageService

`Protected` `Readonly`themeService

themeService: ThemeService

`Protected` `Readonly`undoRedoHandlerService

undoRedoHandlerService: UndoRedoHandlerService

`Protected` `Readonly`untitledResourceResolver

untitledResourceResolver: UntitledResourceResolver

`Protected` `Readonly`windowService

windowService: WindowService

`Protected` `Readonly`workingDirProvider

workingDirProvider: UserWorkingDirectoryProvider

Methods

configure

configure(app: FrontendApplication): Promise<void>
Called before commands, key bindings and menus are initialized. Should return a promise if it runs asynchronously.
Parameters
- app: FrontendApplication
Returns Promise<void>
Implementation of FrontendApplicationContribution.configure
- Defined in packages/core/src/browser/common-frontend-contribution.ts:466

`Protected`configureDisplayLanguage

configureDisplayLanguage(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1345

`Protected`confirmRestart

confirmRestart(languageName: string): Promise<boolean>
Parameters
- languageName: string
Returns Promise<boolean>
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1380

`Protected`getOrdinalNumbers

getOrdinalNumbers(): readonly string[]
Returns readonly string[]
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1090

onStart

onStart(): 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.

Returns void
Implementation of FrontendApplicationContribution.onStart
- Defined in packages/core/src/browser/common-frontend-contribution.ts:595

onStop

onStop(): void
Called when an application is stopped or unloaded.

Note that this is implemented using window.beforeunload which doesn't allow any asynchronous code anymore. I.e. this is the last tick.

Returns void
Implementation of FrontendApplicationContribution.onStop
- Defined in packages/core/src/browser/common-frontend-contribution.ts:600

onWillStop

onWillStop(): undefined | OnWillStopAction<unknown>
Called on beforeunload event, right before the window closes. Return true or an OnWillStopAction in order to prevent exit. Note: No async code allowed, this function has to run on one tick.

Returns undefined | OnWillStopAction<unknown>
Implementation of FrontendApplicationContribution.onWillStop
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1274

`Protected`openAbout

openAbout(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1247

registerColors

registerColors(colors: ColorRegistry): void
Parameters
- colors: ColorRegistry
Returns void
Implementation of ColorContribution.registerColors
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1568

registerCommands

registerCommands(commandRegistry: CommandRegistry): void
Register commands and handlers.
Parameters
- commandRegistry: CommandRegistry
Returns void
Implementation of CommandContribution.registerCommands
- Defined in packages/core/src/browser/common-frontend-contribution.ts:790

`Protected`registerCtrlWHandling

registerCtrlWHandling(): void
registers event listener which make sure that window doesn't get closed if CMD/CTRL W is pressed. Too many users have that in their muscle memory. Chrome doesn't let us rebind or prevent default the keybinding, so this at least doesn't close the window immediately.

Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1260

registerKeybindings

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

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/browser/common-frontend-contribution.ts:617

`Protected`save

save(options?: SaveOptions): Promise<void>
Parameters
- Optionaloptions: SaveOptions
Returns Promise<void>
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1242

`Protected`saveDirty

saveDirty(toSave: Widget[]): Promise<void>
saves any dirty widget in toSave side effect - will pop all widgets from toSave that was saved
Parameters
- toSave: Widget[]
Returns Promise<void>
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1360

`Protected`selectColorTheme

selectColorTheme(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1435

`Protected`selectIconTheme

selectIconTheme(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1391

`Protected`setOsClass

setOsClass(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:522

`Protected`setSashProperties

setSashProperties(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:585

`Protected`showNewFilePicker

showNewFilePicker(): Promise<void>
Returns Promise<void>
Todo
https://github.com/eclipse-theia/theia/issues/12824
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1500

`Protected`toggleBreadcrumbs

toggleBreadcrumbs(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1371

`Protected`togglePinned

togglePinned(title?: Title<Widget>): void
Parameters
- Optionaltitle: Title<Widget>
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1098

`Protected`unsavedTabsCaptions

unsavedTabsCaptions(): string[]
Returns string[]
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1335

`Protected`unsavedUntitledTabsCaptions

unsavedUntitledTabsCaptions(): Widget[]
Returns Widget[]
- Defined in packages/core/src/browser/common-frontend-contribution.ts:1340

`Protected`updateInputFocus

updateInputFocus(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:539

`Protected`updatePinnedKey

updatePinnedKey(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:548

`Protected`updateStyles

updateStyles(): void
Returns void
- Defined in packages/core/src/browser/common-frontend-contribution.ts:532

Class CommonFrontendContribution

Example usage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommonFrontendContribution

Properties

Protected ReadonlyaboutDialog

Protected ReadonlyauthenticationService

Protected ReadonlyclipboardService

Protected ReadonlycommandRegistry

ProtectedcommonDecorationsStyleSheet

Protected ReadonlycontextKeyService

Protected ReadonlyencodingRegistry

Protected Readonlyenvironments

Protected ReadonlyiconThemes

ProtectedinputFocus

Protected ReadonlylanguageQuickPickService

Protected ReadonlylocalizationProvider

Protected ReadonlymenuRegistry

Protected ReadonlymessageService

Protected ReadonlyopenerService

ProtectedpinnedKey

Protected Readonlypreferences

Protected ReadonlypreferenceService

Protected ReadonlyquickInputService

Protected ReadonlyresourceContextKey

Protected ReadonlysaveResourceService

Protected ReadonlyselectionService

Protected Readonlyshell

ProtectedshouldPreventClose

Protected ReadonlystorageService

Protected ReadonlythemeService

Protected ReadonlyundoRedoHandlerService

Protected ReadonlyuntitledResourceResolver

Protected ReadonlywindowService

Protected ReadonlyworkingDirProvider

Methods

configure

Parameters

Returns Promise<void>

ProtectedconfigureDisplayLanguage

Returns Promise<void>

ProtectedconfirmRestart

Parameters

Returns Promise<boolean>

ProtectedgetOrdinalNumbers

Returns readonly string[]

ProtectedhandlePreferenceChange

Parameters

Returns void

ProtectedinitResourceContextKeys

Returns void

ProtectedisBreadcrumbsEnabled

Returns boolean

ProtectedisElectron

Returns boolean

onStart

Returns void

onStop

Returns void

onWillStop

Returns undefined | OnWillStopAction<unknown>

ProtectedopenAbout

Returns Promise<void>

registerColors

Parameters

Returns void

registerCommands

Parameters

Returns void

ProtectedregisterCtrlWHandling

Returns void

registerKeybindings

Parameters

`Protected` `Readonly`aboutDialog

`Protected` `Readonly`authenticationService

`Protected` `Readonly`clipboardService

`Protected` `Readonly`commandRegistry

`Protected`commonDecorationsStyleSheet

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`encodingRegistry

`Protected` `Readonly`environments

`Protected` `Readonly`iconThemes

`Protected`inputFocus

`Protected` `Readonly`languageQuickPickService

`Protected` `Readonly`localizationProvider

`Protected` `Readonly`menuRegistry

`Protected` `Readonly`messageService

`Protected` `Readonly`openerService

`Protected`pinnedKey

`Protected` `Readonly`preferences

`Protected` `Readonly`preferenceService

`Protected` `Readonly`quickInputService

`Protected` `Readonly`resourceContextKey

`Protected` `Readonly`saveResourceService

`Protected` `Readonly`selectionService

`Protected` `Readonly`shell

`Protected`shouldPreventClose

`Protected` `Readonly`storageService

`Protected` `Readonly`themeService

`Protected` `Readonly`undoRedoHandlerService

`Protected` `Readonly`untitledResourceResolver

`Protected` `Readonly`windowService

`Protected` `Readonly`workingDirProvider

`Protected`configureDisplayLanguage

`Protected`confirmRestart

`Protected`getOrdinalNumbers

`Protected`handlePreferenceChange

`Protected`initResourceContextKeys

`Protected`isBreadcrumbsEnabled

`Protected`isElectron

`Protected`openAbout

`Protected`registerCtrlWHandling

`Protected`save

`Protected`saveDirty

`Protected`selectColorTheme

`Protected`selectIconTheme

`Protected`setOsClass

`Protected`setSashProperties

`Protected`showNewFilePicker

`Protected`toggleBreadcrumbs

`Protected`togglePinned

`Protected`unsavedTabsCaptions

`Protected`unsavedUntitledTabsCaptions

`Protected`updateInputFocus

`Protected`updatePinnedKey

`Protected`updateStyles