@serenity-is/sleekgrid / EventDataWrapper
Class: EventDataWrapper<TArgs, TEvent>
Defined in: src/core/event.ts:118
Wraps a native DOM event and a payload object, exposing propagation controls.
Property access for common DOM fields (e.g. clientX, key, target) and arg keys
(grid, row, cell) is dynamically proxied via getters installed by
initializeEventDataProps().
Type Parameters
TArgs
TArgs
Event payload type.
TEvent
TEvent = { }
Wrapped native event type.
Implements
IEventData<TArgs,TEvent>
Constructors
Constructor
new EventDataWrapper<
TArgs,TEvent>(event?,args?):EventDataWrapper<TArgs,TEvent>
Defined in: src/core/event.ts:127
Parameters
event?
TEvent
args?
TArgs
Returns
EventDataWrapper<TArgs, TEvent>
Accessors
args
Get Signature
get args():
TArgs
Defined in: src/core/event.ts:189
Payload supplied by the event emitter (e.g. {row, cell, grid}).
Returns
TArgs
Payload supplied by the event emitter (e.g. {row, cell, grid}).
Implementation of
defaultPrevented
Get Signature
get defaultPrevented():
boolean
Defined in: src/core/event.ts:137
Whether IEventData.preventDefault has been called.
Returns
boolean
Whether IEventData.preventDefault has been called.
Implementation of
nativeEvent
Get Signature
get nativeEvent():
TEvent
Defined in: src/core/event.ts:207
The wrapped native DOM event, if any.
Returns
TEvent
The wrapped native DOM event, if any.
Implementation of
Methods
addReturnValue()
addReturnValue(
value):void
Defined in: src/core/event.ts:193
Parameters
value
any
Returns
void
getReturnValue()
getReturnValue():
any
Defined in: src/core/event.ts:203
Returns the last non-undefined return value from the handlers that have run.
Returns
any
Implementation of
getReturnValues()
getReturnValues():
any[]
Defined in: src/core/event.ts:199
Returns all return values collected from handlers.
Returns
any[]
Implementation of
isDefaultPrevented()
isDefaultPrevented():
boolean
Defined in: src/core/event.ts:144
Returns true if IEventData.preventDefault has been called or the native event is default-prevented.
Returns
boolean
Implementation of
isImmediatePropagationStopped()
isImmediatePropagationStopped():
boolean
Defined in: src/core/event.ts:185
Returns whether EventDataWrapper.stopImmediatePropagation was called on this event object.
Returns
boolean
true if immediate propagation was stopped.
Implementation of
IEventData.isImmediatePropagationStopped
isPropagationStopped()
isPropagationStopped():
boolean
Defined in: src/core/event.ts:169
Returns whether EventDataWrapper.stopPropagation was called on this event object.
Returns
boolean
true if propagation was stopped.
Implementation of
IEventData.isPropagationStopped
preventDefault()
preventDefault():
void
Defined in: src/core/event.ts:139
Prevents the default action associated with the event.
Returns
void
Implementation of
stopImmediatePropagation()
stopImmediatePropagation():
void
Defined in: src/core/event.ts:176
Prevents remaining handlers from being executed and stops DOM propagation.
Returns
void
Implementation of
IEventData.stopImmediatePropagation
stopPropagation()
stopPropagation():
void
Defined in: src/core/event.ts:160
Stops event from propagating up the DOM tree and marks it as propagation-stopped.
Returns
void