Class ElectronMainApplication

Protected Readonly_backendPort

Protected_config

ProtectedactiveWindowStack

Protected Readonlycontributions

Protected OptionalcustomBackgroundColor

ProtecteddidUseNativeWindowFrameOnStart

Protected ReadonlyelectronSecurityToken

ProtectedelectronSecurityTokenService

Protected ReadonlyelectronStore

Protected Readonlyglobals

Protected OptionalinitialWindow

ProtectedisPortable

Protected ReadonlylaunchArgsStore

ProtectedprocessArgv

Protectedrestarting

Protected Readonlystopwatch

ProtecteduseNativeWindowFrame

Protected ReadonlywindowFactory

Protectedwindows

ProtectedattachElectronSecurityToken

• attachElectronSecurityToken(port: number): Promise<void>

  Parameters

  • port: number

  Returns Promise<void>

ProtectedattachSaveWindowState

• attachSaveWindowState(electronWindow: BrowserWindow): void

  Save the window geometry state on every change.

  Parameters

  • electronWindow: BrowserWindow

  Returns void

ProtectedavoidOverlap

• avoidOverlap(options: TheiaBrowserWindowOptions): TheiaBrowserWindowOptions

  Parameters

  • options: TheiaBrowserWindowOptions

  Returns TheiaBrowserWindowOptions

ProtectedconfigureAndShowSplashScreen

• configureAndShowSplashScreen(mainWindow: BrowserWindow): Promise<BrowserWindow>

  Parameters

  • mainWindow: BrowserWindow

  Returns Promise<BrowserWindow>

ProtectedcreateWindowUri

• createWindowUri(params?: WindowSearchParams): Promise<URI>

  Parameters

  • params: WindowSearchParams = {}

  Returns Promise<URI>

ProtecteddetermineSplashScreenBounds

• determineSplashScreenBounds(
      initialWindowBounds: {
          height: number;
          width: number;
          x: number;
          y: number;
      },
  ): Promise<{ height: number; width: number; x: number; y: number }>

  Parameters

  • initialWindowBounds: { height: number; width: number; x: number; y: number }

  Returns Promise<{ height: number; width: number; x: number; y: number }>

ProtectedgetCurrentScreenLayout

• getCurrentScreenLayout(): string

  Return a string unique to the current display layout.

  Returns string

ProtectedgetDefaultOptions

• getDefaultOptions(): TheiaBrowserWindowOptions

  Returns TheiaBrowserWindowOptions

ProtectedgetDefaultTheiaSecondaryWindowBounds

• getDefaultTheiaSecondaryWindowBounds(): TheiaBrowserWindowOptions

  Returns TheiaBrowserWindowOptions

ProtectedgetDefaultTheiaWindowBounds

• getDefaultTheiaWindowBounds(): TheiaBrowserWindowOptions

  Returns TheiaBrowserWindowOptions

ProtectedgetDefaultTheiaWindowOptions

• getDefaultTheiaWindowOptions(): TheiaBrowserWindowOptions

  Returns TheiaBrowserWindowOptions

ProtectedgetDisplayForNewWindow

• getDisplayForNewWindow(): Display

  Returns the display where a new window should be opened. Attempts to use the display nearest to the cursor position for multi-monitor setups. Falls back to the primary display if cursor position cannot be determined (e.g., on Wayland before any window is opened). See: https://github.com/eclipse-theia/theia/issues/16582

  Returns Display

ProtectedgetForkOptions

• getForkOptions(): Promise<ForkOptions>

  Returns Promise<ForkOptions>

ProtectedgetSplashScreenOptions

• getSplashScreenOptions(): undefined | SplashScreenOptions

  Returns undefined | SplashScreenOptions

ProtectedgetTitleBarStyle

• getTitleBarStyle(config: FrontendApplicationConfig): "native" | "custom"

  Parameters

  • config: FrontendApplicationConfig

  Returns "native" | "custom"

ProtectedhandleMainCommand

• handleMainCommand(options: ElectronMainCommandOptions): Promise<void>

  Parameters

  • options: ElectronMainCommandOptions

  Returns Promise<void>

