Class ContainerWindow`Abstract`

Represents a container window.

Hierarchy

EventEmitter
- ContainerWindow
  - DefaultContainerWindow

Constructors

constructor

new ContainerWindow(wrap: any): ContainerWindow
Parameters
- wrap: any
Returns ContainerWindow
Overrides EventEmitter.constructor
- Defined in desktopjs/src/window.ts:105

Properties

`Readonly` `Abstract` id

id: string

`Readonly` innerWindow

innerWindow: any

The underlying concrete container window.

`Readonly` `Abstract` name

name: string

Accessors

allowGrouping

get allowGrouping(): boolean
Returns boolean
- Defined in desktopjs/src/window.ts:156

nativeWindow

get nativeWindow(): Window
Gets the underlying native JavaScript window object. As some containers do not support native access, check for undefined.

Returns Window
- Defined in desktopjs/src/window.ts:192

`Static` ipc

set ipc(value: MessageBus): void
Set message bus used for static event broadcasting across windows.
Parameters
- value: MessageBus
Returns void
Inherited from EventEmitter.ipc
- Defined in desktopjs/src/events.ts:131

Methods

addListener

addListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): ContainerWindow
Registers an event listener on the specified event.
Parameters
- eventName: WindowEventType
  
  {WindowEventType} eventName The type of the event.
- listener: ((event: EventArgs) => void)
  
  {(event: EventArgs) => void} The event handler function.
  - - (event: EventArgs): void
    - Parameters
      
      event: EventArgs
      
      Returns void
Returns ContainerWindow
Overrides EventEmitter.addListener
- Defined in desktopjs/src/window.ts:206

`Protected` `Abstract` attachListener

attachListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): void
Override to provide custom container logic for adding an event handler.
Parameters
- eventName: WindowEventType
- listener: ((event: EventArgs) => void)
  - - (event: EventArgs): void
    - Parameters
      
      event: EventArgs
      
      Returns void
Returns void
- Defined in desktopjs/src/window.ts:199

bringToFront

bringToFront(): Promise<void>
Returns Promise<void>
- Defined in desktopjs/src/window.ts:172

`Abstract` close

close(): Promise<void>
Try to close the window. This has the same effect as clicking the close button on the window.

Returns Promise<void>
- Defined in desktopjs/src/window.ts:123

`Protected` `Abstract` detachListener

detachListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): void
Override to provide custom container logic for removing an event handler.
Parameters
- eventName: WindowEventType
- listener: ((event: EventArgs) => void)
  - - (event: EventArgs): void
    - Parameters
      
      event: EventArgs
      
      Returns void
Returns void
- Defined in desktopjs/src/window.ts:215

emit

emit(eventName: string, eventArgs: EventArgs): void
Invokes each listener registered for the specified event type.
Parameters
- eventName: string
  
  The type of the event.
- eventArgs: EventArgs
Returns void
Inherited from EventEmitter.emit
- Defined in desktopjs/src/events.ts:122

`Abstract` flash

flash(enable: boolean, options?: any): Promise<void>
Parameters
- enable: boolean
- Optional options: any
Returns Promise<void>
- Defined in desktopjs/src/window.ts:143

`Abstract` focus

focus(): Promise<void>
Gives focus to the window.

Returns Promise<void>
- Defined in desktopjs/src/window.ts:114

`Abstract` getBounds

getBounds(): Promise<Rectangle>
Gets the current bounds of the window.

Returns Promise<Rectangle>
- Defined in desktopjs/src/window.ts:141

getGroup

getGroup(): Promise<ContainerWindow[]>
Returns Promise<ContainerWindow[]>
- Defined in desktopjs/src/window.ts:160

`Abstract` getOptions

getOptions(): Promise<any>
Returns Promise<any>
- Defined in desktopjs/src/window.ts:177

`Abstract` getParent

getParent(): Promise<ContainerWindow>
Returns the parent window of this window.

Returns Promise<ContainerWindow>
- Defined in desktopjs/src/window.ts:146

`Abstract` getSnapshot

getSnapshot(): Promise<string>
Gets a base64 encoded snapshot of the window.

Returns Promise<string>
- Defined in desktopjs/src/window.ts:138

getState

getState(): Promise<any>
Retrieves custom window state from underlying native window by invoking 'window.getState()' if defined.

Returns Promise<any>
- Defined in desktopjs/src/window.ts:180

`Abstract` hide

hide(): Promise<void>
Hides the window if showing.

