Class ElectronSecondaryWindowService`Experimental`

Service for opening new secondary windows to contain widgets extracted from the application shell.

The functionality provided by this service and its implementation is still under development. Use with caution.

Hierarchy (View Summary)

DefaultSecondaryWindowService
- ElectronSecondaryWindowService

Constructors

constructor

new ElectronSecondaryWindowService(): ElectronSecondaryWindowService
Returns ElectronSecondaryWindowService
Inherited from DefaultSecondaryWindowService.constructor

Properties

`Readonly` `Experimental`beforeWidgetRestore

beforeWidgetRestore: Event<[Widget, Window]> = ...

`Protected` `Readonly`beforeWidgetRestoreEmitter

beforeWidgetRestoreEmitter: Emitter<[Widget, Window]> = ...

`Protected` `Readonly`electronWindowPreferences

electronWindowPreferences: ElectronWindowPreferences

`Protected` `Readonly`logger

logger: ILogger

`Readonly` `Experimental`onWindowClosed

onWindowClosed: Event<Window> = ...

`Protected` `Readonly`onWindowClosedEmitter

onWindowClosedEmitter: Emitter<Window> = ...

`Readonly` `Experimental`onWindowLoaded

onWindowLoaded: Event<Window> = ...

Emitted once a secondary window's final document has finished loading. Listeners can safely modify the window's document, unlike with onWindowOpened: at that point the window still shows the initial about:blank document, and anything added to it is discarded when the final document replaces it.

`Protected` `Readonly`onWindowLoadedEmitter

onWindowLoadedEmitter: Emitter<Window> = ...

`Readonly` `Experimental`onWindowOpened

onWindowOpened: Event<Window> = ...

`Protected` `Readonly`onWindowOpenedEmitter