ProtectedhookApplicationEvents

• hookApplicationEvents(): void

  Returns void

ProtectedisShowSplashScreen

• isShowSplashScreen(): boolean

  Returns boolean

ProtectedisShowWindowEarly

• isShowWindowEarly(): boolean

  Returns boolean

ProtectedisWaylandSession

• isWaylandSession(): boolean

  Detects if the current session is running natively under Wayland (i.e., not using X11 fallback/XWayland).

  Returns boolean

ProtectedisWindowClaimed

• isWindowClaimed(args: LaunchArguments): Promise<boolean>
  Experimental

  Whether any ElectronMainApplicationContribution claims responsibility for a window opened for the given launch (see its claimsWindow hook). Core stays agnostic of the concrete CLI options; e.g. @theia/dev-container claims --attach-container launches.

  Parameters

  • args: LaunchArguments

  Returns Promise<boolean>

ProtectedmakePortable

• makePortable(): boolean

  Returns boolean

ProtectedonSecondInstance

• onSecondInstance(
      event: { defaultPrevented: boolean; preventDefault: () => void },
      _: string[],
      cwd: string,
      originalArgv: string[],
  ): Promise<void>

  Parameters

  • event: { defaultPrevented: boolean; preventDefault: () => void }
  • _: string[]
  • cwd: string
  • originalArgv: string[]

  Returns Promise<void>

ProtectedonWebContentsCreated

• onWebContentsCreated(
      event: { defaultPrevented: boolean; preventDefault: () => void },
      webContents: WebContents,
  ): void

  Parameters

  • event: { defaultPrevented: boolean; preventDefault: () => void }
  • webContents: WebContents

  Returns void

ProtectedonWillQuit

• onWillQuit(
      event: { defaultPrevented: boolean; preventDefault: () => void },
  ): void

  Parameters

  • event: { defaultPrevented: boolean; preventDefault: () => void }

  Returns void

ProtectedonWindowAllClosed

• onWindowAllClosed(
      event: { defaultPrevented: boolean; preventDefault: () => void },
  ): void

  Parameters

  • event: { defaultPrevented: boolean; preventDefault: () => void }

  Returns void

ProtectedopenWindowWithWorkspace

• openWindowWithWorkspace(
      workspacePath: string,
      launchArgs?: LaunchArguments,
  ): Promise<BrowserWindow>

  Parameters

  • workspacePath: string
  • OptionallaunchArgs: LaunchArguments

  Returns Promise<BrowserWindow>

ProtectedreuseOrCreateWindow

• reuseOrCreateWindow(
      asyncOptions: MaybePromise<TheiaBrowserWindowOptions>,
  ): Promise<BrowserWindow>

  Parameters

  • asyncOptions: MaybePromise<TheiaBrowserWindowOptions>

  Returns Promise<BrowserWindow>

ProtectedsaveState

• saveState(webContents: WebContents): void

  Parameters

  • webContents: WebContents

  Returns void

ProtectedsaveWindowState

• saveWindowState(electronWindow: BrowserWindow): void

  Parameters

  • electronWindow: BrowserWindow

  Returns void

ProtectedshowInitialWindow

• showInitialWindow(urlToOpen: undefined | string): void

  Parameters

  • urlToOpen: undefined | string

  Returns void

ProtectedstartBackend

• startBackend(): Promise<number>

  Start the NodeJS backend server.

  Returns Promise<number>

  Running server's port promise.

ProtectedstartContributions

• startContributions(): Promise<void>

  Returns Promise<void>

ProtectedstashLaunchArgs

• stashLaunchArgs(window: BrowserWindow, launchArgs?: LaunchArguments): void
  Experimental

  Associates the parsed options of a forwarded launch with the target window before it loads its URL, so that the preload script cannot ask for them before they are stored. No-op for a cold-start launch, which carries none.

  Parameters

  • window: BrowserWindow
  • OptionallaunchArgs: LaunchArguments

  Returns void

ProtectedstopContributions

• stopContributions(): void

  Returns void