Returns Promise<void>
- Defined in desktopjs/src/window.ts:120

`Abstract` isShowing

isShowing(): Promise<boolean>
Determines whether the window is currently showing.

Returns Promise<boolean>
- Defined in desktopjs/src/window.ts:135

joinGroup

joinGroup(target: ContainerWindow): Promise<void>
Parameters
- target: ContainerWindow
Returns Promise<void>
- Defined in desktopjs/src/window.ts:164

leaveGroup

leaveGroup(): Promise<void>
Returns Promise<void>
- Defined in desktopjs/src/window.ts:168

listeners

listeners(eventName: string): ((event: EventArgs) => void)[]
Gets an array of listeners for a specific event type.
Parameters
- eventName: string
  
  eventName The type of the event.
Returns ((event: EventArgs) => void)[]
Inherited from EventEmitter.listeners
- Defined in desktopjs/src/events.ts:113

`Abstract` load

load(url: string, options?: any): Promise<void>
Navigate window to a new url
Parameters
- url: string
- Optional options: any
Returns Promise<void>
- Defined in desktopjs/src/window.ts:111

`Abstract` maximize

maximize(): Promise<void>
Maximizes the window.

Returns Promise<void>
- Defined in desktopjs/src/window.ts:129

`Abstract` minimize

minimize(): Promise<void>
Minimizes the window.

Returns Promise<void>
- Defined in desktopjs/src/window.ts:126

`Protected` postProcessArgs

postProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from EventEmitter.postProcessArgs
- Defined in desktopjs/src/events.ts:76

`Protected` preProcessArgs

preProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from EventEmitter.preProcessArgs
- Defined in desktopjs/src/events.ts:72

`Protected` registerAndWrapListener

registerAndWrapListener(eventName: string, listener: ((event: EventArgs) => void)): ((event: EventArgs) => void)
Parameters
- eventName: string
- listener: ((event: EventArgs) => void)
  - - (event: EventArgs): void
    - Parameters
      
      event: EventArgs
      
      Returns void
Returns ((event: EventArgs) => void)
- - (event: EventArgs): void
  - Parameters
    - event: EventArgs
    Returns void
Inherited from EventEmitter.registerAndWrapListener
- Defined in desktopjs/src/events.ts:56

removeListener

removeListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): ContainerWindow
Removes a previous registered event listener from the specified event.
Parameters
- eventName: WindowEventType
  
  {WindowEventType} eventName The type of the event.
- listener: ((event: EventArgs) => void)
  
  {(event: EventArgs) => void} The event handler function.
  - - (event: EventArgs): void
    - Parameters
      
      event: EventArgs
      
      Returns void
Returns ContainerWindow
Overrides EventEmitter.removeListener
- Defined in desktopjs/src/window.ts:222

`Abstract` restore

restore(): Promise<void>
Restores the window to its previous state.

Returns Promise<void>
- Defined in desktopjs/src/window.ts:132

`Abstract` setBounds

setBounds(bounds: Rectangle): Promise<void>
Set the current bounds of the window.
Parameters
- bounds: Rectangle
Returns Promise<void>
- Defined in desktopjs/src/window.ts:154

`Abstract` setParent

setParent(parent: ContainerWindow): Promise<void>
Sets the parent window of this window.
Parameters
- parent: ContainerWindow
Returns Promise<void>
- Defined in desktopjs/src/window.ts:149

setState

setState(state: any): Promise<void>
Provide custom window state to underlying native window by invoking 'window.setState()' if defined
Parameters
- state: any
Returns Promise<void>
- Defined in desktopjs/src/window.ts:185

`Abstract` show

show(): Promise<void>
Shows the window if hidden.

Returns Promise<void>
- Defined in desktopjs/src/window.ts:117

`Protected` unwrapAndUnRegisterListener

unwrapAndUnRegisterListener(listener: ((event: EventArgs) => void)): ((event: EventArgs) => void)
Parameters
- listener: ((event: EventArgs) => void)
  - - (event: EventArgs): void
    - Parameters
      
      event: EventArgs
      
      Returns void
Returns ((event: EventArgs) => void)
- - (event: EventArgs): void
  - Parameters
    - event: EventArgs
    Returns void
Inherited from EventEmitter.unwrapAndUnRegisterListener
- Defined in desktopjs/src/events.ts:82

`Protected` wrapListener

