Events
Source: Events.ts:26
Base events class to handle custom events.
Constructor
new Events(eventNames?: Array.<string>, sender?: *): EventsParameters
eventNames(Array.<string>, optional) — Event names that could be dispatched.sender(*, optional)
Instance Methods
registerNames(eventNames: Array.<string>)
Function that creates event object properties that would be dispatched.
Parameters
eventNames(Array.<string>) — Specified event names list.
_stamp(name: Object, obj: Object): boolean
protected
Events.ts:93Returns true if event callback has stamped.
Parameters
name(Object) — Event identifier.obj(Object) — Event callback.
Returns
boolean
on(
name: string,
callback: EventCallback,
sender?: any,
priority?: number,
)
Attach listener.
Parameters
name(string) — Event name to listen.callback(EventCallback) — Event callback function.sender(any, optional) — Event callback function owner.priority(number, optional, default: 0) — Priority of event callback.
off(name: string, callback: EventCallback | null)
Stop listening event name with specified callback function.
Parameters
name(string) — Event name.callback(EventCallback | null) — Attached event callback.
dispatch(event: EventCallbackHandler, ...args?: Object)
Dispatch event.
Parameters
event(EventCallbackHandler) — Event instance property that created by event name.args(Object, optional) — Callback parameters.
stopPropagation()
Brakes events propagation.
clear()
Removes all events.