Class AbstractListener<T>`Abstract`

Abstract class that will be responsible for the basic behaviours of a listener, namely storing the callbacks.

Export

AbstractListener

Implements

Type Parameters

T

Hierarchy (View Summary)

AbstractEvent<T>
- AbstractListener

Implements

IListener

Index

Constructors

Properties

eventCallback useCapture

Accessors

handlers eventTarget

Methods

addHandler hasHandler hasHandlers removeHandler trigger addEvent removeEvent

Constructors

constructor

new AbstractListener<T>(
    eventTarget: HTMLElement | Document | Window,
    eventType: HTMLEvent | BalloonOnToggle,
    isCustomEvent?: boolean,
): AbstractListener<T>
Creates an instance of AbstractListener.
Type Parameters
- T
Parameters
- eventTarget: HTMLElement | Document | Window
- eventType: HTMLEvent | BalloonOnToggle
- OptionalisCustomEvent: boolean = false
Returns AbstractListener<T>

Memberof
AbstractListener
Overrides AbstractEvent.constructor
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/AbstractListener.ts:44

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
Implementation of IListener.handlers

Inherited from AbstractEvent.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
- 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
Implementation of IListener.addHandler

Inherited from AbstractEvent.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
Implementation of IListener.hasHandler

Inherited from AbstractEvent.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
Implementation of IListener.hasHandlers

Inherited from AbstractEvent.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
Implementation of IListener.removeHandler

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

trigger

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

Memberof
AbstractEvent
Implementation of IListener.trigger

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

addEvent

addEvent(): void
Method to add a new eventListener

Returns void

Memberof
AbstractListener
Implementation of IListener.addEvent

Overrides AbstractEvent.addEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/AbstractListener.ts:69

removeEvent

removeEvent(): void
Method to remove a eventListener

Returns void

Memberof
AbstractListener
Implementation of IListener.removeEvent

Overrides AbstractEvent.removeEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/AbstractListener.ts:81