wrapListener(eventName: string, listener: ((event: EventArgs) => void)): ((event: EventArgs) => void)
Parameters
- eventName: string
- listener: ((event: EventArgs) => void)
  - - (event: EventArgs): void
    - Parameters
      
      event: EventArgs
      
      Returns void
Returns ((event: EventArgs) => void)
- - (event: EventArgs): void
  - Parameters
    - event: EventArgs
    Returns void
Inherited from EventEmitter.wrapListener
- Defined in desktopjs/src/events.ts:62

`Static` addListener

addListener(eventName: WindowEventType, listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)): void
Registers an event listener on the specified static event.
Parameters
- eventName: WindowEventType
  
  The type of the event.
- listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)
  
  The event handler function.
  - - (event: WindowEventArgs | WindowGroupEventArgs): void
    - Parameters
      
      event: WindowEventArgs | WindowGroupEventArgs
      
      Returns void
Returns void
Overrides EventEmitter.addListener
- Defined in desktopjs/src/window.ts:228

`Static` emit

emit(eventName: WindowEventType, eventArgs: WindowEventArgs | WindowGroupEventArgs): void
Parameters
- eventName: WindowEventType
- eventArgs: WindowEventArgs | WindowGroupEventArgs
Returns void
Overrides EventEmitter.emit
- Defined in desktopjs/src/window.ts:236

`Static` listeners

listeners(eventName: string): ((event: EventArgs) => void)[]
Gets an array of listeners for a specific static event type.
Parameters
- eventName: string
  
  eventName The type of the event.
Returns ((event: EventArgs) => void)[]
Overrides EventEmitter.listeners
- Defined in desktopjs/src/window.ts:240

`Static` removeListener

removeListener(eventName: WindowEventType, listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)): void
Removes a previous registered event listener from the specified static event.
Parameters
- eventName: WindowEventType
  
  The type of the event.
- listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)
  
  The event handler function.
  - - (event: WindowEventArgs | WindowGroupEventArgs): void
    - Parameters
      
      event: WindowEventArgs | WindowGroupEventArgs
      
      Returns void
Returns void
Overrides EventEmitter.removeListener
- Defined in desktopjs/src/window.ts:232

Class ContainerWindowAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wrap: any

Returns ContainerWindow

Properties

Readonly Abstract id

Readonly innerWindow

Readonly Abstract name

Accessors

allowGrouping

Returns boolean

nativeWindow

Returns Window

Static ipc

Parameters

value: MessageBus

Returns void

Methods

addListener

Parameters

eventName: WindowEventType

listener: ((event: EventArgs) => void)

Parameters

event: EventArgs

Returns void

Returns ContainerWindow

Protected Abstract attachListener

Parameters

eventName: WindowEventType

listener: ((event: EventArgs) => void)

Parameters

event: EventArgs

Returns void

Returns void

bringToFront

Returns Promise<void>

Abstract close

Returns Promise<void>

Protected Abstract detachListener

Parameters

eventName: WindowEventType

listener: ((event: EventArgs) => void)

Parameters

event: EventArgs

Returns void

Returns void

emit

Parameters

eventName: string

eventArgs: EventArgs

Returns void

Abstract flash

Parameters

enable: boolean

Optional options: any

Returns Promise<void>

Abstract focus

Returns Promise<void>

Abstract getBounds

Returns Promise<Rectangle>

getGroup

Returns Promise<ContainerWindow[]>

Abstract getOptions

Returns Promise<any>

Abstract getParent

Returns Promise<ContainerWindow>

Abstract getSnapshot

Returns Promise<string>

getState

Returns Promise<any>

Abstract hide

Returns Promise<void>

Class ContainerWindow`Abstract`

`Readonly` `Abstract` id

`Readonly` innerWindow

`Readonly` `Abstract` name

`Static` ipc

`Protected` `Abstract` attachListener

`Abstract` close

`Protected` `Abstract` detachListener

`Abstract` flash

`Optional` options: any

`Abstract` focus

`Abstract` getBounds

`Abstract` getOptions

`Abstract` getParent

`Abstract` getSnapshot

`Abstract` hide

`Abstract` isShowing

`Abstract` load

`Optional` options: any

`Abstract` maximize

`Abstract` minimize

`Protected` postProcessArgs

`Protected` preProcessArgs

`Protected` registerAndWrapListener

`Abstract` restore

`Abstract` setBounds

`Abstract` setParent

`Abstract` show

`Protected` unwrapAndUnRegisterListener