onWindowOpenedEmitter: Emitter<Window> = ...

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`prefix

prefix: number = ...

Randomized prefix to be included in opened windows' ids. This avoids conflicts when creating sub-windows from multiple theia instances (e.g. by opening Theia multiple times in the same browser)

`Protected` `Readonly`saveResourceService

saveResourceService: SaveableService

`Protected`secondaryWindows

secondaryWindows: Window[] = []

`Protected` `Readonly`windowFocusService

windowFocusService: WindowFocusService

`Protected` `Readonly`windowService

windowService: WindowService

`Protected` `Static`SECONDARY_WINDOW_URL

SECONDARY_WINDOW_URL: string = 'secondary-window.html'

secondary-window.html is part of Theia's generated code. It is generated by dev-packages/application-manager/src/generator/frontend-generator.ts

Methods

createSecondaryWindow

createSecondaryWindow(
widget: ExtractableWidget,
shell: ApplicationShell,
): undefined | Window | SecondaryWindow
Experimental
Creates a new secondary window for a widget to be extracted from the application shell. The created window is closed automatically when the current theia instance is closed.
Parameters
- widget: ExtractableWidget
- shell: ApplicationShell
Returns undefined | Window | SecondaryWindow
the created window or undefined if it could not be created
Inherited from DefaultSecondaryWindowService.createSecondaryWindow
- Defined in packages/core/src/browser/window/default-secondary-window-service.ts:107

`Protected`findSecondaryWindowCoordinates

findSecondaryWindowCoordinates(
widget: ExtractableWidget,
): (undefined | number)[]
Parameters
- widget: ExtractableWidget
Returns (undefined | number)[]
Inherited from DefaultSecondaryWindowService.findSecondaryWindowCoordinates
- Defined in packages/core/src/browser/window/default-secondary-window-service.ts:166

`Protected`findWindow

findWindow<T>(windowName: string): undefined | Window
Type Parameters
- T
Parameters
- windowName: string
Returns undefined | Window
Inherited from DefaultSecondaryWindowService.findWindow
- Defined in packages/core/src/browser/window/default-secondary-window-service.ts:157

focus

focus(win: Window): void
Experimental
Handles focussing the given secondary window in the browser and on Electron.
Parameters
- win: Window
Returns void
Overrides DefaultSecondaryWindowService.focus
- Defined in packages/core/src/electron-browser/window/electron-secondary-window-service.ts:52

`Protected`restoreWidgets

restoreWidgets(
    newWindow: Window,
    extractableWidget: ExtractableWidget,
    shell: ApplicationShell,
): Promise<boolean>
Restore the widgets back to the main window. SecondaryWindowHandler needs to get informated about this.
Parameters
- newWindow: Window
- extractableWidget: ExtractableWidget
- shell: ApplicationShell
Returns Promise<boolean>
Inherited from DefaultSecondaryWindowService.restoreWidgets
- Defined in packages/core/src/browser/window/default-secondary-window-service.ts:223

`Protected`updateWindowZoomLevel

updateWindowZoomLevel(zoomLevel: number): Promise<void>
Parameters
- zoomLevel: number
Returns Promise<void>
- Defined in packages/core/src/electron-browser/window/electron-secondary-window-service.ts:46

`Protected`windowCreated

windowCreated(
    newWindow: Window,
    widget: ExtractableWidget,
    shell: ApplicationShell,
): void
Parameters
- newWindow: Window
- widget: ExtractableWidget
- shell: ApplicationShell
Returns void
Overrides DefaultSecondaryWindowService.windowCreated
- Defined in packages/core/src/electron-browser/window/electron-secondary-window-service.ts:76

Class ElectronSecondaryWindowServiceExperimental

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ElectronSecondaryWindowService

Properties

Readonly ExperimentalbeforeWidgetRestore

Protected ReadonlybeforeWidgetRestoreEmitter

Protected ReadonlyelectronWindowPreferences

Protected Readonlylogger

Readonly ExperimentalonWindowClosed

Protected ReadonlyonWindowClosedEmitter

Readonly ExperimentalonWindowLoaded

Protected ReadonlyonWindowLoadedEmitter

Readonly ExperimentalonWindowOpened

Protected ReadonlyonWindowOpenedEmitter

Protected ReadonlypreferenceService

Protected Readonlyprefix

Protected ReadonlysaveResourceService

ProtectedsecondaryWindows

Protected ReadonlywindowFocusService

Protected ReadonlywindowService

Protected StaticSECONDARY_WINDOW_URL

Methods

createSecondaryWindow

Parameters

Returns undefined | Window | SecondaryWindow

ProtectedfindSecondaryWindowCoordinates

Parameters

Returns (undefined | number)[]

ProtectedfindWindow

Type Parameters

Parameters

Returns undefined | Window

focus

Parameters

Returns void

getWindows

Returns Window[]

init

Returns void

ProtectednextWindowId

Returns string

registerShutdownListeners

Returns void

ProtectedrestoreWidgets

Parameters

Returns Promise<boolean>

ProtectedupdateWindowZoomLevel

Parameters

Returns Promise<void>

ProtectedwindowCreated

Parameters

Returns void

Settings

On This Page

Class ElectronSecondaryWindowService`Experimental`

`Readonly` `Experimental`beforeWidgetRestore

`Protected` `Readonly`beforeWidgetRestoreEmitter

`Protected` `Readonly`electronWindowPreferences

`Protected` `Readonly`logger

`Readonly` `Experimental`onWindowClosed

`Protected` `Readonly`onWindowClosedEmitter

`Readonly` `Experimental`onWindowLoaded

`Protected` `Readonly`onWindowLoadedEmitter

`Readonly` `Experimental`onWindowOpened

`Protected` `Readonly`onWindowOpenedEmitter

`Protected` `Readonly`preferenceService

`Protected` `Readonly`prefix

`Protected` `Readonly`saveResourceService

`Protected`secondaryWindows

`Protected` `Readonly`windowFocusService

`Protected` `Readonly`windowService

`Protected` `Static`SECONDARY_WINDOW_URL

`Protected`findSecondaryWindowCoordinates

`Protected`findWindow

`Protected`nextWindowId

`Protected`restoreWidgets

`Protected`updateWindowZoomLevel

`Protected`windowCreated