src/cm/media/js/lib/yui/yui3-3.15.0/build/attribute-base/attribute-base.js
author gibus
Mon, 10 Mar 2014 15:19:48 +0100
changeset 602 e16a97fb364a
permissions -rw-r--r--
Use YUI 3.15
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('attribute-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 attribute module provides an augmentable Attribute implementation, which
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
     * adds configurable attributes and attribute change events to the class being
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
     * augmented. It also provides a State class, which is used internally by Attribute,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
     * but can also be used independently to provide a name/property/value data structure to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
     * store state.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
     * @module attribute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
     * The attribute-base submodule provides core attribute handling support, with everything
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
     * aside from complex attribute handling in the provider's constructor.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
     * @module attribute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
     * @submodule attribute-base
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
     * <p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
     * Attribute provides configurable attribute support along with attribute change events. It is designed to be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
     * augmented on to a host class, and provides the host with the ability to configure attributes to store and retrieve state,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
     * along with attribute change events.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
     * <p>For example, attributes added to the host can be configured:</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
     * <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
     *     <li>As read only.</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
     *     <li>As write once.</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
     *     <li>With a setter function, which can be used to manipulate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
     *     values passed to Attribute's <a href="#method_set">set</a> method, before they are stored.</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
     *     <li>With a getter function, which can be used to manipulate stored values,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
     *     before they are returned by Attribute's <a href="#method_get">get</a> method.</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
     *     <li>With a validator function, to validate values before they are stored.</li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
     * </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
     * <p>See the <a href="#method_addAttr">addAttr</a> method, for the complete set of configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
     * options available for attributes.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
     * <p><strong>NOTE:</strong> Most implementations will be better off extending the <a href="Base.html">Base</a> class,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
     * instead of augmenting Attribute directly. Base augments Attribute and will handle the initial configuration
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
     * of attributes for derived classes, accounting for values passed into the constructor.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
     * @class Attribute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
     * @param attrs {Object} The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
     *        These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
     * @param values {Object} The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
     *        These are not merged/cloned. The caller is responsible for isolating user provided values if required.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
     * @param lazy {boolean} Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
     * @uses AttributeCore
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
     * @uses AttributeObservable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
     * @uses EventTarget
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
     * @uses AttributeExtras
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
    function Attribute() {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
        Y.AttributeCore.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
        Y.AttributeObservable.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
        Y.AttributeExtras.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
    Y.mix(Attribute, Y.AttributeCore, false, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
    Y.mix(Attribute, Y.AttributeExtras, false, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
    // Needs to be `true`, to overwrite methods from AttributeCore
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
    Y.mix(Attribute, Y.AttributeObservable, true, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
     * <p>The value to return from an attribute setter in order to prevent the set from going through.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
     * <p>You can return this value from your setter if you wish to combine validator and setter
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
     * functionality into a single setter function, which either returns the massaged value to be stored or
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
     * AttributeCore.INVALID_VALUE to prevent invalid values from being stored.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
     * @property INVALID_VALUE
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
     * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
     * @final
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
    Attribute.INVALID_VALUE = Y.AttributeCore.INVALID_VALUE;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
     * The list of properties which can be configured for
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
     * each attribute (e.g. setter, getter, writeOnce etc.).
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
     * This property is used internally as a whitelist for faster
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
     * Y.mix operations.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
     * @property _ATTR_CFG
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
     * @type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
    Attribute._ATTR_CFG = Y.AttributeCore._ATTR_CFG.concat(Y.AttributeObservable._ATTR_CFG);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
     * Utility method to protect an attribute configuration hash, by merging the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
     * entire object and the individual attr config objects.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
     * @method protectAttrs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
     * @static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
     * @param {Object} attrs A hash of attribute to configuration object pairs.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
     * @return {Object} A protected version of the `attrs` argument.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
    Attribute.protectAttrs = Y.AttributeCore.protectAttrs;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
    Y.Attribute = Attribute;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
}, '@VERSION@', {"requires": ["attribute-core", "attribute-observable", "attribute-extras"]});