Yahoo! UI Library

Wrapper class for the integration of new events into the YUI event infrastructure. Don't instantiate this object directly, use Y.Event.define( type, config ).

The configuration object must include the event type, and should include implementation methods for on and detach. This is the full list of configuration properties:

type

REQUIRED. The name of the synthetic event. What goes node.on(HERE, callback ).

on

function ( node, subscription, fireEvent ) The implementation logic for subscription. Any special setup you need to do to create the environment for the event being fired. E.g. native DOM event subscriptions. Store subscription related objects and information on the subscription object. When the criteria have been met to fire the synthetic event, call fireEvent.fire().

detach

function ( node, subscription, fireEvent ) The implementation logic for cleaning up a detached subscription. E.g. detach any DOM subscriptions done in on.

publishConfig

(Object) The configuration object that will be used to instantiate the underlying CustomEvent. By default, the event is defined with emitFacade: true so subscribers will receive a DOM-like event object.

processArgs

function ( argArray ) Optional method to extract any additional arguments from the subscription signature. Using this allows on signatures like node.on( "hover", overCallback, outCallback ). Be sure that the args passed in is pruned of any additional arguments using, for example, argArray.splice(2,1);. Data returned from the function will be stored on the subscription object passed to on and detach under subscription._extra.