src/cm/media/js/lib/yui/yui3-3.15.0/build/base-base/base-base.js
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 602 e16a97fb364a
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('base-base', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
     * The base module provides the Base class, which objects requiring attribute and custom event support can extend.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
     * The module also provides two ways to reuse code - It augments Base with the Plugin.Host interface which provides
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
     * plugin support and also provides the BaseCore.build method which provides a way to build custom classes using extensions.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
     * @module base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
     * The base-base submodule provides the Base class without the Plugin support, provided by Plugin.Host,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
     * and without the extension support provided by BaseCore.build.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
     * @module base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
     * @submodule base-base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
    var AttributeCore   = Y.AttributeCore,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
        AttributeExtras = Y.AttributeExtras,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
        BaseCore        = Y.BaseCore,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
        BaseObservable  = Y.BaseObservable;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
     * A base class which objects requiring attributes and custom event support can
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
     * extend. Base also handles the chaining of initializer and destructor methods across
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
     * the hierarchy as part of object construction and destruction. Additionally, attributes configured
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
     * through the static <a href="#property_ATTRS">ATTRS</a> property for each class
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
     * in the hierarchy will be initialized by Base.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
     * **NOTE:** Prior to version 3.11.0, ATTRS would get added a class at a time. That is,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
     * Base would loop through each class in the hierarchy, and add the class' ATTRS, and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
     * then call it's initializer, and move on to the subclass' ATTRS and initializer. As of
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
     * 3.11.0, ATTRS from all classes in the hierarchy are added in one `addAttrs` call before
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
     * any initializers are called. This fixes subtle edge-case issues with subclass ATTRS overriding
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
     * superclass `setter`, `getter` or `valueFn` definitions and being unable to get/set attributes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
     * defined by the subclass. This order of operation change may impact `setter`, `getter` or `valueFn`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
     * code which expects a superclass' initializer to have run. This is expected to be rare, but to support
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
     * it, Base supports a `_preAddAttrs()`, method hook (same signature as `addAttrs`). Components can
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
     * implement this method on their prototype for edge cases which do require finer control over
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
     * the order in which attributes are added (see widget-htmlparser).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
     * The static <a href="#property_NAME">NAME</a> property of each class extending
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
     * from Base will be used as the identifier for the class, and is used by Base to prefix
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
     * all events fired by instances of that class.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
     * @class Base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
     * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
     * @uses BaseCore
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
     * @uses BaseObservable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
     * @uses AttributeCore
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
     * @uses AttributeObservable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
     * @uses AttributeExtras
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
     * @uses EventTarget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
     * @param {Object} config Object with configuration property name/value pairs. The object can be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
     * used to provide default values for the objects published attributes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
     * The config object can also contain the following non-attribute properties, providing a convenient
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
     * way to configure events listeners and plugins for the instance, as part of the constructor call:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
     * <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
     *   <dt>on</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
     *   <dd>An event name to listener function map, to register event listeners for the "on" moment of the event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
     *       A constructor convenience property for the <a href="Base.html#method_on">on</a> method.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
     *   <dt>after</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
     *   <dd>An event name to listener function map, to register event listeners for the "after" moment of the event.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
     *       A constructor convenience property for the <a href="Base.html#method_after">after</a> method.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
     *   <dt>bubbleTargets</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
     *   <dd>An object, or array of objects, to register as bubble targets for bubbled events fired by this instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
     *       A constructor convenience property for the <a href="EventTarget.html#method_addTarget">addTarget</a> method.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
     *   <dt>plugins</dt>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
     *   <dd>A plugin, or array of plugins to be plugged into the instance (see PluginHost's plug method for signature details).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
     *       A constructor convenience property for the <a href="Plugin.Host.html#method_plug">plug</a> method.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
     * </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
    function Base() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
        BaseCore.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
        BaseObservable.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
        AttributeExtras.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
     * The list of properties which can be configured for
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
     * each attribute (e.g. setter, getter, writeOnce, readOnly etc.)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
     * @property _ATTR_CFG
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
     * @type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
    Base._ATTR_CFG = BaseCore._ATTR_CFG.concat(BaseObservable._ATTR_CFG);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
     * The array of non-attribute configuration properties supported by this class.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
     * `Base` supports "on", "after", "plugins" and "bubbleTargets" properties,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
     * which are not set up as attributes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
     * This property is primarily required so that when
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
     * <a href="#property__allowAdHocAttrs">`_allowAdHocAttrs`</a> is enabled by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
     * a class, non-attribute configurations don't get added as ad-hoc attributes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
     * @property _NON_ATTRS_CFG
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
     * @type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
    Base._NON_ATTRS_CFG = BaseCore._NON_ATTRS_CFG.concat(BaseObservable._NON_ATTRS_CFG);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
     * The string to be used to identify instances of
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
     * this class, for example in prefixing events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
     * Classes extending Base, should define their own
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
     * static NAME property, which should be camelCase by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
     * convention (e.g. MyClass.NAME = "myClass";).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
     * @property NAME
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
     * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
    Base.NAME = 'base';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
     * The default set of attributes which will be available for instances of this class, and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
     * their configuration. In addition to the configuration properties listed by
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
     * Attribute's <a href="Attribute.html#method_addAttr">addAttr</a> method, the attribute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
     * can also be configured with a "cloneDefaultValue" property, which defines how the statically
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
     * defined value field should be protected ("shallow", "deep" and false are supported values).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
     * By default if the value is an object literal or an array it will be "shallow" cloned, to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
     * protect the default value.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
     * @property ATTRS
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
     * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
    Base.ATTRS = AttributeCore.protectAttrs(BaseCore.ATTRS);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
    Provides a way to safely modify a `Y.Base` subclass' static `ATTRS` after
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
    the class has been defined or created.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
    Base-based classes cache information about the class hierarchy in order to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
    efficiently create instances. This cache includes includes the aggregated
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
    `ATTRS` configs. If the static `ATTRS` configs need to be modified after the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
    class has been defined or create, then use this method which will make sure
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
    to clear any cached data before making any modifications.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
    @method modifyAttrs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
    @param {Function} [ctor] The constructor function whose `ATTRS` should be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
        modified. If a `ctor` function is not specified, then `this` is assumed
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
        to be the constructor which hosts the `ATTRS`.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
    @param {Object} configs The collection of `ATTRS` configs to mix with the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
        existing attribute configurations.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
    @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
    @since 3.10.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
    Base.modifyAttrs = BaseCore.modifyAttrs;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
    Y.mix(Base, BaseCore, false, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
    Y.mix(Base, AttributeExtras, false, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
    // Needs to be `true`, to overwrite methods from `BaseCore`.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
    Y.mix(Base, BaseObservable, true, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
    // Fix constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
    Base.prototype.constructor = Base;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   181
    Y.Base = Base;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   182
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   183
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
}, '@VERSION@', {"requires": ["attribute-base", "base-core", "base-observable"]});