Interface SecondaryWindowService`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.

interface SecondaryWindowService {
    beforeWidgetRestore: Event<[Widget, Window]>;
    onWindowClosed: Event<Window>;
    onWindowOpened: Event<Window>;
    createSecondaryWindow(
        widget: ExtractableWidget,
        shell: ApplicationShell,
    ): undefined | Window | SecondaryWindow;
    focus(win: Window): void;
    getWindows(): Window[];
}

Implemented by

DefaultSecondaryWindowService

Index

Properties

beforeWidgetRestore onWindowClosed onWindowOpened

Methods

createSecondaryWindow focus getWindows

Properties

`Readonly` `Experimental`beforeWidgetRestore

beforeWidgetRestore: Event<[Widget, Window]>

`Readonly` `Experimental`onWindowClosed

onWindowClosed: Event<Window>

`Readonly` `Experimental`onWindowOpened

onWindowOpened: Event<Window>

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

focus

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

getWindows

getWindows(): Window[]
Experimental
Returns Window[]
- Defined in packages/core/src/browser/window/secondary-window-service.ts:63