SyntheticEvent Class

Implementers MAY provide this method definition.

Implement this function if you want extra data extracted during processArgs to be propagated to subscriptions on a per-node basis. That is to say, if you call Y.on('xyz', fn, xtra, 'div') the data returned from processArgs will be shared across the subscription objects for all the divs. If you want each subscription to receive unique information, do that processing here.

The default implementation adds the data extracted by processArgs to the subscription object as sub._extra.

Implementers SHOULD provide this method definition.

Implementation logic for subscriptions done via node.delegate(type, fn, filter) or Y.delegate(type, fn, container, filter). Like with on() above, this function should monitor the environment for the event being fired, and trigger subscription execution by calling notifier.fire(e).

This function receives a fourth argument, which is the filter used to identify which Node's are of interest to the subscription. The filter will be either a boolean function that accepts a target Node for each hierarchy level as the event bubbles, or a selector string. To translate selector strings into filter functions, use Y.delegate.compileFilter(filter).

Implementers SHOULD provide this method definition.

Implementation logic for detaching subscriptions done via node.on(type, fn). This function should clean up any subscriptions made in the on() phase.

Implementers SHOULD provide this method definition.

Implementation logic for detaching subscriptions done via node.delegate(type, fn, filter) or Y.delegate(type, fn, container, filter). This function should clean up any subscriptions made in the delegate() phase.

Returns the detach handles of subscriptions on a node that satisfy a search/filter function. By default, the filter used is the subMatch method.

Implementers SHOULD provide this method definition.

Implementation logic for subscriptions done via node.on(type, fn) or Y.on(type, fn, target). This function should set up the monitor(s) that will eventually fire the event. Typically this involves subscribing to at least one DOM event. It is recommended to store detach handles from any DOM subscriptions to make for easy cleanup in the detach method. Typically these handles are added to the sub object. Also for SyntheticEvents that leverage a single DOM subscription under the hood, it is recommended to pass the DOM event object to notifier.fire(e). (The event name on the object will be updated).

Implementers MAY provide this method definition.

Implement this function if the event supports a different subscription signature. This function is used by both on() and delegate(). The second parameter indicates that the event is being subscribed via delegate().

Implementations must remove extra arguments from the args list before returning. The required args for on() subscriptions are

[type, callback, target, context, argN...]

The required args for delegate() subscriptions are

[type, callback, target, filter, context, argN...]

The return value from this function will be stored on the subscription in the '_extra' property for reference elsewhere.

Implementers MAY override this to define what constitutes a "same" subscription. Override implementations should consider the lack of a comparator as a match, so calling getSubs() with no arguments will return all subs.

Compares a set of subscription arguments against a Subscription object to determine if they match. The default implementation compares the callback function against the second argument passed to Y.on(...) or node.detach(...) etc.