@serenity-is/sleekgrid / EventDataWrapper

Class: EventDataWrapper<TArgs, TEvent>

Defined in: src/core/event.ts:78

An event object for passing data to event handlers and letting them control propagation.

This is pretty much identical to how W3C and jQuery implement events.

Type Parameters

TArgs

TArgs

TEvent

TEvent = { }

Implements

Constructors

Constructor

new EventDataWrapper<TArgs, TEvent>(event?, args?): EventDataWrapper<TArgs, TEvent>

Defined in: src/core/event.ts:87

Parameters

event?

TEvent

args?

TArgs

Returns

EventDataWrapper<TArgs, TEvent>

Accessors

args

Get Signature

get args(): TArgs

Defined in: src/core/event.ts:147

Returns

TArgs

Implementation of

IEventData.args


defaultPrevented

Get Signature

get defaultPrevented(): boolean

Defined in: src/core/event.ts:97

Returns

boolean

Implementation of

IEventData.defaultPrevented


nativeEvent

Get Signature

get nativeEvent(): TEvent

Defined in: src/core/event.ts:165

Returns

TEvent

Implementation of

IEventData.nativeEvent

Methods

addReturnValue()

addReturnValue(value): void

Defined in: src/core/event.ts:151

Parameters

value

any

Returns

void


getReturnValue()

getReturnValue(): any

Defined in: src/core/event.ts:161

Returns

any

Implementation of

IEventData.getReturnValue


getReturnValues()

getReturnValues(): any[]

Defined in: src/core/event.ts:157

Returns

any[]

Implementation of

IEventData.getReturnValues


isDefaultPrevented()

isDefaultPrevented(): any

Defined in: src/core/event.ts:104

Returns

any

Implementation of

IEventData.isDefaultPrevented


isImmediatePropagationStopped()

isImmediatePropagationStopped(): boolean

Defined in: src/core/event.ts:143

Returns whether stopImmediatePropagation was called on this event object.\

Returns

boolean

Implementation of

IEventData.isImmediatePropagationStopped


isPropagationStopped()

isPropagationStopped(): boolean

Defined in: src/core/event.ts:128

Returns whether stopPropagation was called on this event object.

Returns

boolean

Implementation of

IEventData.isPropagationStopped


preventDefault()

preventDefault(): void

Defined in: src/core/event.ts:99

Returns

void

Implementation of

IEventData.preventDefault


stopImmediatePropagation()

stopImmediatePropagation(): void

Defined in: src/core/event.ts:135

Prevents the rest of the handlers from being executed.

Returns

void

Implementation of

IEventData.stopImmediatePropagation


stopPropagation()

stopPropagation(): void

Defined in: src/core/event.ts:120

Stops event from propagating up the DOM tree.

Returns

void

Implementation of

IEventData.stopPropagation