Class DefaultSecondaryWindowService`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

Implements

SecondaryWindowService

Constructors

constructor

new DefaultSecondaryWindowService(): DefaultSecondaryWindowService
Returns DefaultSecondaryWindowService

Properties

`Readonly` `Experimental`beforeWidgetRestore

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

`Protected` `Readonly`beforeWidgetRestoreEmitter

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

`Readonly` `Experimental`onWindowClosed

onWindowClosed: Event<Window> = ...

`Protected` `Readonly`onWindowClosedEmitter

onWindowClosedEmitter: 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`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
Implementation of SecondaryWindowService.createSecondaryWindow
- Defined in packages/core/src/browser/window/default-secondary-window-service.ts:98

`Protected`findSecondaryWindowCoordinates

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

`Protected`findWindow

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

focus

focus(win: Window): void
Experimental
Handles focussing the given secondary window in the browser and on Electron.
Parameters
- win: Window
Returns void
Implementation of SecondaryWindowService.focus
- Defined in packages/core/src/browser/window/default-secondary-window-service.ts:197

`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>
- Defined in packages/core/src/browser/window/default-secondary-window-service.ts:208

`Protected`windowCreated

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

Class DefaultSecondaryWindowServiceExperimental

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DefaultSecondaryWindowService

Properties

Readonly ExperimentalbeforeWidgetRestore

Protected ReadonlybeforeWidgetRestoreEmitter

Readonly ExperimentalonWindowClosed

Protected ReadonlyonWindowClosedEmitter

Readonly ExperimentalonWindowOpened

Protected ReadonlyonWindowOpenedEmitter

Protected ReadonlypreferenceService

Protected Readonlyprefix

Protected ReadonlysaveResourceService

ProtectedsecondaryWindows

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

ProtectedregisterShutdownListeners

Returns void

ProtectedrestoreWidgets

Parameters

Returns Promise<boolean>

ProtectedwindowCreated

Parameters

Returns void

Settings

On This Page

Class DefaultSecondaryWindowService`Experimental`

`Readonly` `Experimental`beforeWidgetRestore

`Protected` `Readonly`beforeWidgetRestoreEmitter

`Readonly` `Experimental`onWindowClosed

`Protected` `Readonly`onWindowClosedEmitter

`Readonly` `Experimental`onWindowOpened

`Protected` `Readonly`onWindowOpenedEmitter

`Protected` `Readonly`preferenceService

`Protected` `Readonly`prefix

`Protected` `Readonly`saveResourceService

`Protected`secondaryWindows

`Protected` `Readonly`windowService

`Protected` `Static`SECONDARY_WINDOW_URL

`Protected`findSecondaryWindowCoordinates

`Protected`findWindow

`Protected`nextWindowId

`Protected`registerShutdownListeners

`Protected`restoreWidgets

`Protected`windowCreated