Class AbstractObserver<O>`Abstract`

Abstract Observer Class for all common code shared by all types of observers

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<string>
- AbstractObserver
  - AbstractMutationObserver

Implements

IObserver<O, string>

Index

Accessors

handlers

get handlers(): OSGeneric[]
Getter for handlers

Memberof
AbstractEvent

Returns OSGeneric[]
Implementation of IObserver.handlers

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

observerOptions

get observerOptions(): O
Getter for observerOptions

Memberof
AbstractObserver

Returns O
Implementation of IObserver.observerOptions
- Defined in OSFramework/OSUI/Event/DOMEvents/Observers/AbstractObserver.ts:48

observerTarget

get observerTarget(): HTMLElement
Getter for observerTarget

Memberof
AbstractObserver

Returns HTMLElement
Implementation of IObserver.observerTarget
- Defined in OSFramework/OSUI/Event/DOMEvents/Observers/AbstractObserver.ts:59

Methods

addHandler

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

Memberof
AbstractEvent
Parameters
- handler: OSGeneric
Returns void
Implementation of IObserver.addHandler

Inherited from AbstractEvent.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 IObserver.hasHandlers

Inherited from AbstractEvent.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 IObserver.removeHandler

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

trigger

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

Memberof
AbstractEvent
Parameters
- Optional data: string
- Rest ...args: unknown[]
Returns void
Implementation of IObserver.trigger

Inherited from AbstractEvent.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 IObserver.addEvent

Inherited from AbstractEvent.addEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:86

`Protected` startObserver

startObserver(): void
Returns void
- Defined in OSFramework/OSUI/Event/DOMEvents/Observers/AbstractObserver.ts:28

removeEvent

removeEvent(): void
Method to remove an Observer

Memberof
AbstractObserver

Returns void
Implementation of IObserver.removeEvent

Overrides AbstractEvent.removeEvent
- Defined in OSFramework/OSUI/Event/DOMEvents/Observers/AbstractObserver.ts:37

Properties

`Private` _observerOptions

_observerOptions: O

`Private` _observerTarget

_observerTarget: HTMLElement

`Protected` observer

observer: ResizeObserver | MutationObserver

Constructors

constructor

new AbstractObserver<O>(observerOptions: O, observerTarget: HTMLElement): AbstractObserver<O>
Type Parameters
- O
Parameters
- observerOptions: O
- observerTarget: HTMLElement
Returns AbstractObserver<O>
Overrides AbstractEvent.constructor
- Defined in OSFramework/OSUI/Event/DOMEvents/Observers/AbstractObserver.ts:21

Class AbstractObserver<O>Abstract

Export

Abstract

Implements

Type Parameters

O

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Accessors

Methods

Properties

Constructors

Accessors

handlers

Memberof

Returns OSGeneric[]

observerOptions

Memberof

Returns O

observerTarget

Memberof

Returns HTMLElement

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: string

Rest ...args: unknown[]

Returns void

Abstract addEvent

Abstract

Memberof

Returns void

Protected startObserver

Returns void

removeEvent

Memberof

Returns void

Properties

Private _observerOptions

Private _observerTarget

Protected observer

Constructors

constructor

Type Parameters

O

Parameters

observerOptions: O

observerTarget: HTMLElement

Returns AbstractObserver<O>

Settings

Member Visibility

Theme

Class AbstractObserver<O>`Abstract`

`Optional` data: string

`Rest` ...args: unknown[]

`Abstract` addEvent

`Protected` startObserver

`Private` _observerOptions

`Private` _observerTarget

`Protected` observer