085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * The base module provides the Base class, which objects requiring attribute and custom event support can extend.
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * The module also provides two ways to reuse code - It augments Base with the Plugin.Host interface which provides
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * plugin support and also provides the BaseCore.build method which provides a way to build custom classes using extensions.
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * @module base
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * The base-base submodule provides the Base class without the Plugin support, provided by Plugin.Host,
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * and without the extension support provided by BaseCore.build.
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * @module base
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai * @submodule base-base
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The base module provides the Base class, which objects requiring attribute and custom event support can extend.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The module also provides two ways to reuse code - It augments Base with the Plugin.Host interface which provides
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * plugin support and also provides the Base.build method which provides a way to build custom classes using extensions.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @module base
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The base-base submodule provides the Base class without the Plugin support, provided by Plugin.Host,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * and without the extension support provided by Base.build.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @module base
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @submodule base-base
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * A base class which objects requiring attributes and custom event support can
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * extend. Base also handles the chaining of initializer and destructor methods across
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * the hierarchy as part of object construction and destruction. Additionally, attributes configured
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * through the static <a href="#property_Base.ATTRS">ATTRS</a> property for each class
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * in the hierarchy will be initialized by Base.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The static <a href="#property_Base.NAME">NAME</a> property of each class extending
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * from Base will be used as the identifier for the class, and is used by Base to prefix
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * all events fired by instances of that class.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @class Base
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @constructor
566979db1a58e69d2ba43dd92e29f83868b9ba25Satyen Desai * @uses BaseCore
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @uses Attribute
ed99ee839d187bd8bb990a7f5125d93215c5bb42Satyen Desai * @uses AttributeCore
ed99ee839d187bd8bb990a7f5125d93215c5bb42Satyen Desai * @uses AttributeEvents
ed99ee839d187bd8bb990a7f5125d93215c5bb42Satyen Desai * @uses AttributeExtras
ed99ee839d187bd8bb990a7f5125d93215c5bb42Satyen Desai * @uses EventTarget
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {Object} config Object with configuration property name/value pairs. The object can be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * used to provide default values for the objects published attributes.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The config object can also contain the following non-attribute properties, providing a convenient
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * way to configure events listeners and plugins for the instance, as part of the constructor call:
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>on</dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dd>An event name to listener function map, to register event listeners for the "on" moment of the event. A constructor convenience property for the <a href="Base.html#method_on">on</a> method.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>after</dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dd>An event name to listener function map, to register event listeners for the "after" moment of the event. A constructor convenience property for the <a href="Base.html#method_after">after</a> method.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>bubbleTargets</dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dd>An object, or array of objects, to register as bubble targets for bubbled events fired by this instance. A constructor convenience property for the <a href="EventTarget.html#method_addTarget">addTarget</a> method.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dt>plugins</dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <dd>A plugin, or array of plugins to be plugged into the instance (see PluginHost's plug method for signature details). A constructor convenience property for the <a href="Plugin.Host.html#method_plug">plug</a> method.</dd>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass function Base() {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The list of properties which can be configured for
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * each attribute (e.g. setter, getter, writeOnce, readOnly etc.)
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @property _ATTR_CFG
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Array
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Base._ATTR_CFG = Attribute._ATTR_CFG.concat("cloneDefaultValue");
d41a8347476e02c3d2dea77d95cd665717c1082cSatyen Desai Base._ATTR_CFG_HASH = Y.Array.hash(Base._ATTR_CFG);
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * The array of non-attribute configuration properties supported by this class.
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * `Base` supports "on", "after", "plugins" and "bubbleTargets" properties,
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * which are not set up as attributes.
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * This property is primarily required so that when
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * <a href="#property__allowAdHocAttrs">`_allowAdHocAttrs`</a> is enabled by
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * a class, non-attribute configurations don't get added as ad-hoc attributes.
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * @property _NON_ATTRS_CFG
4cd36cd90f40231cd88acf6c0ab9d2fa89041bf0Satyen Desai * @type Array
ed73fd1af1279111c591bd65981adbdc23a3a94aSatyen Desai Base._NON_ATTRS_CFG = BaseCore._NON_ATTRS_CFG.concat(["on", "after", "bubbleTargets"]);
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The string to be used to identify instances of
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * this class, for example in prefixing events.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Classes extending Base, should define their own
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * static NAME property, which should be camelCase by
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * convention (e.g. MyClass.NAME = "myClass";).
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @property NAME
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type String
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The default set of attributes which will be available for instances of this class, and
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * their configuration. In addition to the configuration properties listed by
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Attribute's <a href="Attribute.html#method_addAttr">addAttr</a> method, the attribute
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * can also be configured with a "cloneDefaultValue" property, which defines how the statically
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * defined value field should be protected ("shallow", "deep" and false are supported values).
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * By default if the value is an object literal or an array it will be "shallow" cloned, to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * protect the default value.
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @property ATTRS
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Object
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai Base.ATTRS = AttributeCore.prototype._protectAttrs(BaseCore.ATTRS);
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * Internal construction logic for Base.
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * @method _initBase
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * @param {Object} config The constructor configuration object
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai this._eventPrefix = this.constructor.EVENT_PREFIX || this.constructor.NAME;
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai Y.BaseCore.prototype._initBase.call(this, cfg);
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * Initializes Attribute
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * @method _initAttribute
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai this._yuievt.config.prefix = this._eventPrefix;
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * Utility method to define the attribute hash used to filter/whitelist property mixes for
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * this class.
f10b3c93791aa567aa9c97435d49a373447f7279Satyen Desai * @method _attrCfgHash
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Init lifecycle method, invoked during construction.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Fires the init event prior to setting up attributes and
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * invoking initializers for the class hierarchy.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method init
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @chainable
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {Object} config Object with configuration property name/value pairs
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return {Base} A reference to this object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Lifecycle event for the init phase, fired prior to initialization.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Invoking the preventDefault() method on the event object provided
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * to subscribers will prevent initialization from occuring.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Subscribers to the "after" momemt of this event, will be notified
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * after initialization of the object is complete (and therefore
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * cannot prevent initialization).
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @event init
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @preventable _defInitFn
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} e Event object, with a cfg property which
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * refers to the configuration object passed to the constructor.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return this;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Handles the special on, after and target properties which allow the user to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * easily configure on and after listeners as well as bubble targets during
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * construction, prior to init.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _preInitEventCfg
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {Object} config The user configuration object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass userTargets = (config && BUBBLETARGETS in config);
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass target = userTargets ? (config && config.bubbleTargets) : this._bubbleTargets;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass } else if (target) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Destroy lifecycle method. Fires the destroy
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * event, prior to invoking destructors for the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * class hierarchy.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Subscribers to the destroy
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * event can invoke preventDefault on the event object, to prevent destruction
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * from proceeding.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method destroy
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return {Base} A reference to this object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @chainable
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass destroy: function() {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Lifecycle event for the destroy phase,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * fired prior to destruction. Invoking the preventDefault
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * method on the event object provided to subscribers will
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * prevent destruction from proceeding.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Subscribers to the "after" moment of this event, will be notified
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * after destruction is complete (and as a result cannot prevent
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * destruction).
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @event destroy
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @preventable _defDestroyFn
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} e Event object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return this;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Default init event handler
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _defInitFn
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} e Event object, with a cfg property which
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * refers to the configuration object passed to the constructor.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @protected
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass _defInitFn : function(e) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Default destroy event handler
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method _defDestroyFn
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param {EventFacade} e Event object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @protected
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass _defDestroyFn : function(e) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Fix constructor
085a240bf48262201f6e50fc7ce414021168751fSatyen Desai}, '@VERSION@' ,{requires:['base-core', 'attribute-base']});