base-core.js revision f10b3c93791aa567aa9c97435d49a373447f7279
/**
* The base module provides the Base class, which objects requiring attribute and custom event support can extend.
* The module also provides two ways to reuse code - It augments Base with the Plugin.Host interface which provides
* plugin support and also provides the BaseCore.build method which provides a way to build custom classes using extensions.
*
* @module base
*/
/**
* <p>The base-core module provides the BaseCore class, the lightest version of Base,
* which provides Base's basic lifecycle management and ATTRS construction support,
*
* <p>It mixes in AttributeCore, which is the lightest version of Attribute</p>
*
* @module base
* @submodule base-core
*/
var O = Y.Object,
L = Y.Lang,
DOT = ".",
INITIALIZED = "initialized",
DESTROYED = "destroyed",
INITIALIZER = "initializer",
DEEP = "deep",
SHALLOW = "shallow",
DESTRUCTOR = "destructor",
var p;
for (p in s) {
if(wlhash[p]) {
r[p] = s[p];
}
}
return r;
};
/**
* The BaseCore class, is the lightest version of Base, and provides Base's
* basic lifecycle management and ATTRS construction support, but doesn't
*
* BaseCore also handles the chaining of initializer and destructor methods across
* the hierarchy as part of object construction and destruction. Additionally, attributes
* configured through the static <a href="#property_BaseCore.ATTRS">ATTRS</a>
* property for each class in the hierarchy will be initialized by BaseCore.
*
* change events can extend BaseCore instead of Base for optimal kweight and
* runtime performance.
*
* @class BaseCore
* @constructor
* @uses AttributeCore
* The object can be used to provide initial values for the objects published
* attributes.
*/
if (!this._BaseInvoked) {
this._BaseInvoked = true;
}
}
/**
* The list of properties which can be configured for each attribute
* (e.g. setter, getter, writeOnce, readOnly etc.)
*
* @property _ATTR_CFG
* @type Array
* @static
* @private
*/
/**
* <p>
* The string to be used to identify instances of this class.
* </p>
* <p>
* Classes extending BaseCore, should define their own
* static NAME property, which should be camelCase by
* convention (e.g. MyClass.NAME = "myClass";).
* </p>
* @property NAME
* @type String
* @static
*/
/**
* The default set of attributes which will be available for instances of this class, and
* their configuration. In addition to the configuration properties listed by
* AttributeCore's <a href="AttributeCore.html#method_addAttr">addAttr</a> method,
* the attribute can also be configured with a "cloneDefaultValue" property, which
* defines how the statically defined value field should be protected
* ("shallow", "deep" and false are supported values).
*
* By default if the value is an object literal or an array it will be "shallow"
* cloned, to protect the default value.
*
* @property ATTRS
* @type Object
* @static
*/
/**
* Flag indicating whether or not this object
* has been through the init lifecycle phase.
*
* @attribute initialized
* @readonly
* @default false
* @type boolean
*/
initialized: {
readOnly:true,
value:false
},
/**
* Flag indicating whether or not this object
* has been through the destroy lifecycle phase.
*
* @attribute destroyed
* @readonly
* @default false
* @type boolean
*/
destroyed: {
readOnly:true,
value:false
}
};
/**
* Internal construction logic for BaseCore.
*
* @method _initBase
* @param {Object} config The constructor configuration object
* @private
*/
Y.stamp(this);
this._initAttribute(config);
// If Plugin.Host has been augmented [ through base-pluginhost ], setup it's
// initial state, but don't initialize Plugins yet. That's done after initialization.
if (this._initPlugins && PluginHost) {
PluginHost.call(this);
}
if (this._lazyAddAttrs !== false) { this._lazyAddAttrs = true; }
/**
* The string used to identify the class of this object.
*
* @deprecated Use this.constructor.NAME
* @property name
* @type String
*/
},
/**
* Initializes AttributeCore
*
* @method _initAttribute
* @private
*/
_initAttribute: function() {
AttributeCore.apply(this);
},
/**
* Init lifecycle method, invoked during construction. Sets up attributes
* and invokes initializers for the class hierarchy.
*
* @method init
* @chainable
* @return {BaseCore} A reference to this object
*/
return this;
},
/**
* Internal initialization implementation for BaseCore
*
* @method _baseInit
* @private
*/
this._initHierarchy(cfg);
if (this._initPlugins) {
// Need to initPlugins manually, to handle constructor parsing, static Plug parsing
this._initPlugins(cfg);
}
this._set(INITIALIZED, true);
},
/**
* Destroy lifecycle method. Invokes destructors for the class hierarchy.
*
* @method destroy
* @return {BaseCore} A reference to this object
* @chainable
*/
destroy: function() {
this._baseDestroy();
return this;
},
/**
* Internal destroy implementation for BaseCore
*
* @method _baseDestroy
* @private
*/
_baseDestroy : function() {
if (this._destroyPlugins) {
this._destroyPlugins();
}
this._destroyHierarchy();
},
/**
* Returns the class hierarchy for this object, with BaseCore being the last class in the array.
*
* @method _getClasses
* @protected
* @return {Function[]} An array of classes (constructor functions), making up the class hierarchy for this object.
* This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the
* cached value.
*/
_getClasses : function() {
if (!this._classes) {
this._initHierarchyData();
}
return this._classes;
},
/**
* Returns an aggregated set of attribute configurations, by traversing
* the class hierarchy.
*
* @method _getAttrCfgs
* @protected
* @return {Object} The hash of attribute configurations, aggregated across classes in the hierarchy
* This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return
* the cached value.
*/
_getAttrCfgs : function() {
if (!this._attrs) {
this._initHierarchyData();
}
return this._attrs;
},
/**
* A helper method used when processing ATTRS across the class hierarchy during
* initialization. Returns a disposable object with the attributes defined for
* the provided class, extracted from the set of all attributes passed in .
*
* @method _filterAttrCfs
* @private
*
* @param {Function} clazz The class for which the desired attributes are required.
* @param {Object} allCfgs The set of all attribute configurations for this instance.
* Attributes will be removed from this set, if they belong to the filtered class, so
* that by the time all classes are processed, allCfgs will be empty.
*
* @return {Object} The set of attributes belonging to the class passed in, in the form
* of an object with attribute name/configuration pairs.
*/
if (attrs) {
}
}
}
return cfgs;
},
/**
* A helper method used by _getClasses and _getAttrCfgs, which determines both
* the array of classes and aggregate set of attribute configurations
* across the class hierarchy for the instance.
*
* @method _initHierarchyData
* @private
*/
_initHierarchyData : function() {
var c = this.constructor,
classes = [],
attrs = [];
while (c) {
// Add to classes
// Add to attributes
if (c.ATTRS) {
}
}
},
/**
* this class.
*
* @method _attrCfgHash
* @private
*/
_attrCfgHash: function() {
return BaseCore._ATTR_CFG_HASH;
},
/**
* A helper method, used by _initHierarchyData to aggregate
* attribute configuration across the instances class hierarchy.
*
* The method will protect the attribute configuration value to protect the statically defined
* default value in ATTRS if required (if the value is an object literal, array or the
* attribute configuration has cloneDefaultValue set to shallow or deep).
*
* @method _aggregateAttrs
* @private
* @param {Array} allAttrs An array of ATTRS definitions across classes in the hierarchy
* (subclass first, Base last)
* @return {Object} The aggregate set of ATTRS definitions for the instance
*/
_aggregateAttrs : function(allAttrs) {
var attr,
cfg,
val,
path,
i,
cfgPropsHash = this._attrCfgHash(),
aggAttrs = {};
if (allAttrs) {
// Protect config passed in
//cfg = Y.mix({}, attrs[attr], true, cfgProps);
//cfg = Y.Object(attrs[attr]);
if (val) {
if ( (clone === undefined && (OBJECT_CONSTRUCTOR === val.constructor || L.isArray(val))) || clone === DEEP || clone === true) {
}
// else if (clone === false), don't clone the static default value.
// It's intended to be used by reference.
}
path = null;
}
} else if (!path) {
} else {
}
}
}
}
}
}
return aggAttrs;
},
/**
* Initializes the class hierarchy for the instance, which includes
* initializing attributes for each class defined in the class's
* static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and
* invoking the initializer method on the prototype of each class in the hierarchy.
*
* @method _initHierarchy
* @private
*/
_initHierarchy : function(userVals) {
var lazy = this._lazyAddAttrs,
ci,
ei,
el,
exts,
classes = this._getClasses(),
attrCfgs = this._getAttrCfgs();
if (exts) {
}
}
// Using INITIALIZER in hasOwnProperty check, for performance reasons (helps IE6 avoid GC thresholds when
// referencing string literals). Not using it in apply, again, for performance "." is faster.
}
if (exts) {
}
}
}
}
},
/**
* Destroys the class hierarchy for this instance by invoking
* the destructor method on the prototype of each class in the hierarchy.
*
* @method _destroyHierarchy
* @private
*/
_destroyHierarchy : function() {
var constr,
classes = this._getClasses();
if (exts) {
}
}
}
}
}
},
/**
* Default toString implementation. Provides the constructor NAME
* and the instance guid, if set.
*
* @method toString
* @return {String} String representation for this object
*/
toString: function() {
}
};
// Straightup augment, no wrapper functions
// Fix constructor