Class WindowMessage

Class that represents the Post Message on the Window.

Export

WindowMessage

Hierarchy (View Summary)

AbstractListener<string>
- WindowMessage

Index

Constructors

Properties

eventCallback useCapture

Accessors

handlers eventTarget

Methods

addHandler hasHandler hasHandlers removeHandler trigger addEvent removeEvent

Constructors

constructor

new WindowMessage(): WindowMessage
Returns WindowMessage
Overrides AbstractListener.constructor
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/WindowOnMessage.ts:11

Properties

`Protected`eventCallback

eventCallback: EventListenerObject

Store the listener callback

Memberof

AbstractListener

`Protected`useCapture

useCapture: boolean = false

Flag to indicate if event will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree.

Memberof

AbstractListener

Accessors

handlers

get handlers(): OSGeneric[]
Getter for handlers

Returns OSGeneric[]

Memberof
AbstractEvent
Inherited from AbstractListener.handlers
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:24

eventTarget

get eventTarget(): HTMLElement | Document | Window
Getter that allows to obtain the eventTarget reference

Returns HTMLElement | Document | Window

Memberof
AbstractListener
Inherited from AbstractListener.eventTarget
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/AbstractListener.ts:95

Methods

addHandler

addHandler(handler: OSGeneric): void
Method to add a new handler
Parameters
- handler: OSGeneric
Returns void

Memberof
AbstractEvent
Inherited from AbstractListener.addHandler
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:34

hasHandler

hasHandler(handler: OSGeneric): boolean
Method to check if the Array has a given handler
Parameters
- handler: OSGeneric
Returns boolean
{boolean}

Memberof
AbstractEvent
Inherited from AbstractListener.hasHandler
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:45

hasHandlers

hasHandlers(): boolean
Method to check if the Array has handlers

Returns boolean
{boolean}

Memberof
AbstractEvent
Inherited from AbstractListener.hasHandlers
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:55

removeHandler

removeHandler(handler: OSGeneric): void
Method to remove a given handler
Parameters
- handler: OSGeneric
Returns void

Memberof
AbstractEvent
Inherited from AbstractListener.removeHandler
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:65

trigger

trigger(data?: string, ...args: unknown[]): void
Method to trigger ahh handlers on the Array
Parameters
- Optionaldata: string
- ...args: unknown[]
Returns void

Memberof
AbstractEvent
Inherited from AbstractListener.trigger
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:87

addEvent

addEvent(): void
Method to add a new eventListener

Returns void

Memberof
AbstractListener
Inherited from AbstractListener.addEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/AbstractListener.ts:69

removeEvent

removeEvent(): void
Method to remove a eventListener

Returns void

Memberof
AbstractListener
Inherited from AbstractListener.removeEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/AbstractListener.ts:81