Class FrontendApplication

Protected Readonly_shell

Protected ReadonlybackendStopwatch

Protected Readonlycommands

Protected Readonlycontributions

Protected ReadonlycorePreferences

Protected Readonlykeybindings

Protected ReadonlylayoutRestorer

Protected Readonlymenus

Protected ReadonlystateService

Protected Readonlystopwatch

Protected ReadonlytooltipService

Protected ReadonlywindowsService

ProtectedattachShell

• attachShell(host: HTMLElement): void

  Attach the application shell to the host element. If a startup indicator is present, the shell is inserted before that indicator so it is not visible yet.

  Parameters

  • host: HTMLElement

  Returns void

ProtectedattachTooltip

• attachTooltip(host: HTMLElement): void

  Attach the tooltip container to the host element.

  Parameters

  • host: HTMLElement

  Returns void

ProtectedcreateDefaultLayout

• createDefaultLayout(): Promise<void>

  Let the frontend application contributions initialize the shell layout. Override this method in order to create an application-specific custom layout.

  Returns Promise<void>

ProtectedfireOnDidInitializeLayout

• fireOnDidInitializeLayout(): Promise<void>

  Returns Promise<void>

ProtectedgetHost

• getHost(): Promise<HTMLElement>

  Return a promise to the host element to which the application shell is attached.

  Returns Promise<HTMLElement>

ProtectedgetStartupIndicator

• getStartupIndicator(host: HTMLElement): undefined | HTMLElement

  Return an HTML element that indicates the startup phase, e.g. with an animation or a splash screen.

  Parameters

  • host: HTMLElement

  Returns undefined | HTMLElement

ProtectedinitializeLayout

• initializeLayout(): Promise<void>

  Initialize the shell layout either using the layout restorer service or, if no layout has been stored, by creating the default layout.

  Returns Promise<void>

Protectedmeasure

• measure<T>(
      name: string,
      fn: () => MaybePromise<T>,
      message?: string,
      threshold?: boolean,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • name: string
  • fn: () => MaybePromise<T>
  • message: string = ...
  • threshold: boolean = true

  Returns Promise<T>

ProtectedmeasureContribution

• measureContribution<T>(
      contribution: FrontendApplicationContribution,
      hook: string,
      fn: () => MaybePromise<T>,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • contribution: FrontendApplicationContribution
  • hook: string
  • fn: () => MaybePromise<T>

  Returns Promise<T>

ProtectedregisterEventListeners

• registerEventListeners(): void

  Register global event listeners.

  Returns void

ProtectedrestoreLayout

• restoreLayout(): Promise<boolean>

  Try to restore the shell layout from the storage service. Resolves to true if successful.

  Returns Promise<boolean>

ProtectedrevealShell

• revealShell(host: HTMLElement): Promise<void>

  If a startup indicator is present, it is first hidden with the theia-hidden CSS class and then removed after a while. The delay until removal is taken from the CSS transition duration.

  Parameters

  • host: HTMLElement

  Returns Promise<void>

ProtectedstartContributions

• startContributions(): Promise<void>

  Initialize and start the frontend application contributions.

  Returns Promise<void>

ProtectedstopContributions

• stopContributions(): void

  Stop the frontend application contributions. This is called when the window is unloaded.

  Returns void