src/cm/media/js/lib/yui/yui3-3.15.0/build/event-custom-base/event-custom-base-debug.js
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 602 e16a97fb364a
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('event-custom-base', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
 * Custom event engine, DOM event listener abstraction layer, synthetic DOM
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
 * events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
 * @module event-custom
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
Y.Env.evt = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
    handles: {},
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
    plugins: {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
 * Custom event engine, DOM event listener abstraction layer, synthetic DOM
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
 * events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
 * @module event-custom
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
 * @submodule event-custom-base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
 * Allows for the insertion of methods that are executed before or after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
 * a specified method
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
 * @class Do
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
 * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
var DO_BEFORE = 0,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
    DO_AFTER = 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
DO = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
     * Cache of objects touched by the utility
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
     * @property objs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
     * @deprecated Since 3.6.0. The `_yuiaop` property on the AOP'd object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
     * replaces the role of this property, but is considered to be private, and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
     * is only mentioned to provide a migration path.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
     * If you have a use case which warrants migration to the _yuiaop property,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
     * please file a ticket to let us know what it's used for and we can see if
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
     * we need to expose hooks for that functionality more formally.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
    objs: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
     * <p>Execute the supplied method before the specified function.  Wrapping
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
     * function may optionally return an instance of the following classes to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
     * further alter runtime behavior:</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
     * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
     *     <dt></code>Y.Do.Halt(message, returnValue)</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
     *         <dd>Immediatly stop execution and return
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
     *         <code>returnValue</code>.  No other wrapping functions will be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
     *         executed.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
     *     <dt></code>Y.Do.AlterArgs(message, newArgArray)</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
     *         <dd>Replace the arguments that the original function will be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
     *         called with.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
     *     <dt></code>Y.Do.Prevent(message)</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
     *         <dd>Don't execute the wrapped function.  Other before phase
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
     *         wrappers will be executed.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
     * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
     * @method before
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
     * @param fn {Function} the function to execute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
     * @param obj the object hosting the method to displace
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
     * @param sFn {string} the name of the method to displace
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
     * @param c The execution context for fn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
     * @param arg* {mixed} 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
     * when the event fires.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
     * @return {string} handle for the subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
    before: function(fn, obj, sFn, c) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
        // Y.log('Do before: ' + sFn, 'info', 'event');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
        var f = fn, a;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
        if (c) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
            a = [fn, c].concat(Y.Array(arguments, 4, true));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
            f = Y.rbind.apply(Y, a);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
        return this._inject(DO_BEFORE, f, obj, sFn);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
     * <p>Execute the supplied method after the specified function.  Wrapping
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
     * function may optionally return an instance of the following classes to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
     * further alter runtime behavior:</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
     * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
     *     <dt></code>Y.Do.Halt(message, returnValue)</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
     *         <dd>Immediatly stop execution and return
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
     *         <code>returnValue</code>.  No other wrapping functions will be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
     *         executed.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
     *     <dt></code>Y.Do.AlterReturn(message, returnValue)</code></dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
     *         <dd>Return <code>returnValue</code> instead of the wrapped
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
     *         method's original return value.  This can be further altered by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
     *         other after phase wrappers.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
     * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
     * <p>The static properties <code>Y.Do.originalRetVal</code> and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
     * <code>Y.Do.currentRetVal</code> will be populated for reference.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
     * @method after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
     * @param fn {Function} the function to execute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
     * @param obj the object hosting the method to displace
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
     * @param sFn {string} the name of the method to displace
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
     * @param c The execution context for fn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
     * @param arg* {mixed} 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
     * @return {string} handle for the subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
    after: function(fn, obj, sFn, c) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
        var f = fn, a;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
        if (c) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
            a = [fn, c].concat(Y.Array(arguments, 4, true));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
            f = Y.rbind.apply(Y, a);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
        return this._inject(DO_AFTER, f, obj, sFn);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
     * Execute the supplied method before or after the specified function.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
     * Used by <code>before</code> and <code>after</code>.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
     * @method _inject
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
     * @param when {string} before or after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
     * @param fn {Function} the function to execute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
     * @param obj the object hosting the method to displace
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
     * @param sFn {string} the name of the method to displace
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
     * @param c The execution context for fn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
     * @return {string} handle for the subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
    _inject: function(when, fn, obj, sFn) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
        // object id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
        var id = Y.stamp(obj), o, sid;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
        if (!obj._yuiaop) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
            // create a map entry for the obj if it doesn't exist, to hold overridden methods
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
            obj._yuiaop = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
        o = obj._yuiaop;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
        if (!o[sFn]) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
            // create a map entry for the method if it doesn't exist
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
            o[sFn] = new Y.Do.Method(obj, sFn);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
            // re-route the method to our wrapper
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
            obj[sFn] = function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
                return o[sFn].exec.apply(o[sFn], arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
            };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
        // subscriber id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
        sid = id + Y.stamp(fn) + sFn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
        // register the callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
        o[sFn].register(sid, fn, when);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
        return new Y.EventHandle(o[sFn], sid);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
     * Detach a before or after subscription.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
     * @method detach
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
     * @param handle {string} the subscription handle
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
    detach: function(handle) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
        if (handle.detach) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
            handle.detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   181
Y.Do = DO;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   182
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   183
//////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   185
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   186
 * Contains the return value from the wrapped method, accessible
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   187
 * by 'after' event listeners.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   188
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   189
 * @property originalRetVal
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   190
 * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   191
 * @since 3.2.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   192
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   193
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   194
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   195
 * Contains the current state of the return value, consumable by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   196
 * 'after' event listeners, and updated if an after subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   197
 * changes the return value generated by the wrapped function.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   198
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   199
 * @property currentRetVal
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   200
 * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   201
 * @since 3.2.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   202
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   203
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   204
//////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   205
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   206
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   207
 * Wrapper for a displaced method with aop enabled
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   208
 * @class Do.Method
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   209
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   210
 * @param obj The object to operate on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   211
 * @param sFn The name of the method to displace
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   212
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   213
DO.Method = function(obj, sFn) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   214
    this.obj = obj;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   215
    this.methodName = sFn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   216
    this.method = obj[sFn];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   217
    this.before = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   218
    this.after = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   219
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   220
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   221
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   222
 * Register a aop subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   223
 * @method register
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   224
 * @param sid {string} the subscriber id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   225
 * @param fn {Function} the function to execute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   226
 * @param when {string} when to execute the function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   227
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   228
DO.Method.prototype.register = function (sid, fn, when) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   229
    if (when) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   230
        this.after[sid] = fn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   231
    } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   232
        this.before[sid] = fn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   233
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   234
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   235
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   236
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   237
 * Unregister a aop subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   238
 * @method delete
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   239
 * @param sid {string} the subscriber id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   240
 * @param fn {Function} the function to execute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   241
 * @param when {string} when to execute the function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   242
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   243
DO.Method.prototype._delete = function (sid) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   244
    // Y.log('Y.Do._delete: ' + sid, 'info', 'Event');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   245
    delete this.before[sid];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   246
    delete this.after[sid];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   247
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   248
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   249
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   250
 * <p>Execute the wrapped method.  All arguments are passed into the wrapping
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   251
 * functions.  If any of the before wrappers return an instance of
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   252
 * <code>Y.Do.Halt</code> or <code>Y.Do.Prevent</code>, neither the wrapped
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   253
 * function nor any after phase subscribers will be executed.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   254
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   255
 * <p>The return value will be the return value of the wrapped function or one
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   256
 * provided by a wrapper function via an instance of <code>Y.Do.Halt</code> or
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   257
 * <code>Y.Do.AlterReturn</code>.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   258
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   259
 * @method exec
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   260
 * @param arg* {any} Arguments are passed to the wrapping and wrapped functions
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   261
 * @return {any} Return value of wrapped function unless overwritten (see above)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   262
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   263
DO.Method.prototype.exec = function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   264
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   265
    var args = Y.Array(arguments, 0, true),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   266
        i, ret, newRet,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   267
        bf = this.before,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   268
        af = this.after,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   269
        prevented = false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   270
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   271
    // execute before
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   272
    for (i in bf) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   273
        if (bf.hasOwnProperty(i)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   274
            ret = bf[i].apply(this.obj, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   275
            if (ret) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   276
                switch (ret.constructor) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   277
                    case DO.Halt:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   278
                        return ret.retVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   279
                    case DO.AlterArgs:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   280
                        args = ret.newArgs;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   281
                        break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   282
                    case DO.Prevent:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   283
                        prevented = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   284
                        break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   285
                    default:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   286
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   287
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   288
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   289
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   290
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   291
    // execute method
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   292
    if (!prevented) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   293
        ret = this.method.apply(this.obj, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   294
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   295
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   296
    DO.originalRetVal = ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   297
    DO.currentRetVal = ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   298
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   299
    // execute after methods.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   300
    for (i in af) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   301
        if (af.hasOwnProperty(i)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   302
            newRet = af[i].apply(this.obj, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   303
            // Stop processing if a Halt object is returned
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   304
            if (newRet && newRet.constructor === DO.Halt) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   305
                return newRet.retVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   306
            // Check for a new return value
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   307
            } else if (newRet && newRet.constructor === DO.AlterReturn) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   308
                ret = newRet.newRetVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   309
                // Update the static retval state
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   310
                DO.currentRetVal = ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   311
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   312
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   313
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   314
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   315
    return ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   316
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   317
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   318
//////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   319
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   320
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   321
 * Return an AlterArgs object when you want to change the arguments that
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   322
 * were passed into the function.  Useful for Do.before subscribers.  An
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   323
 * example would be a service that scrubs out illegal characters prior to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   324
 * executing the core business logic.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   325
 * @class Do.AlterArgs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   326
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   327
 * @param msg {String} (optional) Explanation of the altered return value
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   328
 * @param newArgs {Array} Call parameters to be used for the original method
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   329
 *                        instead of the arguments originally passed in.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   330
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   331
DO.AlterArgs = function(msg, newArgs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   332
    this.msg = msg;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   333
    this.newArgs = newArgs;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   334
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   335
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   336
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   337
 * Return an AlterReturn object when you want to change the result returned
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   338
 * from the core method to the caller.  Useful for Do.after subscribers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   339
 * @class Do.AlterReturn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   340
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   341
 * @param msg {String} (optional) Explanation of the altered return value
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   342
 * @param newRetVal {any} Return value passed to code that invoked the wrapped
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   343
 *                      function.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   344
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   345
DO.AlterReturn = function(msg, newRetVal) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   346
    this.msg = msg;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   347
    this.newRetVal = newRetVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   348
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   349
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   350
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   351
 * Return a Halt object when you want to terminate the execution
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   352
 * of all subsequent subscribers as well as the wrapped method
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   353
 * if it has not exectued yet.  Useful for Do.before subscribers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   354
 * @class Do.Halt
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   355
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   356
 * @param msg {String} (optional) Explanation of why the termination was done
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   357
 * @param retVal {any} Return value passed to code that invoked the wrapped
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   358
 *                      function.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   359
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   360
DO.Halt = function(msg, retVal) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   361
    this.msg = msg;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   362
    this.retVal = retVal;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   363
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   364
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   365
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   366
 * Return a Prevent object when you want to prevent the wrapped function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   367
 * from executing, but want the remaining listeners to execute.  Useful
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   368
 * for Do.before subscribers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   369
 * @class Do.Prevent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   370
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   371
 * @param msg {String} (optional) Explanation of why the termination was done
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   372
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   373
DO.Prevent = function(msg) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   374
    this.msg = msg;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   375
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   376
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   377
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   378
 * Return an Error object when you want to terminate the execution
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   379
 * of all subsequent method calls.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   380
 * @class Do.Error
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   381
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   382
 * @param msg {String} (optional) Explanation of the altered return value
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   383
 * @param retVal {any} Return value passed to code that invoked the wrapped
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   384
 *                      function.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   385
 * @deprecated use Y.Do.Halt or Y.Do.Prevent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   386
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   387
DO.Error = DO.Halt;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   388
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   389
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   390
//////////////////////////////////////////////////////////////////////////
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   391
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   392
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   393
 * Custom event engine, DOM event listener abstraction layer, synthetic DOM
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   394
 * events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   395
 * @module event-custom
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   396
 * @submodule event-custom-base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   397
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   398
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   399
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   400
// var onsubscribeType = "_event:onsub",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   401
var YArray = Y.Array,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   402
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   403
    AFTER = 'after',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   404
    CONFIGS = [
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   405
        'broadcast',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   406
        'monitored',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   407
        'bubbles',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   408
        'context',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   409
        'contextFn',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   410
        'currentTarget',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   411
        'defaultFn',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   412
        'defaultTargetOnly',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   413
        'details',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   414
        'emitFacade',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   415
        'fireOnce',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   416
        'async',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   417
        'host',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   418
        'preventable',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   419
        'preventedFn',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   420
        'queuable',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   421
        'silent',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   422
        'stoppedFn',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   423
        'target',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   424
        'type'
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   425
    ],
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   426
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   427
    CONFIGS_HASH = YArray.hash(CONFIGS),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   428
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   429
    nativeSlice = Array.prototype.slice,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   430
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   431
    YUI3_SIGNATURE = 9,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   432
    YUI_LOG = 'yui:log',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   433
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   434
    mixConfigs = function(r, s, ov) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   435
        var p;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   436
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   437
        for (p in s) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   438
            if (CONFIGS_HASH[p] && (ov || !(p in r))) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   439
                r[p] = s[p];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   440
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   441
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   442
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   443
        return r;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   444
    };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   445
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   446
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   447
 * The CustomEvent class lets you define events for your application
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   448
 * that can be subscribed to by one or more independent component.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   449
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   450
 * @param {String} type The type of event, which is passed to the callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   451
 * when the event fires.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   452
 * @param {object} defaults configuration object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   453
 * @class CustomEvent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   454
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   455
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   456
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   457
 /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   458
 * The type of event, returned to subscribers when the event fires
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   459
 * @property type
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   460
 * @type string
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   461
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   462
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   463
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   464
 * By default all custom events are logged in the debug build, set silent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   465
 * to true to disable debug outpu for this event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   466
 * @property silent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   467
 * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   468
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   469
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   470
Y.CustomEvent = function(type, defaults) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   471
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   472
    this._kds = Y.CustomEvent.keepDeprecatedSubs;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   473
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   474
    this.id = Y.guid();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   475
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   476
    this.type = type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   477
    this.silent = this.logSystem = (type === YUI_LOG);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   478
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   479
    if (this._kds) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   480
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   481
         * The subscribers to this event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   482
         * @property subscribers
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   483
         * @type Subscriber {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   484
         * @deprecated
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   485
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   486
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   487
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   488
         * 'After' subscribers
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   489
         * @property afters
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   490
         * @type Subscriber {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   491
         * @deprecated
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   492
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   493
        this.subscribers = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   494
        this.afters = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   495
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   496
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   497
    if (defaults) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   498
        mixConfigs(this, defaults, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   499
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   500
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   501
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   502
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   503
 * Static flag to enable population of the <a href="#property_subscribers">`subscribers`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   504
 * and  <a href="#property_subscribers">`afters`</a> properties held on a `CustomEvent` instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   505
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   506
 * These properties were changed to private properties (`_subscribers` and `_afters`), and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   507
 * converted from objects to arrays for performance reasons.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   508
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   509
 * Setting this property to true will populate the deprecated `subscribers` and `afters`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   510
 * properties for people who may be using them (which is expected to be rare). There will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   511
 * be a performance hit, compared to the new array based implementation.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   512
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   513
 * If you are using these deprecated properties for a use case which the public API
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   514
 * does not support, please file an enhancement request, and we can provide an alternate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   515
 * public implementation which doesn't have the performance cost required to maintiain the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   516
 * properties as objects.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   517
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   518
 * @property keepDeprecatedSubs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   519
 * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   520
 * @for CustomEvent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   521
 * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   522
 * @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   523
 * @deprecated
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   524
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   525
Y.CustomEvent.keepDeprecatedSubs = false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   526
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   527
Y.CustomEvent.mixConfigs = mixConfigs;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   528
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   529
Y.CustomEvent.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   530
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   531
    constructor: Y.CustomEvent,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   532
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   533
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   534
     * Monitor when an event is attached or detached.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   535
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   536
     * @property monitored
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   537
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   538
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   539
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   540
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   541
     * If 0, this event does not broadcast.  If 1, the YUI instance is notified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   542
     * every time this event fires.  If 2, the YUI instance and the YUI global
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   543
     * (if event is enabled on the global) are notified every time this event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   544
     * fires.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   545
     * @property broadcast
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   546
     * @type int
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   547
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   548
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   549
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   550
     * Specifies whether this event should be queued when the host is actively
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   551
     * processing an event.  This will effect exectution order of the callbacks
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   552
     * for the various events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   553
     * @property queuable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   554
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   555
     * @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   556
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   557
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   558
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   559
     * This event has fired if true
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   560
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   561
     * @property fired
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   562
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   563
     * @default false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   564
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   565
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   566
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   567
     * An array containing the arguments the custom event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   568
     * was last fired with.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   569
     * @property firedWith
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   570
     * @type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   571
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   572
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   573
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   574
     * This event should only fire one time if true, and if
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   575
     * it has fired, any new subscribers should be notified
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   576
     * immediately.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   577
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   578
     * @property fireOnce
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   579
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   580
     * @default false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   581
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   582
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   583
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   584
     * fireOnce listeners will fire syncronously unless async
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   585
     * is set to true
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   586
     * @property async
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   587
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   588
     * @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   589
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   590
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   591
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   592
     * Flag for stopPropagation that is modified during fire()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   593
     * 1 means to stop propagation to bubble targets.  2 means
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   594
     * to also stop additional subscribers on this target.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   595
     * @property stopped
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   596
     * @type int
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   597
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   598
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   599
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   600
     * Flag for preventDefault that is modified during fire().
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   601
     * if it is not 0, the default behavior for this event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   602
     * @property prevented
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   603
     * @type int
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   604
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   605
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   606
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   607
     * Specifies the host for this custom event.  This is used
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   608
     * to enable event bubbling
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   609
     * @property host
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   610
     * @type EventTarget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   611
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   612
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   613
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   614
     * The default function to execute after event listeners
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   615
     * have fire, but only if the default action was not
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   616
     * prevented.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   617
     * @property defaultFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   618
     * @type Function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   619
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   620
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   621
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   622
     * Flag for the default function to execute only if the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   623
     * firing event is the current target. This happens only
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   624
     * when using custom event delegation and setting the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   625
     * flag to `true` mimics the behavior of event delegation
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   626
     * in the DOM.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   627
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   628
     * @property defaultTargetOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   629
     * @type Boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   630
     * @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   631
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   632
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   633
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   634
     * The function to execute if a subscriber calls
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   635
     * stopPropagation or stopImmediatePropagation
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   636
     * @property stoppedFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   637
     * @type Function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   638
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   639
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   640
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   641
     * The function to execute if a subscriber calls
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   642
     * preventDefault
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   643
     * @property preventedFn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   644
     * @type Function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   645
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   646
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   647
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   648
     * The subscribers to this event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   649
     * @property _subscribers
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   650
     * @type Subscriber []
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   651
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   652
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   653
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   654
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   655
     * 'After' subscribers
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   656
     * @property _afters
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   657
     * @type Subscriber []
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   658
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   659
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   660
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   661
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   662
     * If set to true, the custom event will deliver an EventFacade object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   663
     * that is similar to a DOM event object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   664
     * @property emitFacade
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   665
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   666
     * @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   667
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   668
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   669
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   670
     * Supports multiple options for listener signatures in order to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   671
     * port YUI 2 apps.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   672
     * @property signature
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   673
     * @type int
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   674
     * @default 9
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   675
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   676
    signature : YUI3_SIGNATURE,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   677
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   678
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   679
     * The context the the event will fire from by default.  Defaults to the YUI
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   680
     * instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   681
     * @property context
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   682
     * @type object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   683
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   684
    context : Y,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   685
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   686
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   687
     * Specifies whether or not this event's default function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   688
     * can be cancelled by a subscriber by executing preventDefault()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   689
     * on the event facade
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   690
     * @property preventable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   691
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   692
     * @default true
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   693
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   694
    preventable : true,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   695
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   696
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   697
     * Specifies whether or not a subscriber can stop the event propagation
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   698
     * via stopPropagation(), stopImmediatePropagation(), or halt()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   699
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   700
     * Events can only bubble if emitFacade is true.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   701
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   702
     * @property bubbles
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   703
     * @type boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   704
     * @default true
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   705
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   706
    bubbles : true,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   707
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   708
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   709
     * Returns the number of subscribers for this event as the sum of the on()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   710
     * subscribers and after() subscribers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   711
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   712
     * @method hasSubs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   713
     * @return Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   714
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   715
    hasSubs: function(when) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   716
        var s = 0,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   717
            a = 0,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   718
            subs = this._subscribers,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   719
            afters = this._afters,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   720
            sib = this.sibling;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   721
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   722
        if (subs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   723
            s = subs.length;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   724
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   725
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   726
        if (afters) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   727
            a = afters.length;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   728
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   729
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   730
        if (sib) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   731
            subs = sib._subscribers;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   732
            afters = sib._afters;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   733
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   734
            if (subs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   735
                s += subs.length;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   736
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   737
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   738
            if (afters) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   739
                a += afters.length;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   740
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   741
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   742
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   743
        if (when) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   744
            return (when === 'after') ? a : s;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   745
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   746
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   747
        return (s + a);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   748
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   749
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   750
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   751
     * Monitor the event state for the subscribed event.  The first parameter
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   752
     * is what should be monitored, the rest are the normal parameters when
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   753
     * subscribing to an event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   754
     * @method monitor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   755
     * @param what {string} what to monitor ('detach', 'attach', 'publish').
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   756
     * @return {EventHandle} return value from the monitor event subscription.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   757
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   758
    monitor: function(what) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   759
        this.monitored = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   760
        var type = this.id + '|' + this.type + '_' + what,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   761
            args = nativeSlice.call(arguments, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   762
        args[0] = type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   763
        return this.host.on.apply(this.host, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   764
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   765
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   766
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   767
     * Get all of the subscribers to this event and any sibling event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   768
     * @method getSubs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   769
     * @return {Array} first item is the on subscribers, second the after.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   770
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   771
    getSubs: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   772
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   773
        var sibling = this.sibling,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   774
            subs = this._subscribers,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   775
            afters = this._afters,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   776
            siblingSubs,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   777
            siblingAfters;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   778
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   779
        if (sibling) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   780
            siblingSubs = sibling._subscribers;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   781
            siblingAfters = sibling._afters;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   782
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   783
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   784
        if (siblingSubs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   785
            if (subs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   786
                subs = subs.concat(siblingSubs);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   787
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   788
                subs = siblingSubs.concat();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   789
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   790
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   791
            if (subs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   792
                subs = subs.concat();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   793
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   794
                subs = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   795
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   796
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   797
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   798
        if (siblingAfters) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   799
            if (afters) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   800
                afters = afters.concat(siblingAfters);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   801
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   802
                afters = siblingAfters.concat();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   803
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   804
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   805
            if (afters) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   806
                afters = afters.concat();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   807
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   808
                afters = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   809
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   810
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   811
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   812
        return [subs, afters];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   813
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   814
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   815
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   816
     * Apply configuration properties.  Only applies the CONFIG whitelist
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   817
     * @method applyConfig
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   818
     * @param o hash of properties to apply.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   819
     * @param force {boolean} if true, properties that exist on the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   820
     * will be overwritten.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   821
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   822
    applyConfig: function(o, force) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   823
        mixConfigs(this, o, force);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   824
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   825
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   826
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   827
     * Create the Subscription for subscribing function, context, and bound
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   828
     * arguments.  If this is a fireOnce event, the subscriber is immediately
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   829
     * notified.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   830
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   831
     * @method _on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   832
     * @param fn {Function} Subscription callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   833
     * @param [context] {Object} Override `this` in the callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   834
     * @param [args] {Array} bound arguments that will be passed to the callback after the arguments generated by fire()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   835
     * @param [when] {String} "after" to slot into after subscribers
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   836
     * @return {EventHandle}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   837
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   838
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   839
    _on: function(fn, context, args, when) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   840
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   841
        if (!fn) { this.log('Invalid callback for CE: ' + this.type); }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   842
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   843
        var s = new Y.Subscriber(fn, context, args, when),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   844
            firedWith;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   845
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   846
        if (this.fireOnce && this.fired) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   847
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   848
            firedWith = this.firedWith;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   849
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   850
            // It's a little ugly for this to know about facades,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   851
            // but given the current breakup, not much choice without
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   852
            // moving a whole lot of stuff around.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   853
            if (this.emitFacade && this._addFacadeToArgs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   854
                this._addFacadeToArgs(firedWith);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   855
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   856
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   857
            if (this.async) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   858
                setTimeout(Y.bind(this._notify, this, s, firedWith), 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   859
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   860
                this._notify(s, firedWith);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   861
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   862
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   863
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   864
        if (when === AFTER) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   865
            if (!this._afters) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   866
                this._afters = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   867
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   868
            this._afters.push(s);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   869
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   870
            if (!this._subscribers) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   871
                this._subscribers = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   872
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   873
            this._subscribers.push(s);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   874
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   875
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   876
        if (this._kds) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   877
            if (when === AFTER) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   878
                this.afters[s.id] = s;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   879
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   880
                this.subscribers[s.id] = s;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   881
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   882
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   883
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   884
        return new Y.EventHandle(this, s);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   885
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   886
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   887
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   888
     * Listen for this event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   889
     * @method subscribe
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   890
     * @param {Function} fn The function to execute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   891
     * @return {EventHandle} Unsubscribe handle.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   892
     * @deprecated use on.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   893
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   894
    subscribe: function(fn, context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   895
        Y.log('ce.subscribe deprecated, use "on"', 'warn', 'deprecated');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   896
        var a = (arguments.length > 2) ? nativeSlice.call(arguments, 2) : null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   897
        return this._on(fn, context, a, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   898
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   899
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   900
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   901
     * Listen for this event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   902
     * @method on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   903
     * @param {Function} fn The function to execute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   904
     * @param {object} context optional execution context.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   905
     * @param {mixed} arg* 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   906
     * when the event fires.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   907
     * @return {EventHandle} An object with a detach method to detch the handler(s).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   908
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   909
    on: function(fn, context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   910
        var a = (arguments.length > 2) ? nativeSlice.call(arguments, 2) : null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   911
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   912
        if (this.monitored && this.host) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   913
            this.host._monitor('attach', this, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   914
                args: arguments
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   915
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   916
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   917
        return this._on(fn, context, a, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   918
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   919
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   920
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   921
     * Listen for this event after the normal subscribers have been notified and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   922
     * the default behavior has been applied.  If a normal subscriber prevents the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   923
     * default behavior, it also prevents after listeners from firing.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   924
     * @method after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   925
     * @param {Function} fn The function to execute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   926
     * @param {object} context optional execution context.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   927
     * @param {mixed} arg* 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   928
     * when the event fires.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   929
     * @return {EventHandle} handle Unsubscribe handle.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   930
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   931
    after: function(fn, context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   932
        var a = (arguments.length > 2) ? nativeSlice.call(arguments, 2) : null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   933
        return this._on(fn, context, a, AFTER);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   934
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   935
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   936
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   937
     * Detach listeners.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   938
     * @method detach
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   939
     * @param {Function} fn  The subscribed function to remove, if not supplied
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   940
     *                       all will be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   941
     * @param {Object}   context The context object passed to subscribe.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   942
     * @return {Number} returns the number of subscribers unsubscribed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   943
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   944
    detach: function(fn, context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   945
        // unsubscribe handle
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   946
        if (fn && fn.detach) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   947
            return fn.detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   948
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   949
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   950
        var i, s,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   951
            found = 0,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   952
            subs = this._subscribers,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   953
            afters = this._afters;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   954
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   955
        if (subs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   956
            for (i = subs.length; i >= 0; i--) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   957
                s = subs[i];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   958
                if (s && (!fn || fn === s.fn)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   959
                    this._delete(s, subs, i);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   960
                    found++;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   961
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   962
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   963
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   964
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   965
        if (afters) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   966
            for (i = afters.length; i >= 0; i--) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   967
                s = afters[i];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   968
                if (s && (!fn || fn === s.fn)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   969
                    this._delete(s, afters, i);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   970
                    found++;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   971
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   972
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   973
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   974
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   975
        return found;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   976
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   977
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   978
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   979
     * Detach listeners.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   980
     * @method unsubscribe
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   981
     * @param {Function} fn  The subscribed function to remove, if not supplied
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   982
     *                       all will be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   983
     * @param {Object}   context The context object passed to subscribe.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   984
     * @return {int|undefined} returns the number of subscribers unsubscribed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   985
     * @deprecated use detach.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   986
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   987
    unsubscribe: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   988
        return this.detach.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   989
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   990
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   991
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   992
     * Notify a single subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   993
     * @method _notify
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   994
     * @param {Subscriber} s the subscriber.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   995
     * @param {Array} args the arguments array to apply to the listener.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   996
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   997
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   998
    _notify: function(s, args, ef) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   999
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1000
        this.log(this.type + '->' + 'sub: ' + s.id);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1001
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1002
        var ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1003
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1004
        ret = s.notify(args, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1005
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1006
        if (false === ret || this.stopped > 1) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1007
            this.log(this.type + ' cancelled by subscriber');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1008
            return false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1009
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1010
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1011
        return true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1012
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1013
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1014
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1015
     * Logger abstraction to centralize the application of the silent flag
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1016
     * @method log
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1017
     * @param {string} msg message to log.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1018
     * @param {string} cat log category.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1019
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1020
    log: function(msg, cat) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1021
        if (!this.silent) { Y.log(this.id + ': ' + msg, cat || 'info', 'event'); }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1022
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1023
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1024
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1025
     * Notifies the subscribers.  The callback functions will be executed
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1026
     * from the context specified when the event was created, and with the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1027
     * following parameters:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1028
     *   <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1029
     *   <li>The type of event</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1030
     *   <li>All of the arguments fire() was executed with as an array</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1031
     *   <li>The custom object (if any) that was passed into the subscribe()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1032
     *       method</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1033
     *   </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1034
     * @method fire
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1035
     * @param {Object*} arguments an arbitrary set of parameters to pass to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1036
     *                            the handler.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1037
     * @return {boolean} false if one of the subscribers returned false,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1038
     *                   true otherwise.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1039
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1040
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1041
    fire: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1042
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1043
        // push is the fastest way to go from arguments to arrays
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1044
        // for most browsers currently
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1045
        // http://jsperf.com/push-vs-concat-vs-slice/2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1046
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1047
        var args = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1048
        args.push.apply(args, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1049
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1050
        return this._fire(args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1051
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1052
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1053
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1054
     * Private internal implementation for `fire`, which is can be used directly by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1055
     * `EventTarget` and other event module classes which have already converted from
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1056
     * an `arguments` list to an array, to avoid the repeated overhead.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1057
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1058
     * @method _fire
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1059
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1060
     * @param {Array} args The array of arguments passed to be passed to handlers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1061
     * @return {boolean} false if one of the subscribers returned false, true otherwise.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1062
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1063
    _fire: function(args) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1064
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1065
        if (this.fireOnce && this.fired) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1066
            this.log('fireOnce event: ' + this.type + ' already fired');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1067
            return true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1068
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1069
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1070
            // this doesn't happen if the event isn't published
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1071
            // this.host._monitor('fire', this.type, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1072
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1073
            this.fired = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1074
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1075
            if (this.fireOnce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1076
                this.firedWith = args;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1077
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1078
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1079
            if (this.emitFacade) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1080
                return this.fireComplex(args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1081
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1082
                return this.fireSimple(args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1083
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1084
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1085
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1086
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1087
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1088
     * Set up for notifying subscribers of non-emitFacade events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1089
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1090
     * @method fireSimple
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1091
     * @param args {Array} Arguments passed to fire()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1092
     * @return Boolean false if a subscriber returned false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1093
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1094
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1095
    fireSimple: function(args) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1096
        this.stopped = 0;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1097
        this.prevented = 0;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1098
        if (this.hasSubs()) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1099
            var subs = this.getSubs();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1100
            this._procSubs(subs[0], args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1101
            this._procSubs(subs[1], args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1102
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1103
        if (this.broadcast) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1104
            this._broadcast(args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1105
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1106
        return this.stopped ? false : true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1107
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1108
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1109
    // Requires the event-custom-complex module for full funcitonality.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1110
    fireComplex: function(args) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1111
        this.log('Missing event-custom-complex needed to emit a facade for: ' + this.type);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1112
        args[0] = args[0] || {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1113
        return this.fireSimple(args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1114
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1115
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1116
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1117
     * Notifies a list of subscribers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1118
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1119
     * @method _procSubs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1120
     * @param subs {Array} List of subscribers
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1121
     * @param args {Array} Arguments passed to fire()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1122
     * @param ef {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1123
     * @return Boolean false if a subscriber returns false or stops the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1124
     *              propagation via e.stopPropagation(),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1125
     *              e.stopImmediatePropagation(), or e.halt()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1126
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1127
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1128
    _procSubs: function(subs, args, ef) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1129
        var s, i, l;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1130
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1131
        for (i = 0, l = subs.length; i < l; i++) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1132
            s = subs[i];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1133
            if (s && s.fn) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1134
                if (false === this._notify(s, args, ef)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1135
                    this.stopped = 2;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1136
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1137
                if (this.stopped === 2) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1138
                    return false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1139
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1140
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1141
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1142
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1143
        return true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1144
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1145
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1146
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1147
     * Notifies the YUI instance if the event is configured with broadcast = 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1148
     * and both the YUI instance and Y.Global if configured with broadcast = 2.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1149
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1150
     * @method _broadcast
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1151
     * @param args {Array} Arguments sent to fire()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1152
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1153
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1154
    _broadcast: function(args) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1155
        if (!this.stopped && this.broadcast) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1156
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1157
            var a = args.concat();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1158
            a.unshift(this.type);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1159
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1160
            if (this.host !== Y) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1161
                Y.fire.apply(Y, a);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1162
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1163
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1164
            if (this.broadcast === 2) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1165
                Y.Global.fire.apply(Y.Global, a);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1166
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1167
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1168
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1169
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1170
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1171
     * Removes all listeners
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1172
     * @method unsubscribeAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1173
     * @return {Number} The number of listeners unsubscribed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1174
     * @deprecated use detachAll.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1175
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1176
    unsubscribeAll: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1177
        return this.detachAll.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1178
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1179
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1180
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1181
     * Removes all listeners
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1182
     * @method detachAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1183
     * @return {Number} The number of listeners unsubscribed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1184
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1185
    detachAll: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1186
        return this.detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1187
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1188
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1189
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1190
     * Deletes the subscriber from the internal store of on() and after()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1191
     * subscribers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1192
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1193
     * @method _delete
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1194
     * @param s subscriber object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1195
     * @param subs (optional) on or after subscriber array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1196
     * @param index (optional) The index found.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1197
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1198
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1199
    _delete: function(s, subs, i) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1200
        var when = s._when;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1201
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1202
        if (!subs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1203
            subs = (when === AFTER) ? this._afters : this._subscribers;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1204
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1205
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1206
        if (subs) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1207
            i = YArray.indexOf(subs, s, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1208
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1209
            if (s && subs[i] === s) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1210
                subs.splice(i, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1211
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1212
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1213
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1214
        if (this._kds) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1215
            if (when === AFTER) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1216
                delete this.afters[s.id];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1217
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1218
                delete this.subscribers[s.id];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1219
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1220
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1221
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1222
        if (this.monitored && this.host) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1223
            this.host._monitor('detach', this, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1224
                ce: this,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1225
                sub: s
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1226
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1227
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1228
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1229
        if (s) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1230
            s.deleted = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1231
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1232
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1233
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1234
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1235
 * Stores the subscriber information to be used when the event fires.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1236
 * @param {Function} fn       The wrapped function to execute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1237
 * @param {Object}   context  The value of the keyword 'this' in the listener.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1238
 * @param {Array} args*       0..n additional arguments to supply the listener.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1239
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1240
 * @class Subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1241
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1242
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1243
Y.Subscriber = function(fn, context, args, when) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1244
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1245
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1246
     * The callback that will be execute when the event fires
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1247
     * This is wrapped by Y.rbind if obj was supplied.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1248
     * @property fn
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1249
     * @type Function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1250
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1251
    this.fn = fn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1252
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1253
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1254
     * Optional 'this' keyword for the listener
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1255
     * @property context
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1256
     * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1257
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1258
    this.context = context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1259
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1260
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1261
     * Unique subscriber id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1262
     * @property id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1263
     * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1264
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1265
    this.id = Y.guid();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1266
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1267
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1268
     * Additional arguments to propagate to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1269
     * @property args
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1270
     * @type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1271
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1272
    this.args = args;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1273
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1274
    this._when = when;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1275
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1276
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1277
     * Custom events for a given fire transaction.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1278
     * @property events
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1279
     * @type {EventTarget}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1280
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1281
    // this.events = null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1282
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1283
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1284
     * This listener only reacts to the event once
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1285
     * @property once
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1286
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1287
    // this.once = false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1288
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1289
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1290
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1291
Y.Subscriber.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1292
    constructor: Y.Subscriber,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1293
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1294
    _notify: function(c, args, ce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1295
        if (this.deleted && !this.postponed) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1296
            if (this.postponed) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1297
                delete this.fn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1298
                delete this.context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1299
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1300
                delete this.postponed;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1301
                return null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1302
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1303
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1304
        var a = this.args, ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1305
        switch (ce.signature) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1306
            case 0:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1307
                ret = this.fn.call(c, ce.type, args, c);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1308
                break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1309
            case 1:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1310
                ret = this.fn.call(c, args[0] || null, c);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1311
                break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1312
            default:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1313
                if (a || args) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1314
                    args = args || [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1315
                    a = (a) ? args.concat(a) : args;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1316
                    ret = this.fn.apply(c, a);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1317
                } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1318
                    ret = this.fn.call(c);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1319
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1320
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1321
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1322
        if (this.once) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1323
            ce._delete(this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1324
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1325
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1326
        return ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1327
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1328
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1329
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1330
     * Executes the subscriber.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1331
     * @method notify
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1332
     * @param args {Array} Arguments array for the subscriber.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1333
     * @param ce {CustomEvent} The custom event that sent the notification.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1334
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1335
    notify: function(args, ce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1336
        var c = this.context,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1337
            ret = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1338
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1339
        if (!c) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1340
            c = (ce.contextFn) ? ce.contextFn() : ce.context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1341
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1342
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1343
        // only catch errors if we will not re-throw them.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1344
        if (Y.config && Y.config.throwFail) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1345
            ret = this._notify(c, args, ce);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1346
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1347
            try {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1348
                ret = this._notify(c, args, ce);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1349
            } catch (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1350
                Y.error(this + ' failed: ' + e.message, e);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1351
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1352
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1353
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1354
        return ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1355
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1356
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1357
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1358
     * Returns true if the fn and obj match this objects properties.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1359
     * Used by the unsubscribe method to match the right subscriber.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1360
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1361
     * @method contains
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1362
     * @param {Function} fn the function to execute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1363
     * @param {Object} context optional 'this' keyword for the listener.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1364
     * @return {boolean} true if the supplied arguments match this
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1365
     *                   subscriber's signature.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1366
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1367
    contains: function(fn, context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1368
        if (context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1369
            return ((this.fn === fn) && this.context === context);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1370
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1371
            return (this.fn === fn);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1372
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1373
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1374
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1375
    valueOf : function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1376
        return this.id;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1377
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1378
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1379
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1380
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1381
 * Return value from all subscribe operations
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1382
 * @class EventHandle
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1383
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1384
 * @param {CustomEvent} evt the custom event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1385
 * @param {Subscriber} sub the subscriber.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1386
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1387
Y.EventHandle = function(evt, sub) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1388
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1389
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1390
     * The custom event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1391
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1392
     * @property evt
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1393
     * @type CustomEvent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1394
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1395
    this.evt = evt;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1396
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1397
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1398
     * The subscriber object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1399
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1400
     * @property sub
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1401
     * @type Subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1402
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1403
    this.sub = sub;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1404
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1405
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1406
Y.EventHandle.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1407
    batch: function(f, c) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1408
        f.call(c || this, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1409
        if (Y.Lang.isArray(this.evt)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1410
            Y.Array.each(this.evt, function(h) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1411
                h.batch.call(c || h, f);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1412
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1413
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1414
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1415
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1416
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1417
     * Detaches this subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1418
     * @method detach
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1419
     * @return {Number} the number of detached listeners
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1420
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1421
    detach: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1422
        var evt = this.evt, detached = 0, i;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1423
        if (evt) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1424
            // Y.log('EventHandle.detach: ' + this.sub, 'info', 'Event');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1425
            if (Y.Lang.isArray(evt)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1426
                for (i = 0; i < evt.length; i++) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1427
                    detached += evt[i].detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1428
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1429
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1430
                evt._delete(this.sub);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1431
                detached = 1;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1432
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1433
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1434
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1435
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1436
        return detached;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1437
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1438
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1439
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1440
     * Monitor the event state for the subscribed event.  The first parameter
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1441
     * is what should be monitored, the rest are the normal parameters when
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1442
     * subscribing to an event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1443
     * @method monitor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1444
     * @param what {string} what to monitor ('attach', 'detach', 'publish').
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1445
     * @return {EventHandle} return value from the monitor event subscription.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1446
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1447
    monitor: function(what) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1448
        return this.evt.monitor.apply(this.evt, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1449
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1450
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1451
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1452
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1453
 * Custom event engine, DOM event listener abstraction layer, synthetic DOM
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1454
 * events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1455
 * @module event-custom
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1456
 * @submodule event-custom-base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1457
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1458
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1459
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1460
 * EventTarget provides the implementation for any object to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1461
 * publish, subscribe and fire to custom events, and also
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1462
 * alows other EventTargets to target the object with events
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1463
 * sourced from the other object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1464
 * EventTarget is designed to be used with Y.augment to wrap
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1465
 * EventCustom in an interface that allows events to be listened to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1466
 * and fired by name.  This makes it possible for implementing code to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1467
 * subscribe to an event that either has not been created yet, or will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1468
 * not be created at all.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1469
 * @class EventTarget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1470
 * @param opts a configuration object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1471
 * @config emitFacade {boolean} if true, all events will emit event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1472
 * facade payloads by default (default false)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1473
 * @config prefix {String} the prefix to apply to non-prefixed event names
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1474
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1475
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1476
var L = Y.Lang,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1477
    PREFIX_DELIMITER = ':',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1478
    CATEGORY_DELIMITER = '|',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1479
    AFTER_PREFIX = '~AFTER~',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1480
    WILD_TYPE_RE = /(.*?)(:)(.*?)/,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1481
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1482
    _wildType = Y.cached(function(type) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1483
        return type.replace(WILD_TYPE_RE, "*$2$3");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1484
    }),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1485
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1486
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1487
     * If the instance has a prefix attribute and the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1488
     * event type is not prefixed, the instance prefix is
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1489
     * applied to the supplied type.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1490
     * @method _getType
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1491
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1492
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1493
    _getType = function(type, pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1494
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1495
        if (!pre || !type || type.indexOf(PREFIX_DELIMITER) > -1) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1496
            return type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1497
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1498
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1499
        return pre + PREFIX_DELIMITER + type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1500
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1501
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1502
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1503
     * Returns an array with the detach key (if provided),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1504
     * and the prefixed event name from _getType
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1505
     * Y.on('detachcategory| menu:click', fn)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1506
     * @method _parseType
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1507
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1508
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1509
    _parseType = Y.cached(function(type, pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1510
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1511
        var t = type, detachcategory, after, i;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1512
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1513
        if (!L.isString(t)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1514
            return t;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1515
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1516
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1517
        i = t.indexOf(AFTER_PREFIX);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1518
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1519
        if (i > -1) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1520
            after = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1521
            t = t.substr(AFTER_PREFIX.length);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1522
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1523
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1524
        i = t.indexOf(CATEGORY_DELIMITER);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1525
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1526
        if (i > -1) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1527
            detachcategory = t.substr(0, (i));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1528
            t = t.substr(i+1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1529
            if (t === '*') {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1530
                t = null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1531
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1532
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1533
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1534
        // detach category, full type with instance prefix, is this an after listener, short type
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1535
        return [detachcategory, (pre) ? _getType(t, pre) : t, after, t];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1536
    }),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1537
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1538
    ET = function(opts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1539
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1540
        var etState = this._yuievt,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1541
            etConfig;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1542
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1543
        if (!etState) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1544
            etState = this._yuievt = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1545
                events: {},    // PERF: Not much point instantiating lazily. We're bound to have events
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1546
                targets: null, // PERF: Instantiate lazily, if user actually adds target,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1547
                config: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1548
                    host: this,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1549
                    context: this
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1550
                },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1551
                chain: Y.config.chain
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1552
            };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1553
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1554
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1555
        etConfig = etState.config;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1556
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1557
        if (opts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1558
            mixConfigs(etConfig, opts, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1559
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1560
            if (opts.chain !== undefined) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1561
                etState.chain = opts.chain;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1562
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1563
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1564
            if (opts.prefix) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1565
                etConfig.prefix = opts.prefix;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1566
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1567
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1568
    };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1569
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1570
ET.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1571
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1572
    constructor: ET,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1573
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1574
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1575
     * Listen to a custom event hosted by this object one time.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1576
     * This is the equivalent to <code>on</code> except the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1577
     * listener is immediatelly detached when it is executed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1578
     * @method once
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1579
     * @param {String} type The name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1580
     * @param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1581
     * @param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1582
     * @param {Any} [arg*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1583
     * @return {EventHandle} A subscription handle capable of detaching the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1584
     *                       subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1585
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1586
    once: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1587
        var handle = this.on.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1588
        handle.batch(function(hand) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1589
            if (hand.sub) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1590
                hand.sub.once = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1591
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1592
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1593
        return handle;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1594
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1595
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1596
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1597
     * Listen to a custom event hosted by this object one time.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1598
     * This is the equivalent to <code>after</code> except the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1599
     * listener is immediatelly detached when it is executed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1600
     * @method onceAfter
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1601
     * @param {String} type The name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1602
     * @param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1603
     * @param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1604
     * @param {Any} [arg*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1605
     * @return {EventHandle} A subscription handle capable of detaching that
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1606
     *                       subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1607
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1608
    onceAfter: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1609
        var handle = this.after.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1610
        handle.batch(function(hand) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1611
            if (hand.sub) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1612
                hand.sub.once = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1613
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1614
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1615
        return handle;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1616
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1617
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1618
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1619
     * Takes the type parameter passed to 'on' and parses out the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1620
     * various pieces that could be included in the type.  If the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1621
     * event type is passed without a prefix, it will be expanded
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1622
     * to include the prefix one is supplied or the event target
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1623
     * is configured with a default prefix.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1624
     * @method parseType
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1625
     * @param {String} type the type
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1626
     * @param {String} [pre] The prefix. Defaults to this._yuievt.config.prefix
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1627
     * @since 3.3.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1628
     * @return {Array} an array containing:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1629
     *  * the detach category, if supplied,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1630
     *  * the prefixed event type,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1631
     *  * whether or not this is an after listener,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1632
     *  * the supplied event type
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1633
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1634
    parseType: function(type, pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1635
        return _parseType(type, pre || this._yuievt.config.prefix);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1636
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1637
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1638
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1639
     * Subscribe a callback function to a custom event fired by this object or
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1640
     * from an object that bubbles its events to this object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1641
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1642
     * Callback functions for events published with `emitFacade = true` will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1643
     * receive an `EventFacade` as the first argument (typically named "e").
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1644
     * These callbacks can then call `e.preventDefault()` to disable the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1645
     * behavior published to that event's `defaultFn`.  See the `EventFacade`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1646
     * API for all available properties and methods. Subscribers to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1647
     * non-`emitFacade` events will receive the arguments passed to `fire()`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1648
     * after the event name.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1649
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1650
     * To subscribe to multiple events at once, pass an object as the first
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1651
     * argument, where the key:value pairs correspond to the eventName:callback,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1652
     * or pass an array of event names as the first argument to subscribe to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1653
     * all listed events with the same callback.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1654
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1655
     * Returning `false` from a callback is supported as an alternative to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1656
     * calling `e.preventDefault(); e.stopPropagation();`.  However, it is
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1657
     * recommended to use the event methods whenever possible.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1658
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1659
     * @method on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1660
     * @param {String} type The name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1661
     * @param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1662
     * @param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1663
     * @param {Any} [arg*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1664
     * @return {EventHandle} A subscription handle capable of detaching that
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1665
     *                       subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1666
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1667
    on: function(type, fn, context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1668
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1669
        var yuievt = this._yuievt,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1670
            parts = _parseType(type, yuievt.config.prefix), f, c, args, ret, ce,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1671
            detachcategory, handle, store = Y.Env.evt.handles, after, adapt, shorttype,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1672
            Node = Y.Node, n, domevent, isArr;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1673
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1674
        // full name, args, detachcategory, after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1675
        this._monitor('attach', parts[1], {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1676
            args: arguments,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1677
            category: parts[0],
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1678
            after: parts[2]
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1679
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1680
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1681
        if (L.isObject(type)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1682
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1683
            if (L.isFunction(type)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1684
                return Y.Do.before.apply(Y.Do, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1685
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1686
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1687
            f = fn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1688
            c = context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1689
            args = nativeSlice.call(arguments, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1690
            ret = [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1691
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1692
            if (L.isArray(type)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1693
                isArr = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1694
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1695
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1696
            after = type._after;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1697
            delete type._after;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1698
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1699
            Y.each(type, function(v, k) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1700
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1701
                if (L.isObject(v)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1702
                    f = v.fn || ((L.isFunction(v)) ? v : f);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1703
                    c = v.context || c;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1704
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1705
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1706
                var nv = (after) ? AFTER_PREFIX : '';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1707
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1708
                args[0] = nv + ((isArr) ? v : k);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1709
                args[1] = f;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1710
                args[2] = c;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1711
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1712
                ret.push(this.on.apply(this, args));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1713
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1714
            }, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1715
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1716
            return (yuievt.chain) ? this : new Y.EventHandle(ret);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1717
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1718
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1719
        detachcategory = parts[0];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1720
        after = parts[2];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1721
        shorttype = parts[3];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1722
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1723
        // extra redirection so we catch adaptor events too.  take a look at this.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1724
        if (Node && Y.instanceOf(this, Node) && (shorttype in Node.DOM_EVENTS)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1725
            args = nativeSlice.call(arguments, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1726
            args.splice(2, 0, Node.getDOMNode(this));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1727
            // Y.log("Node detected, redirecting with these args: " + args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1728
            return Y.on.apply(Y, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1729
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1730
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1731
        type = parts[1];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1732
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1733
        if (Y.instanceOf(this, YUI)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1734
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1735
            adapt = Y.Env.evt.plugins[type];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1736
            args  = nativeSlice.call(arguments, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1737
            args[0] = shorttype;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1738
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1739
            if (Node) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1740
                n = args[2];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1741
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1742
                if (Y.instanceOf(n, Y.NodeList)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1743
                    n = Y.NodeList.getDOMNodes(n);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1744
                } else if (Y.instanceOf(n, Node)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1745
                    n = Node.getDOMNode(n);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1746
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1747
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1748
                domevent = (shorttype in Node.DOM_EVENTS);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1749
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1750
                // Captures both DOM events and event plugins.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1751
                if (domevent) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1752
                    args[2] = n;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1753
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1754
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1755
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1756
            // check for the existance of an event adaptor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1757
            if (adapt) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1758
                Y.log('Using adaptor for ' + shorttype + ', ' + n, 'info', 'event');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1759
                handle = adapt.on.apply(Y, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1760
            } else if ((!type) || domevent) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1761
                handle = Y.Event._attach(args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1762
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1763
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1764
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1765
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1766
        if (!handle) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1767
            ce = yuievt.events[type] || this.publish(type);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1768
            handle = ce._on(fn, context, (arguments.length > 3) ? nativeSlice.call(arguments, 3) : null, (after) ? 'after' : true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1769
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1770
            // TODO: More robust regex, accounting for category
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1771
            if (type.indexOf("*:") !== -1) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1772
                this._hasSiblings = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1773
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1774
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1775
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1776
        if (detachcategory) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1777
            store[detachcategory] = store[detachcategory] || {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1778
            store[detachcategory][type] = store[detachcategory][type] || [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1779
            store[detachcategory][type].push(handle);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1780
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1781
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1782
        return (yuievt.chain) ? this : handle;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1783
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1784
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1785
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1786
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1787
     * subscribe to an event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1788
     * @method subscribe
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1789
     * @deprecated use on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1790
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1791
    subscribe: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1792
        Y.log('EventTarget subscribe() is deprecated, use on()', 'warn', 'deprecated');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1793
        return this.on.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1794
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1795
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1796
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1797
     * Detach one or more listeners the from the specified event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1798
     * @method detach
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1799
     * @param type {string|Object}   Either the handle to the subscriber or the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1800
     *                        type of event.  If the type
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1801
     *                        is not specified, it will attempt to remove
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1802
     *                        the listener from all hosted events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1803
     * @param fn   {Function} The subscribed function to unsubscribe, if not
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1804
     *                          supplied, all subscribers will be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1805
     * @param context  {Object}   The custom object passed to subscribe.  This is
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1806
     *                        optional, but if supplied will be used to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1807
     *                        disambiguate multiple listeners that are the same
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1808
     *                        (e.g., you subscribe many object using a function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1809
     *                        that lives on the prototype)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1810
     * @return {EventTarget} the host
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1811
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1812
    detach: function(type, fn, context) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1813
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1814
        var evts = this._yuievt.events,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1815
            i,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1816
            Node = Y.Node,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1817
            isNode = Node && (Y.instanceOf(this, Node));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1818
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1819
        // detachAll disabled on the Y instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1820
        if (!type && (this !== Y)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1821
            for (i in evts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1822
                if (evts.hasOwnProperty(i)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1823
                    evts[i].detach(fn, context);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1824
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1825
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1826
            if (isNode) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1827
                Y.Event.purgeElement(Node.getDOMNode(this));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1828
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1829
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1830
            return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1831
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1832
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1833
        var parts = _parseType(type, this._yuievt.config.prefix),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1834
        detachcategory = L.isArray(parts) ? parts[0] : null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1835
        shorttype = (parts) ? parts[3] : null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1836
        adapt, store = Y.Env.evt.handles, detachhost, cat, args,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1837
        ce,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1838
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1839
        keyDetacher = function(lcat, ltype, host) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1840
            var handles = lcat[ltype], ce, i;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1841
            if (handles) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1842
                for (i = handles.length - 1; i >= 0; --i) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1843
                    ce = handles[i].evt;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1844
                    if (ce.host === host || ce.el === host) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1845
                        handles[i].detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1846
                    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1847
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1848
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1849
        };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1850
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1851
        if (detachcategory) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1852
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1853
            cat = store[detachcategory];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1854
            type = parts[1];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1855
            detachhost = (isNode) ? Y.Node.getDOMNode(this) : this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1856
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1857
            if (cat) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1858
                if (type) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1859
                    keyDetacher(cat, type, detachhost);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1860
                } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1861
                    for (i in cat) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1862
                        if (cat.hasOwnProperty(i)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1863
                            keyDetacher(cat, i, detachhost);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1864
                        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1865
                    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1866
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1867
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1868
                return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1869
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1870
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1871
        // If this is an event handle, use it to detach
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1872
        } else if (L.isObject(type) && type.detach) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1873
            type.detach();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1874
            return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1875
        // extra redirection so we catch adaptor events too.  take a look at this.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1876
        } else if (isNode && ((!shorttype) || (shorttype in Node.DOM_EVENTS))) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1877
            args = nativeSlice.call(arguments, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1878
            args[2] = Node.getDOMNode(this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1879
            Y.detach.apply(Y, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1880
            return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1881
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1882
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1883
        adapt = Y.Env.evt.plugins[shorttype];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1884
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1885
        // The YUI instance handles DOM events and adaptors
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1886
        if (Y.instanceOf(this, YUI)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1887
            args = nativeSlice.call(arguments, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1888
            // use the adaptor specific detach code if
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1889
            if (adapt && adapt.detach) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1890
                adapt.detach.apply(Y, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1891
                return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1892
            // DOM event fork
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1893
            } else if (!type || (!adapt && Node && (type in Node.DOM_EVENTS))) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1894
                args[0] = type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1895
                Y.Event.detach.apply(Y.Event, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1896
                return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1897
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1898
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1899
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1900
        // ce = evts[type];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1901
        ce = evts[parts[1]];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1902
        if (ce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1903
            ce.detach(fn, context);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1904
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1905
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1906
        return this;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1907
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1908
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1909
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1910
     * detach a listener
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1911
     * @method unsubscribe
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1912
     * @deprecated use detach
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1913
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1914
    unsubscribe: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1915
Y.log('EventTarget unsubscribe() is deprecated, use detach()', 'warn', 'deprecated');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1916
        return this.detach.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1917
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1918
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1919
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1920
     * Removes all listeners from the specified event.  If the event type
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1921
     * is not specified, all listeners from all hosted custom events will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1922
     * be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1923
     * @method detachAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1924
     * @param type {String}   The type, or name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1925
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1926
    detachAll: function(type) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1927
        return this.detach(type);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1928
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1929
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1930
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1931
     * Removes all listeners from the specified event.  If the event type
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1932
     * is not specified, all listeners from all hosted custom events will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1933
     * be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1934
     * @method unsubscribeAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1935
     * @param type {String}   The type, or name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1936
     * @deprecated use detachAll
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1937
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1938
    unsubscribeAll: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1939
Y.log('EventTarget unsubscribeAll() is deprecated, use detachAll()', 'warn', 'deprecated');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1940
        return this.detachAll.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1941
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1942
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1943
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1944
     * Creates a new custom event of the specified type.  If a custom event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1945
     * by that name already exists, it will not be re-created.  In either
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1946
     * case the custom event is returned.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1947
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1948
     * @method publish
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1949
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1950
     * @param type {String} the type, or name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1951
     * @param opts {object} optional config params.  Valid properties are:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1952
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1953
     *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1954
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1955
     *   'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1956
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1957
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1958
     *   'bubbles': whether or not this event bubbles (true)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1959
     *              Events can only bubble if emitFacade is true.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1960
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1961
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1962
     *   'context': the default execution context for the listeners (this)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1963
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1964
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1965
     *   'defaultFn': the default function to execute when this event fires if preventDefault was not called
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1966
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1967
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1968
     *   'emitFacade': whether or not this event emits a facade (false)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1969
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1970
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1971
     *   'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1972
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1973
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1974
     *   'fireOnce': if an event is configured to fire once, new subscribers after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1975
     *   the fire will be notified immediately.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1976
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1977
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1978
     *   'async': fireOnce event listeners will fire synchronously if the event has already
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1979
     *    fired unless async is true.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1980
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1981
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1982
     *   'preventable': whether or not preventDefault() has an effect (true)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1983
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1984
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1985
     *   'preventedFn': a function that is executed when preventDefault is called
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1986
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1987
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1988
     *   'queuable': whether or not this event can be queued during bubbling (false)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1989
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1990
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1991
     *   'silent': if silent is true, debug messages are not provided for this event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1992
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1993
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1994
     *   'stoppedFn': a function that is executed when stopPropagation is called
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1995
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1996
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1997
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1998
     *   'monitored': specifies whether or not this event should send notifications about
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1999
     *   when the event has been attached, detached, or published.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2000
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2001
     *    <li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2002
     *   'type': the event type (valid option if not provided as the first parameter to publish)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2003
     *    </li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2004
     *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2005
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2006
     *  @return {CustomEvent} the custom event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2007
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2008
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2009
    publish: function(type, opts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2010
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2011
        var ret,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2012
            etState = this._yuievt,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2013
            etConfig = etState.config,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2014
            pre = etConfig.prefix;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2015
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2016
        if (typeof type === "string")  {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2017
            if (pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2018
                type = _getType(type, pre);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2019
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2020
            ret = this._publish(type, etConfig, opts);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2021
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2022
            ret = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2023
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2024
            Y.each(type, function(v, k) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2025
                if (pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2026
                    k = _getType(k, pre);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2027
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2028
                ret[k] = this._publish(k, etConfig, v || opts);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2029
            }, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2030
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2031
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2032
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2033
        return ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2034
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2035
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2036
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2037
     * Returns the fully qualified type, given a short type string.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2038
     * That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2039
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2040
     * NOTE: This method, unlike _getType, does no checking of the value passed in, and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2041
     * is designed to be used with the low level _publish() method, for critical path
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2042
     * implementations which need to fast-track publish for performance reasons.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2043
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2044
     * @method _getFullType
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2045
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2046
     * @param {String} type The short type to prefix
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2047
     * @return {String} The prefixed type, if a prefix is set, otherwise the type passed in
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2048
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2049
    _getFullType : function(type) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2050
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2051
        var pre = this._yuievt.config.prefix;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2052
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2053
        if (pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2054
            return pre + PREFIX_DELIMITER + type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2055
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2056
            return type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2057
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2058
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2059
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2060
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2061
     * The low level event publish implementation. It expects all the massaging to have been done
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2062
     * outside of this method. e.g. the `type` to `fullType` conversion. It's designed to be a fast
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2063
     * path publish, which can be used by critical code paths to improve performance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2064
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2065
     * @method _publish
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2066
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2067
     * @param {String} fullType The prefixed type of the event to publish.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2068
     * @param {Object} etOpts The EventTarget specific configuration to mix into the published event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2069
     * @param {Object} ceOpts The publish specific configuration to mix into the published event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2070
     * @return {CustomEvent} The published event. If called without `etOpts` or `ceOpts`, this will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2071
     * be the default `CustomEvent` instance, and can be configured independently.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2072
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2073
    _publish : function(fullType, etOpts, ceOpts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2074
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2075
        var ce,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2076
            etState = this._yuievt,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2077
            etConfig = etState.config,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2078
            host = etConfig.host,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2079
            context = etConfig.context,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2080
            events = etState.events;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2081
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2082
        ce = events[fullType];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2083
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2084
        // PERF: Hate to pull the check out of monitor, but trying to keep critical path tight.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2085
        if ((etConfig.monitored && !ce) || (ce && ce.monitored)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2086
            this._monitor('publish', fullType, {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2087
                args: arguments
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2088
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2089
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2090
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2091
        if (!ce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2092
            // Publish event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2093
            ce = events[fullType] = new Y.CustomEvent(fullType, etOpts);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2094
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2095
            if (!etOpts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2096
                ce.host = host;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2097
                ce.context = context;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2098
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2099
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2100
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2101
        if (ceOpts) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2102
            mixConfigs(ce, ceOpts, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2103
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2104
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2105
        return ce;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2106
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2107
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2108
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2109
     * This is the entry point for the event monitoring system.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2110
     * You can monitor 'attach', 'detach', 'fire', and 'publish'.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2111
     * When configured, these events generate an event.  click ->
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2112
     * click_attach, click_detach, click_publish -- these can
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2113
     * be subscribed to like other events to monitor the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2114
     * system.  Inividual published events can have monitoring
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2115
     * turned on or off (publish can't be turned off before it
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2116
     * it published) by setting the events 'monitor' config.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2117
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2118
     * @method _monitor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2119
     * @param what {String} 'attach', 'detach', 'fire', or 'publish'
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2120
     * @param eventType {String|CustomEvent} The prefixed name of the event being monitored, or the CustomEvent object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2121
     * @param o {Object} Information about the event interaction, such as
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2122
     *                  fire() args, subscription category, publish config
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2123
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2124
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2125
    _monitor: function(what, eventType, o) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2126
        var monitorevt, ce, type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2127
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2128
        if (eventType) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2129
            if (typeof eventType === "string") {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2130
                type = eventType;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2131
                ce = this.getEvent(eventType, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2132
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2133
                ce = eventType;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2134
                type = eventType.type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2135
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2136
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2137
            if ((this._yuievt.config.monitored && (!ce || ce.monitored)) || (ce && ce.monitored)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2138
                monitorevt = type + '_' + what;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2139
                o.monitored = what;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2140
                this.fire.call(this, monitorevt, o);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2141
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2142
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2143
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2144
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2145
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2146
     * Fire a custom event by name.  The callback functions will be executed
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2147
     * from the context specified when the event was created, and with the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2148
     * following parameters.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2149
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2150
     * The first argument is the event type, and any additional arguments are
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2151
     * passed to the listeners as parameters.  If the first of these is an
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2152
     * object literal, and the event is configured to emit an event facade,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2153
     * that object is mixed into the event facade and the facade is provided
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2154
     * in place of the original object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2155
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2156
     * If the custom event object hasn't been created, then the event hasn't
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2157
     * been published and it has no subscribers.  For performance sake, we
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2158
     * immediate exit in this case.  This means the event won't bubble, so
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2159
     * if the intention is that a bubble target be notified, the event must
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2160
     * be published on this object first.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2161
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2162
     * @method fire
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2163
     * @param type {String|Object} The type of the event, or an object that contains
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2164
     * a 'type' property.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2165
     * @param arguments {Object*} an arbitrary set of parameters to pass to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2166
     * the handler.  If the first of these is an object literal and the event is
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2167
     * configured to emit an event facade, the event facade will replace that
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2168
     * parameter after the properties the object literal contains are copied to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2169
     * the event facade.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2170
     * @return {Boolean} True if the whole lifecycle of the event went through,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2171
     * false if at any point the event propagation was halted.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2172
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2173
    fire: function(type) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2174
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2175
        var typeIncluded = (typeof type === "string"),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2176
            argCount = arguments.length,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2177
            t = type,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2178
            yuievt = this._yuievt,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2179
            etConfig = yuievt.config,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2180
            pre = etConfig.prefix,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2181
            ret,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2182
            ce,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2183
            ce2,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2184
            args;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2185
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2186
        if (typeIncluded && argCount <= 3) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2187
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2188
            // PERF: Try to avoid slice/iteration for the common signatures
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2189
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2190
            // Most common
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2191
            if (argCount === 2) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2192
                args = [arguments[1]]; // fire("foo", {})
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2193
            } else if (argCount === 3) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2194
                args = [arguments[1], arguments[2]]; // fire("foo", {}, opts)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2195
            } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2196
                args = []; // fire("foo")
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2197
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2198
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2199
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2200
            args = nativeSlice.call(arguments, ((typeIncluded) ? 1 : 0));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2201
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2202
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2203
        if (!typeIncluded) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2204
            t = (type && type.type);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2205
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2206
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2207
        if (pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2208
            t = _getType(t, pre);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2209
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2210
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2211
        ce = yuievt.events[t];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2212
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2213
        if (this._hasSiblings) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2214
            ce2 = this.getSibling(t, ce);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2215
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2216
            if (ce2 && !ce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2217
                ce = this.publish(t);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2218
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2219
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2220
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2221
        // PERF: trying to avoid function call, since this is a critical path
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2222
        if ((etConfig.monitored && (!ce || ce.monitored)) || (ce && ce.monitored)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2223
            this._monitor('fire', (ce || t), {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2224
                args: args
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2225
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2226
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2227
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2228
        // this event has not been published or subscribed to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2229
        if (!ce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2230
            if (yuievt.hasTargets) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2231
                return this.bubble({ type: t }, args, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2232
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2233
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2234
            // otherwise there is nothing to be done
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2235
            ret = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2236
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2237
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2238
            if (ce2) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2239
                ce.sibling = ce2;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2240
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2241
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2242
            ret = ce._fire(args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2243
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2244
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2245
        return (yuievt.chain) ? this : ret;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2246
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2247
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2248
    getSibling: function(type, ce) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2249
        var ce2;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2250
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2251
        // delegate to *:type events if there are subscribers
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2252
        if (type.indexOf(PREFIX_DELIMITER) > -1) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2253
            type = _wildType(type);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2254
            ce2 = this.getEvent(type, true);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2255
            if (ce2) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2256
                ce2.applyConfig(ce);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2257
                ce2.bubbles = false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2258
                ce2.broadcast = 0;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2259
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2260
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2261
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2262
        return ce2;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2263
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2264
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2265
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2266
     * Returns the custom event of the provided type has been created, a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2267
     * falsy value otherwise
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2268
     * @method getEvent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2269
     * @param type {String} the type, or name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2270
     * @param prefixed {String} if true, the type is prefixed already
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2271
     * @return {CustomEvent} the custom event or null
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2272
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2273
    getEvent: function(type, prefixed) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2274
        var pre, e;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2275
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2276
        if (!prefixed) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2277
            pre = this._yuievt.config.prefix;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2278
            type = (pre) ? _getType(type, pre) : type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2279
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2280
        e = this._yuievt.events;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2281
        return e[type] || null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2282
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2283
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2284
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2285
     * Subscribe to a custom event hosted by this object.  The
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2286
     * supplied callback will execute after any listeners add
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2287
     * via the subscribe method, and after the default function,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2288
     * if configured for the event, has executed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2289
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2290
     * @method after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2291
     * @param {String} type The name of the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2292
     * @param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2293
     * @param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2294
     * @param {Any} [arg*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2295
     * @return {EventHandle} A subscription handle capable of detaching the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2296
     *                       subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2297
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2298
    after: function(type, fn) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2299
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2300
        var a = nativeSlice.call(arguments, 0);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2301
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2302
        switch (L.type(type)) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2303
            case 'function':
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2304
                return Y.Do.after.apply(Y.Do, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2305
            case 'array':
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2306
            //     YArray.each(a[0], function(v) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2307
            //         v = AFTER_PREFIX + v;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2308
            //     });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2309
            //     break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2310
            case 'object':
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2311
                a[0]._after = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2312
                break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2313
            default:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2314
                a[0] = AFTER_PREFIX + type;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2315
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2316
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2317
        return this.on.apply(this, a);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2318
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2319
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2320
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2321
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2322
     * Executes the callback before a DOM event, custom event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2323
     * or method.  If the first argument is a function, it
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2324
     * is assumed the target is a method.  For DOM and custom
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2325
     * events, this is an alias for Y.on.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2326
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2327
     * For DOM and custom events:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2328
     * type, callback, context, 0-n arguments
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2329
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2330
     * For methods:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2331
     * callback, object (method host), methodName, context, 0-n arguments
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2332
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2333
     * @method before
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2334
     * @return detach handle
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2335
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2336
    before: function() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2337
        return this.on.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2338
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2339
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2340
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2341
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2342
Y.EventTarget = ET;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2343
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2344
// make Y an event target
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2345
Y.mix(Y, ET.prototype);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2346
ET.call(Y, { bubbles: false });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2347
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2348
YUI.Env.globalEvents = YUI.Env.globalEvents || new ET();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2349
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2350
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2351
 * Hosts YUI page level events.  This is where events bubble to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2352
 * when the broadcast config is set to 2.  This property is
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2353
 * only available if the custom event module is loaded.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2354
 * @property Global
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2355
 * @type EventTarget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2356
 * @for YUI
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2357
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2358
Y.Global = YUI.Env.globalEvents;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2359
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2360
// @TODO implement a global namespace function on Y.Global?
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2361
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2362
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2363
`Y.on()` can do many things:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2364
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2365
<ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2366
    <li>Subscribe to custom events `publish`ed and `fire`d from Y</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2367
    <li>Subscribe to custom events `publish`ed with `broadcast` 1 or 2 and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2368
        `fire`d from any object in the YUI instance sandbox</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2369
    <li>Subscribe to DOM events</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2370
    <li>Subscribe to the execution of a method on any object, effectively
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2371
    treating that method as an event</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2372
</ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2373
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2374
For custom event subscriptions, pass the custom event name as the first argument
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2375
and callback as the second. The `this` object in the callback will be `Y` unless
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2376
an override is passed as the third argument.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2377
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2378
    Y.on('io:complete', function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2379
        Y.MyApp.updateStatus('Transaction complete');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2380
    });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2381
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2382
To subscribe to DOM events, pass the name of a DOM event as the first argument
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2383
and a CSS selector string as the third argument after the callback function.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2384
Alternately, the third argument can be a `Node`, `NodeList`, `HTMLElement`,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2385
array, or simply omitted (the default is the `window` object).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2386
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2387
    Y.on('click', function (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2388
        e.preventDefault();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2389
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2390
        // proceed with ajax form submission
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2391
        var url = this.get('action');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2392
        ...
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2393
    }, '#my-form');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2394
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2395
The `this` object in DOM event callbacks will be the `Node` targeted by the CSS
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2396
selector or other identifier.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2397
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2398
`on()` subscribers for DOM events or custom events `publish`ed with a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2399
`defaultFn` can prevent the default behavior with `e.preventDefault()` from the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2400
event object passed as the first parameter to the subscription callback.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2401
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2402
To subscribe to the execution of an object method, pass arguments corresponding to the call signature for
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2403
<a href="../classes/Do.html#methods_before">`Y.Do.before(...)`</a>.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2404
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2405
NOTE: The formal parameter list below is for events, not for function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2406
injection.  See `Y.Do.before` for that signature.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2407
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2408
@method on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2409
@param {String} type DOM or custom event name
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2410
@param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2411
@param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2412
@param {Any} [arg*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2413
@return {EventHandle} A subscription handle capable of detaching the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2414
                      subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2415
@see Do.before
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2416
@for YUI
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2417
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2418
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2419
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2420
Listen for an event one time.  Equivalent to `on()`, except that
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2421
the listener is immediately detached when executed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2422
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2423
See the <a href="#methods_on">`on()` method</a> for additional subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2424
options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2425
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2426
@see on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2427
@method once
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2428
@param {String} type DOM or custom event name
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2429
@param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2430
@param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2431
@param {Any} [arg*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2432
@return {EventHandle} A subscription handle capable of detaching the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2433
                      subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2434
@for YUI
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2435
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2436
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2437
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2438
Listen for an event one time.  Equivalent to `once()`, except, like `after()`,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2439
the subscription callback executes after all `on()` subscribers and the event's
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2440
`defaultFn` (if configured) have executed.  Like `after()` if any `on()` phase
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2441
subscriber calls `e.preventDefault()`, neither the `defaultFn` nor the `after()`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2442
subscribers will execute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2443
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2444
The listener is immediately detached when executed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2445
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2446
See the <a href="#methods_on">`on()` method</a> for additional subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2447
options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2448
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2449
@see once
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2450
@method onceAfter
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2451
@param {String} type The custom event name
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2452
@param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2453
@param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2454
@param {Any} [arg*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2455
@return {EventHandle} A subscription handle capable of detaching the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2456
                      subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2457
@for YUI
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2458
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2459
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2460
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2461
Like `on()`, this method creates a subscription to a custom event or to the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2462
execution of a method on an object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2463
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2464
For events, `after()` subscribers are executed after the event's
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2465
`defaultFn` unless `e.preventDefault()` was called from an `on()` subscriber.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2466
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2467
See the <a href="#methods_on">`on()` method</a> for additional subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2468
options.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2469
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2470
NOTE: The subscription signature shown is for events, not for function
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2471
injection.  See <a href="../classes/Do.html#methods_after">`Y.Do.after`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2472
for that signature.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2473
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2474
@see on
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2475
@see Do.after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2476
@method after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2477
@param {String} type The custom event name
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2478
@param {Function} fn The callback to execute in response to the event
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2479
@param {Object} [context] Override `this` object in callback
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2480
@param {Any} [args*] 0..n additional arguments to supply to the subscriber
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2481
@return {EventHandle} A subscription handle capable of detaching the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2482
                      subscription
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2483
@for YUI
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2484
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2485
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2486
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  2487
}, '@VERSION@', {"requires": ["oop"]});