| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329 |
- /*
- Copyright (c) 2010, Yahoo! Inc. All rights reserved.
- Code licensed under the BSD License:
- http://developer.yahoo.com/yui/license.html
- version: 3.4.0
- build: nightly
- */
- YUI.add('base-build', function(Y) {
-
- /**
- * The base-build submodule provides Base.build functionality, which
- * can be used to create custom classes, by aggregating extensions onto
- * a main class.
- *
- * @module base
- * @submodule base-build
- * @for Base
- */
- var Base = Y.Base,
- L = Y.Lang,
- INITIALIZER = "initializer",
- DESTRUCTOR = "destructor",
- build;
-
- Base._build = function(name, main, extensions, px, sx, cfg) {
-
- var build = Base._build,
-
- builtClass = build._ctor(main, cfg),
- buildCfg = build._cfg(main, cfg),
-
- _mixCust = build._mixCust,
-
- aggregates = buildCfg.aggregates,
- custom = buildCfg.custom,
-
- dynamic = builtClass._yuibuild.dynamic,
-
- i, l, val, extClass, extProto,
- initializer,
- destructor;
-
- if (dynamic && aggregates) {
- for (i = 0, l = aggregates.length; i < l; ++i) {
- val = aggregates[i];
- if (main.hasOwnProperty(val)) {
- builtClass[val] = L.isArray(main[val]) ? [] : {};
- }
- }
- }
-
- // Augment/Aggregate
- for (i = 0, l = extensions.length; i < l; i++) {
- extClass = extensions[i];
-
- extProto = extClass.prototype;
-
- initializer = extProto[INITIALIZER];
- destructor = extProto[DESTRUCTOR];
- delete extProto[INITIALIZER];
- delete extProto[DESTRUCTOR];
-
- // Prototype, old non-displacing augment
- Y.mix(builtClass, extClass, true, null, 1);
-
- // Custom Statics
- _mixCust(builtClass, extClass, aggregates, custom);
-
- if (initializer) {
- extProto[INITIALIZER] = initializer;
- }
-
- if (destructor) {
- extProto[DESTRUCTOR] = destructor;
- }
-
- builtClass._yuibuild.exts.push(extClass);
- }
-
- if (px) {
- Y.mix(builtClass.prototype, px, true);
- }
-
- if (sx) {
- Y.mix(builtClass, build._clean(sx, aggregates, custom), true);
- _mixCust(builtClass, sx, aggregates, custom);
- }
-
- builtClass.prototype.hasImpl = build._impl;
-
- if (dynamic) {
- builtClass.NAME = name;
- builtClass.prototype.constructor = builtClass;
- }
-
- return builtClass;
- };
-
- build = Base._build;
-
- Y.mix(build, {
-
- _mixCust: function(r, s, aggregates, custom) {
-
- if (aggregates) {
- Y.aggregate(r, s, true, aggregates);
- }
-
- if (custom) {
- for (var j in custom) {
- if (custom.hasOwnProperty(j)) {
- custom[j](j, r, s);
- }
- }
- }
- },
-
- _tmpl: function(main) {
-
- function BuiltClass() {
- BuiltClass.superclass.constructor.apply(this, arguments);
- }
- Y.extend(BuiltClass, main);
-
- return BuiltClass;
- },
-
- _impl : function(extClass) {
- var classes = this._getClasses(), i, l, cls, exts, ll, j;
- for (i = 0, l = classes.length; i < l; i++) {
- cls = classes[i];
- if (cls._yuibuild) {
- exts = cls._yuibuild.exts;
- ll = exts.length;
-
- for (j = 0; j < ll; j++) {
- if (exts[j] === extClass) {
- return true;
- }
- }
- }
- }
- return false;
- },
-
- _ctor : function(main, cfg) {
-
- var dynamic = (cfg && false === cfg.dynamic) ? false : true,
- builtClass = (dynamic) ? build._tmpl(main) : main,
- buildCfg = builtClass._yuibuild;
-
- if (!buildCfg) {
- buildCfg = builtClass._yuibuild = {};
- }
-
- buildCfg.id = buildCfg.id || null;
- buildCfg.exts = buildCfg.exts || [];
- buildCfg.dynamic = dynamic;
-
- return builtClass;
- },
-
- _cfg : function(main, cfg) {
- var aggr = [],
- cust = {},
- buildCfg,
- cfgAggr = (cfg && cfg.aggregates),
- cfgCustBuild = (cfg && cfg.custom),
- c = main;
-
- while (c && c.prototype) {
- buildCfg = c._buildCfg;
- if (buildCfg) {
- if (buildCfg.aggregates) {
- aggr = aggr.concat(buildCfg.aggregates);
- }
- if (buildCfg.custom) {
- Y.mix(cust, buildCfg.custom, true);
- }
- }
- c = c.superclass ? c.superclass.constructor : null;
- }
-
- if (cfgAggr) {
- aggr = aggr.concat(cfgAggr);
- }
- if (cfgCustBuild) {
- Y.mix(cust, cfg.cfgBuild, true);
- }
-
- return {
- aggregates: aggr,
- custom: cust
- };
- },
-
- _clean : function(sx, aggregates, custom) {
- var prop, i, l, sxclone = Y.merge(sx);
-
- for (prop in custom) {
- if (sxclone.hasOwnProperty(prop)) {
- delete sxclone[prop];
- }
- }
-
- for (i = 0, l = aggregates.length; i < l; i++) {
- prop = aggregates[i];
- if (sxclone.hasOwnProperty(prop)) {
- delete sxclone[prop];
- }
- }
-
- return sxclone;
- }
- });
-
- /**
- * <p>
- * Builds a custom constructor function (class) from the
- * main function, and array of extension functions (classes)
- * provided. The NAME field for the constructor function is
- * defined by the first argument passed in.
- * </p>
- * <p>
- * The cfg object supports the following properties
- * </p>
- * <dl>
- * <dt>dynamic <boolean></dt>
- * <dd>
- * <p>If true (default), a completely new class
- * is created which extends the main class, and acts as the
- * host on which the extension classes are augmented.</p>
- * <p>If false, the extensions classes are augmented directly to
- * the main class, modifying the main class' prototype.</p>
- * </dd>
- * <dt>aggregates <String[]></dt>
- * <dd>An array of static property names, which will get aggregated
- * on to the built class, in addition to the default properties build
- * will always aggregate as defined by the main class' static _buildCfg
- * property.
- * </dd>
- * </dl>
- *
- * @method build
- * @deprecated Use the more convenient Base.create and Base.mix methods instead
- * @static
- * @param {Function} name The name of the new class. Used to defined the NAME property for the new class.
- * @param {Function} main The main class on which to base the built class
- * @param {Function[]} extensions The set of extension classes which will be
- * augmented/aggregated to the built class.
- * @param {Object} cfg Optional. Build configuration for the class (see description).
- * @return {Function} A custom class, created from the provided main and extension classes
- */
- Base.build = function(name, main, extensions, cfg) {
- return build(name, main, extensions, null, null, cfg);
- };
-
- /**
- * <p>Creates a new class (constructor function) which extends the base class passed in as the second argument,
- * and mixes in the array of extensions provided.</p>
- * <p>Prototype properties or methods can be added to the new class, using the px argument (similar to Y.extend).</p>
- * <p>Static properties or methods can be added to the new class, using the sx argument (similar to Y.extend).</p>
- * <p>
- *
- * </p>
- * @method create
- * @static
- * @param {Function} name The name of the newly created class. Used to defined the NAME property for the new class.
- * @param {Function} main The base class which the new class should extend. This class needs to be Base or a class derived from base (e.g. Widget).
- * @param {Function[]} extensions The list of extensions which will be mixed into the built class.
- * @param {Object} px The set of prototype properties/methods to add to the built class.
- * @param {Object} sx The set of static properties/methods to add to the built class.
- * @return {Function} The newly created class.
- */
- Base.create = function(name, base, extensions, px, sx) {
- return build(name, base, extensions, px, sx);
- };
-
- /**
- * <p>Mixes in a list of extensions to an existing class.</p>
- * @method mix
- * @static
- * @param {Function} main The existing class into which the extensions should be mixed. The class needs to be Base or a class derived from Base (e.g. Widget)
- * @param {Function[]} extensions The set of extension classes which will mixed into the existing main class.
- * @return {Function} The modified main class, with extensions mixed in.
- */
- Base.mix = function(main, extensions) {
- return build(null, main, extensions, null, null, {dynamic:false});
- };
-
- /**
- * The build configuration for the Base class.
- *
- * Defines the static fields which need to be aggregated
- * when the Base class is used as the main class passed to
- * the <a href="#method_Base.build">Base.build</a> method.
- *
- * @property _buildCfg
- * @type Object
- * @static
- * @final
- * @private
- */
- Base._buildCfg = {
- custom : {
- ATTRS : function(prop, r, s) {
-
- r.ATTRS = r.ATTRS || {};
-
- if (s.ATTRS) {
-
- var sAttrs = s.ATTRS,
- rAttrs = r.ATTRS,
- a;
-
- for (a in sAttrs) {
- if (sAttrs.hasOwnProperty(a)) {
- rAttrs[a] = rAttrs[a] || {};
- Y.mix(rAttrs[a], sAttrs[a], true);
- }
- }
- }
- }
- },
- aggregates : ["_PLUG", "_UNPLUG"]
- };
-
-
- }, '3.4.0' ,{requires:['base-base']});
|