Interface ContainerWindowManager

Represents window management capability

Hierarchy

ContainerWindowManager

Implemented by

Container

Index

Methods

buildLayout createWindow deleteLayout getAllWindows getCurrentWindow getLayouts getMainWindow getWindowById getWindowByName loadLayout saveLayout

Methods

buildLayout

buildLayout(): Promise<PersistedWindowLayout>
Builds the current window layout

Returns Promise<PersistedWindowLayout>
- Defined in desktopjs/src/window.ts:295

createWindow

createWindow(url: string, options?: any): Promise<ContainerWindow>
Creates a new ContainerWindow.

Returns
A new native container window wrapped within a generic ContainerWindow.
Parameters
- url: string
  
  url
- Optional options: any
  
  (Optional)
Returns Promise<ContainerWindow>
- Defined in desktopjs/src/window.ts:283

deleteLayout

deleteLayout(name: string): Promise<void>
Persists a window layout
Parameters
- name: string
  
  Name of the window layout to delete
Returns Promise<void>
- Defined in desktopjs/src/window.ts:312

getAllWindows

getAllWindows(): Promise<ContainerWindow[]>
Retrieves a list of ContainerWindow wrapped native windows.

Returns
- A promise that returns an array of ContainerWindow if resolved
Returns Promise<ContainerWindow[]>
- Defined in desktopjs/src/window.ts:263

getCurrentWindow

getCurrentWindow(): ContainerWindow
Gets the current ContainerWindow

Returns
The current ContainerWindow

Returns ContainerWindow
- Defined in desktopjs/src/window.ts:257

getLayouts

getLayouts(): Promise<PersistedWindowLayout[]>
Retrieve a list of persisted window layouts

Returns
- A promise that returns an array of PersistedWindowLayout if resolved
Returns Promise<PersistedWindowLayout[]>
- Defined in desktopjs/src/window.ts:307

getMainWindow

getMainWindow(): ContainerWindow
Gets the main ContainerWindow of the application.

Returns
The main ContainerWindow.

Returns ContainerWindow
- Defined in desktopjs/src/window.ts:251

getWindowById

getWindowById(id: string): Promise<ContainerWindow>
Retrieve a ContainerWindow with provided id.

Returns
- A promise that returns a {ContainerWindow} if resolved
Parameters
- id: string
Returns Promise<ContainerWindow>
- Defined in desktopjs/src/window.ts:269

getWindowByName

getWindowByName(name: string): Promise<ContainerWindow>
Retrieve a ContainerWindow with provided name.

Returns
- A promise that returns a {ContainerWindow} if resolved
Parameters
- name: string
Returns Promise<ContainerWindow>
- Defined in desktopjs/src/window.ts:275

loadLayout

loadLayout(layout: string | PersistedWindowLayout): Promise<PersistedWindowLayout>
Loads a window layout

Returns
- A promise that returns PersistedWindowLayout that is loaded
Parameters
- layout: string | PersistedWindowLayout
Returns Promise<PersistedWindowLayout>
- Defined in desktopjs/src/window.ts:290

saveLayout

saveLayout(name: string): Promise<PersistedWindowLayout>
Persists a window layout

Returns
- A promise that returns PersistedWindowLayout if resolved
Parameters
- name: string
  
  Name of the window layout to save
Returns Promise<PersistedWindowLayout>
- Defined in desktopjs/src/window.ts:301