Class DefaultContainerWindow

Hierarchy

ContainerWindow
- DefaultContainerWindow

Constructors

constructor

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

Properties

`Readonly` innerWindow

innerWindow: any

The underlying concrete container window.

Accessors

allowGrouping

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

id

get id(): string
Returns string
Overrides ContainerWindow.id
- Defined in desktopjs/src/Default/default.ts:41

name

get name(): string
Returns string
Overrides ContainerWindow.name
- Defined in desktopjs/src/Default/default.ts:45

nativeWindow

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

Returns Window
Overrides ContainerWindow.nativeWindow
- Defined in desktopjs/src/Default/default.ts:135

`Static` ipc

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

Methods

addListener

addListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): DefaultContainerWindow
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 DefaultContainerWindow
Inherited from ContainerWindow.addListener
- Defined in desktopjs/src/window.ts:206

`Protected` attachListener

attachListener(eventName: string, listener: ((...args: any[]) => void)): void
Override to provide custom container logic for adding an event handler.
Parameters
- eventName: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides ContainerWindow.attachListener
- Defined in desktopjs/src/Default/default.ts:127

bringToFront

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

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>
Overrides ContainerWindow.close
- Defined in desktopjs/src/Default/default.ts:65

`Protected` detachListener

detachListener(eventName: string, listener: ((...args: any[]) => void)): void
Override to provide custom container logic for removing an event handler.
Parameters
- eventName: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides ContainerWindow.detachListener
- Defined in desktopjs/src/Default/default.ts:131

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 ContainerWindow.emit
- Defined in desktopjs/src/events.ts:122

flash

flash(enable: boolean, options?: any): Promise<void>
Parameters
- enable: boolean
- Optional options: any
Returns Promise<void>
Overrides ContainerWindow.flash
- Defined in desktopjs/src/Default/default.ts:90

focus

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

Returns Promise<void>
Overrides ContainerWindow.focus
- Defined in desktopjs/src/Default/default.ts:53

getBounds

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

Returns Promise<Rectangle>
Overrides ContainerWindow.getBounds
- Defined in desktopjs/src/Default/default.ts:103

getGroup

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

getOptions

getOptions(): Promise<any>
Returns Promise<any>
Overrides ContainerWindow.getOptions
- Defined in desktopjs/src/Default/default.ts:112

getParent

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

Returns Promise<ContainerWindow>
Overrides ContainerWindow.getParent
- Defined in desktopjs/src/Default/default.ts:94

getSnapshot

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

Returns Promise<string>
Overrides ContainerWindow.getSnapshot
- Defined in desktopjs/src/Default/default.ts:86

getState

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

Returns Promise<any>
Overrides ContainerWindow.getState
- Defined in desktopjs/src/Default/default.ts:116

hide

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

Returns Promise<void>
Overrides ContainerWindow.hide
- Defined in desktopjs/src/Default/default.ts:61

isShowing

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

Returns Promise<boolean>
Overrides ContainerWindow.isShowing
- Defined in desktopjs/src/Default/default.ts:81

joinGroup

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

leaveGroup

leaveGroup(): Promise<void>
Returns Promise<void>
Inherited from ContainerWindow.leaveGroup
- 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 ContainerWindow.listeners
- Defined in desktopjs/src/events.ts:113

load

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

maximize

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

Returns Promise<void>
Overrides ContainerWindow.maximize
- Defined in desktopjs/src/Default/default.ts:73

minimize

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

Returns Promise<void>
Overrides ContainerWindow.minimize
- Defined in desktopjs/src/Default/default.ts:69

`Protected` postProcessArgs

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

`Protected` preProcessArgs

preProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from ContainerWindow.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 ContainerWindow.registerAndWrapListener
- Defined in desktopjs/src/events.ts:56

removeListener

removeListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): DefaultContainerWindow
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 DefaultContainerWindow
Inherited from ContainerWindow.removeListener
- Defined in desktopjs/src/window.ts:222

restore

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

Returns Promise<void>
Overrides ContainerWindow.restore
- Defined in desktopjs/src/Default/default.ts:77

setBounds

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

setParent

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

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>
Overrides ContainerWindow.setState
- Defined in desktopjs/src/Default/default.ts:120

show

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

Returns Promise<void>
Overrides ContainerWindow.show
- Defined in desktopjs/src/Default/default.ts:57

`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 ContainerWindow.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 ContainerWindow.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
Inherited from ContainerWindow.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
Inherited from ContainerWindow.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)[]
Inherited from ContainerWindow.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
Inherited from ContainerWindow.removeListener
- Defined in desktopjs/src/window.ts:232

Class DefaultContainerWindow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wrap: any

Returns DefaultContainerWindow

Properties

Readonly innerWindow

Accessors

allowGrouping

Returns boolean

id

Returns string

name

Returns string

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 DefaultContainerWindow

Protected attachListener

Parameters

eventName: string

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

bringToFront

Returns Promise<void>

close

Returns Promise<void>

Protected detachListener

Parameters

eventName: string

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

emit

Parameters

eventName: string

eventArgs: EventArgs

Returns void

flash

Parameters

enable: boolean

Optional options: any

Returns Promise<void>

focus

Returns Promise<void>

getBounds

Returns Promise<Rectangle>

getGroup

Returns Promise<ContainerWindow[]>

getOptions

Returns Promise<any>

getParent

Returns Promise<ContainerWindow>

getSnapshot

Returns Promise<string>

getState

Returns Promise<any>

`Readonly` innerWindow

`Static` ipc

`Protected` attachListener

`Rest` ...args: any[]

`Protected` detachListener

`Rest` ...args: any[]

`Optional` options: any

`Optional` options: any

`Protected` postProcessArgs

`Protected` preProcessArgs

`Protected` registerAndWrapListener

`Protected` unwrapAndUnRegisterListener