base-base.js revision ed99ee839d187bd8bb990a7f5125d93215c5bb42
325N/A * The base module provides the Base class, which objects requiring attribute and custom event support can extend. 1408N/A * The module also provides two ways to reuse code - It augments Base with the Plugin.Host interface which provides 325N/A * plugin support and also provides the BaseCore.build method which provides a way to build custom classes using extensions. 919N/A * The base-base submodule provides the Base class without the Plugin support, provided by Plugin.Host, 919N/A * and without the extension support provided by BaseCore.build. 919N/A * The base module provides the Base class, which objects requiring attribute and custom event support can extend. 919N/A * The module also provides two ways to reuse code - It augments Base with the Plugin.Host interface which provides 919N/A * plugin support and also provides the Base.build method which provides a way to build custom classes using extensions. 325N/A * The base-base submodule provides the Base class without the Plugin support, provided by Plugin.Host, 493N/A * and without the extension support provided by Base.build. 493N/A * A base class which objects requiring attributes and custom event support can 947N/A * extend. Base also handles the chaining of initializer and destructor methods across 325N/A * the hierarchy as part of object construction and destruction. Additionally, attributes configured 325N/A * through the static <a href="#property_Base.ATTRS">ATTRS</a> property for each class 325N/A * in the hierarchy will be initialized by Base. 1072N/A * The static <a href="#property_Base.NAME">NAME</a> property of each class extending 325N/A * from Base will be used as the identifier for the class, and is used by Base to prefix 920N/A * all events fired by instances of that class. 970N/A * @uses AttributeEvents 325N/A * @uses AttributeExtras * @param {Object} config Object with configuration property name/value pairs. The object can be * used to provide default values for the objects published attributes. * The config object can also contain the following non-attribute properties, providing a convenient * way to configure events listeners and plugins for the instance, as part of the constructor call: * <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> * <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> * <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> * <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> * The list of properties which can be configured for * each attribute (e.g. setter, getter, writeOnce, readOnly etc.) * The array of non-attribute configuration properties supported by this class. * `Base` supports "on", "after", "plugins" and "bubbleTargets" properties, * which are not set up as attributes. * This property is primarily required so that when * <a href="#property__allowAdHocAttrs">`_allowAdHocAttrs`</a> is enabled by * a class, non-attribute configurations don't get added as ad-hoc attributes. * @property _NON_ATTRS_CFG * The string to be used to identify instances of * this class, for example in prefixing events. * Classes extending Base, should define their own * static NAME property, which should be camelCase by * convention (e.g. MyClass.NAME = "myClass";). * 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 * Attribute's <a href="Attribute.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. * Internal construction logic for Base. * @param {Object} config The constructor configuration object * Utility method to define the attribute hash used to filter/whitelist property mixes for * Init lifecycle method, invoked during construction. * Fires the init event prior to setting up attributes and * invoking initializers for the class hierarchy. * @param {Object} config Object with configuration property name/value pairs * @return {Base} A reference to this object * Lifecycle event for the init phase, fired prior to initialization. * Invoking the preventDefault() method on the event object provided * to subscribers will prevent initialization from occuring. * Subscribers to the "after" momemt of this event, will be notified * after initialization of the object is complete (and therefore * cannot prevent initialization). * @preventable _defInitFn * @param {EventFacade} e Event object, with a cfg property which * refers to the configuration object passed to the constructor. * Handles the special on, after and target properties which allow the user to * easily configure on and after listeners as well as bubble targets during * construction, prior to init. * @method _preInitEventCfg * @param {Object} config The user configuration object * Destroy lifecycle method. Fires the destroy * event, prior to invoking destructors for the * Subscribers to the destroy * event can invoke preventDefault on the event object, to prevent destruction * @return {Base} A reference to this object * Lifecycle event for the destroy phase, * fired prior to destruction. Invoking the preventDefault * method on the event object provided to subscribers will * prevent destruction from proceeding. * Subscribers to the "after" moment of this event, will be notified * after destruction is complete (and as a result cannot prevent * @preventable _defDestroyFn * @param {EventFacade} e Event object * Default init event handler * @param {EventFacade} e Event object, with a cfg property which * refers to the configuration object passed to the constructor. * Default destroy event handler * @param {EventFacade} e Event object },
'@VERSION@' ,{
requires:[
'base-core',
'attribute-base']});