Class AbstractEvent<T>`Abstract`

Abstract class that will be responsible for the basic behaviours of an event, namely storing the handlers and their manipulation.

Export

Abstract

Implements

Type Parameters

Hierarchy-Diagram

Legend

abstract class

interface

public property

protected property

private property

public method

protected method

italic abstract property/method

Hierarchy

AbstractEvent
- AbstractListener
- AbstractObserver

Implements

IEvent<T>

Index

Constructors

constructor

new AbstractEvent<T>(): AbstractEvent<T>
Type Parameters
- T
Returns AbstractEvent<T>

Properties

`Private` _handlers

_handlers: OSGeneric[] = []

Accessors

handlers

get handlers(): OSGeneric[]
Getter for handlers

Memberof
AbstractEvent

Returns OSGeneric[]
Implementation of IEvent.handlers
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:24

Methods

addHandler

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

Memberof
AbstractEvent
Parameters
- handler: OSGeneric
Returns void
Implementation of IEvent.addHandler
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:34

hasHandlers

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

Returns
{boolean}

Memberof
AbstractEvent

Returns boolean
Implementation of IEvent.hasHandlers
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:44

removeHandler

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

Memberof
AbstractEvent
Parameters
- handler: OSGeneric
Returns void
Implementation of IEvent.removeHandler
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:54

trigger

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

Memberof
AbstractEvent
Parameters
- Optional data: T
- Rest ...args: unknown[]
Returns void
Implementation of IEvent.trigger
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:76

`Abstract` addEvent

addEvent(): void
Mandatory method implemenation to add events. this will be different, if it's a listener or an observer

Abstract

Memberof
AbstractEvent

Returns void
Implementation of IEvent.addEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:86

`Abstract` removeEvent

removeEvent(): void
Mandatory method implemenation to remove events. this will be different, if it's a listener or an observer

Abstract

Memberof
AbstractEvent

Returns void
Implementation of IEvent.removeEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:94

Class AbstractEvent<T>Abstract

Export

Abstract

Implements

Type Parameters

T

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Returns AbstractEvent<T>

Properties

Private _handlers

Accessors

handlers

Memberof

Returns OSGeneric[]

Methods

addHandler

Memberof

Parameters

handler: OSGeneric

Returns void

hasHandlers

Returns

Memberof

Returns boolean

removeHandler

Memberof

Parameters

handler: OSGeneric

Returns void

trigger

Memberof

Parameters

Optional data: T

Rest ...args: unknown[]

Returns void

Abstract addEvent

Abstract

Memberof

Returns void

Abstract removeEvent

Abstract

Memberof

Returns void

Settings

Member Visibility

Theme

Class AbstractEvent<T>`Abstract`

`Private` _handlers

`Optional` data: T

`Rest` ...args: unknown[]

`Abstract` addEvent

`Abstract` removeEvent