Class BodyOnClick

Class that represents the click on the body event.

Export

Hierarchy-Diagram

Legend

class

abstract class

protected property

private property

public method

private method

Hierarchy

AbstractListener<string>
- BodyOnClick

Index

Accessors

handlers

get handlers(): OSGeneric[]
Getter for handlers

Memberof
AbstractEvent

Returns OSGeneric[]
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

Memberof
AbstractListener

Returns HTMLElement | Document | Window
Inherited from AbstractListener.eventTarget
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/AbstractListener.ts:95

getBodyClickStatus

get getBodyClickStatus(): boolean
Getter that returns the body click status

Memberof
BodyOnClick

Returns boolean
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/BodyOnClick.ts:52

Methods

addHandler

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

Memberof
AbstractEvent
Parameters
- handler: OSGeneric
Returns void
Inherited from AbstractListener.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
Inherited from AbstractListener.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
Inherited from AbstractListener.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
Inherited from AbstractListener.trigger
- Defined in OSFramework/OSUI/Event/DOMEvents/AbstractEvent.ts:76

addEvent

addEvent(): void
Method to add a new eventListener

Memberof
AbstractListener

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

removeEvent

removeEvent(): void
Method to remove a eventListener

Memberof
AbstractListener

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

`Private` _bodyTrigger

_bodyTrigger(evt: PointerEvent): void
Parameters
- evt: PointerEvent
Returns void
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/BodyOnClick.ts:20

disableBodyClickEvent

disableBodyClickEvent(): void
This method is to disable the body click on detached patterns

Memberof
BodyOnClick

Returns void
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/BodyOnClick.ts:32

enableBodyClickEvent

enableBodyClickEvent(): void
This method is to enable the body click on detached patterns

Memberof
BodyOnClick

Returns void
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/BodyOnClick.ts:41

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

`Private` _enableBodyClick

_enableBodyClick: boolean = true

Constructors

constructor

new BodyOnClick(): BodyOnClick
Returns BodyOnClick
Overrides AbstractListener.constructor
- Defined in OSFramework/OSUI/Event/DOMEvents/Listeners/BodyOnClick.ts:14

Class BodyOnClick

Export

Hierarchy-Diagram

Legend

Hierarchy

Index

Accessors

Methods

Properties

Constructors

Accessors

handlers

Memberof

Returns OSGeneric[]

eventTarget

Memberof

Returns HTMLElement | Document | Window

getBodyClickStatus

Memberof

Returns boolean

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

addEvent

Memberof

Returns void

removeEvent

Memberof

Returns void

Private _bodyTrigger

Parameters

evt: PointerEvent

Returns void

disableBodyClickEvent

Memberof

Returns void

enableBodyClickEvent

Memberof

Returns void

Properties

Protected eventCallback

Memberof

Protected useCapture

Memberof

Private _enableBodyClick

Constructors

constructor

Returns BodyOnClick

Settings

Member Visibility

Theme

`Optional` data: string

`Rest` ...args: unknown[]

`Private` _bodyTrigger

`Protected` eventCallback

`Protected` useCapture

`Private` _enableBodyClick