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