Class ElectronContainerWindow

Hierarchy

ContainerWindow
- ElectronContainerWindow

Constructors

constructor

new ElectronContainerWindow(wrap: any, container: ElectronContainer, win?: Window): ElectronContainerWindow
Parameters
- wrap: any
- container: ElectronContainer
- Optional win: Window
Returns ElectronContainerWindow
Overrides ContainerWindow.constructor
- Defined in desktopjs-electron/src/electron.ts:55

Properties

`Readonly` innerWindow

innerWindow: any

The underlying concrete container window.

Accessors

allowGrouping

get allowGrouping(): boolean
Returns boolean
Overrides ContainerWindow.allowGrouping
- Defined in desktopjs-electron/src/electron.ts:142

id

get id(): string
Returns string
Overrides ContainerWindow.id
- Defined in desktopjs-electron/src/electron.ts:65

name

get name(): string
Returns string
Overrides ContainerWindow.name
- Defined in desktopjs-electron/src/electron.ts:69

nativeWindow

get nativeWindow(): Window
Returns Window
Overrides ContainerWindow.nativeWindow
- Defined in desktopjs-electron/src/electron.ts:216

`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/dist/desktopjs.d.ts:174

Methods

addListener

addListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): ElectronContainerWindow
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 ElectronContainerWindow
Inherited from ContainerWindow.addListener
- Defined in desktopjs/dist/desktopjs.d.ts:529

`Protected` attachListener

attachListener(eventName: string, listener: ((...args: any[]) => void)): void
Parameters
- eventName: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides ContainerWindow.attachListener
- Defined in desktopjs-electron/src/electron.ts:199

bringToFront

bringToFront(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.bringToFront
- Defined in desktopjs-electron/src/electron.ts:174

close

close(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.close
- Defined in desktopjs-electron/src/electron.ts:93

`Protected` detachListener

detachListener(eventName: string, listener: ((...args: any[]) => void)): void
Parameters
- eventName: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides ContainerWindow.detachListener
- Defined in desktopjs-electron/src/electron.ts:212

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/dist/desktopjs.d.ts:170

flash

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

focus

focus(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.focus
- Defined in desktopjs-electron/src/electron.ts:81

getBounds

getBounds(): Promise<Rectangle>
Returns Promise<Rectangle>
Overrides ContainerWindow.getBounds
- Defined in desktopjs-electron/src/electron.ts:133

getGroup

getGroup(): Promise<ContainerWindow[]>
Returns Promise<ContainerWindow[]>
Overrides ContainerWindow.getGroup
- Defined in desktopjs-electron/src/electron.ts:146

getOptions

getOptions(): Promise<any>
Returns Promise<any>
Overrides ContainerWindow.getOptions
- Defined in desktopjs-electron/src/electron.ts:178

getParent

getParent(): Promise<ContainerWindow>
Returns Promise<ContainerWindow>
Overrides ContainerWindow.getParent
- Defined in desktopjs-electron/src/electron.ts:125

getSnapshot

getSnapshot(): Promise<string>
Returns Promise<string>
Overrides ContainerWindow.getSnapshot
- Defined in desktopjs-electron/src/electron.ts:113

getState

getState(): Promise<any>
Returns Promise<any>
Overrides ContainerWindow.getState
- Defined in desktopjs-electron/src/electron.ts:186

hide

hide(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.hide
- Defined in desktopjs-electron/src/electron.ts:89

isShowing

isShowing(): Promise<any>
Returns Promise<any>
Overrides ContainerWindow.isShowing
- Defined in desktopjs-electron/src/electron.ts:109

joinGroup

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

leaveGroup

leaveGroup(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.leaveGroup
- Defined in desktopjs-electron/src/electron.ts:166

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/dist/desktopjs.d.ts:164

load

load(url: string, options?: any): Promise<void>
Parameters
- url: string
- Optional options: any
Returns Promise<void>
Overrides ContainerWindow.load
- Defined in desktopjs-electron/src/electron.ts:73

maximize

maximize(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.maximize
- Defined in desktopjs-electron/src/electron.ts:97

minimize

minimize(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.minimize
- Defined in desktopjs-electron/src/electron.ts:101

`Protected` postProcessArgs

postProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from ContainerWindow.postProcessArgs
- Defined in desktopjs/dist/desktopjs.d.ts:152

`Protected` preProcessArgs

preProcessArgs(args: EventArgs): void
Parameters
- args: EventArgs
Returns void
Inherited from ContainerWindow.preProcessArgs
- Defined in desktopjs/dist/desktopjs.d.ts:151

`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/dist/desktopjs.d.ts:149

removeListener

removeListener(eventName: WindowEventType, listener: ((event: EventArgs) => void)): ElectronContainerWindow
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 ElectronContainerWindow
Inherited from ContainerWindow.removeListener
- Defined in desktopjs/dist/desktopjs.d.ts:539

restore

restore(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.restore
- Defined in desktopjs-electron/src/electron.ts:105

setBounds

setBounds(bounds: Rectangle): Promise<void>
Parameters
- bounds: Rectangle
Returns Promise<void>
Overrides ContainerWindow.setBounds
- Defined in desktopjs-electron/src/electron.ts:138

setParent

setParent(parent: ContainerWindow): Promise<void>
Parameters
- parent: ContainerWindow
Returns Promise<void>
Overrides ContainerWindow.setParent
- Defined in desktopjs-electron/src/electron.ts:129

setState

setState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Overrides ContainerWindow.setState
- Defined in desktopjs-electron/src/electron.ts:192

show

show(): Promise<void>
Returns Promise<void>
Overrides ContainerWindow.show
- Defined in desktopjs-electron/src/electron.ts:85

`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/dist/desktopjs.d.ts:153

`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/dist/desktopjs.d.ts:150

`Static` addListener

addListener(eventName: WindowEventType, listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)): void
Parameters
- eventName: WindowEventType
- listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)
  - - (event: WindowEventArgs | WindowGroupEventArgs): void
    - Parameters
      
      event: WindowEventArgs | WindowGroupEventArgs
      
      Returns void
Returns void
Inherited from ContainerWindow.addListener
- Defined in desktopjs/dist/desktopjs.d.ts:540

`Static` emit

emit(eventName: WindowEventType, eventArgs: WindowEventArgs | WindowGroupEventArgs): void
Parameters
- eventName: WindowEventType
- eventArgs: WindowEventArgs | WindowGroupEventArgs
Returns void
Inherited from ContainerWindow.emit
- Defined in desktopjs/dist/desktopjs.d.ts:542

`Static` listeners

listeners(eventName: string): ((event: EventArgs) => void)[]
Parameters
- eventName: string
Returns ((event: EventArgs) => void)[]
Inherited from ContainerWindow.listeners
- Defined in desktopjs/dist/desktopjs.d.ts:543

`Static` removeListener

removeListener(eventName: WindowEventType, listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)): void
Parameters
- eventName: WindowEventType
- listener: ((event: WindowEventArgs | WindowGroupEventArgs) => void)
  - - (event: WindowEventArgs | WindowGroupEventArgs): void
    - Parameters
      
      event: WindowEventArgs | WindowGroupEventArgs
      
      Returns void
Returns void
Inherited from ContainerWindow.removeListener
- Defined in desktopjs/dist/desktopjs.d.ts:541

Class ElectronContainerWindow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wrap: any

container: ElectronContainer

Optional win: Window

Returns ElectronContainerWindow

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 ElectronContainerWindow

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>

`Optional` win: Window

`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