Attribute.js revision 0ba258e972f368be0d5b6271dc025e0db3b22291
/**
* The attribute module provies an augmentable Attribute implementation, which
* adds configurable attributes and attribute change events to the class being
* augmented. It also provides a State class, which is used internally by Attribute,
* store state.
*
* @module attribute
*/
var O = Y.Object,
EventTarget = Y.EventTarget,
DOT = ".",
CHANGE = "Change",
// Externally configurable props
GETTER = "getter",
SETTER = "setter",
READ_ONLY = "readOnly",
WRITE_ONCE = "writeOnce",
VALIDATOR = "validator",
VALUE = "value",
VALUE_FN = "valueFn",
BROADCAST = "broadcast",
LAZY_ADD = "lazyAdd",
// Used for internal state management
ADDED = "added",
INITIALIZING = "initializing",
INIT_VALUE = "initValue",
PUBLISHED = "published",
DEF_VALUE = "defaultValue",
LAZY = "lazy",
IS_LAZY_ADD = "isLazyAdd",
MODIFIABLE = {};
// Properties which can be changed after the attribute has been added.
/**
* <p>Attribute provides configurable attribute support along with attribute change events.</p>
* <p>
* Attribute is designed to be augmented onto a host class, and provides the host with the
* ability to configure attributes to store and retrieve state, along with attribute change events.
* </p>
* <p>Attributes added to the host can be configured:</p>
* <ul>
* <li>As read only.</li>
* <li>As write once.</li>
* <li>With a setter function, used to manipulate
* values passed to Attribute's set method, before they are stored.</li>
* <li>With a getter function, which can be used to manipulate stored values,
* before they are returned by Attribute's get method.</li>
* <li>With a validator function, to validate values before they are stored.</li>
* </ul>
*
* <p>See the <a href="#method_addAtt">addAttr</a> method, for the complete set of configuration
* options available for attributes</p>.
*
* <p><strong>NOTE:</strong> Most implementations will be better off extending the <a href="Base.html">Base</a> class,
* instead of augmenting Attribute directly. Base augments Attribute and will handle the initial configuration
* of attributes for derived classes, accounting for values passed into the constructor.</p>
*
* @class Attribute
* @uses Event.Target
*/
function Attribute() {
// Perf tweak - avoid creating event literals if not required.
this._ATTR_E_FACADE = {};
}
/**
* <p>The value to return from an attribute setter in order to prevent the set from going through.</p>
*
* <p>You can return this value from your setter, if you wish to combine validation and setter
* functionality into a single setter function, which either returns the massaged value to be stored or
* Attribute.INVALID_VALUE to prevent invalid values from being stored.</p>
*
* @property Attribute.INVALID_VALUE
* @type Object
* @static
* @final
*/
Attribute.INVALID_VALUE = {};
/**
* The list of properties which can be configured for
* each attribute (e.g. setter, getter, writeOnce etc.).
*
* This property is used internally as a whitelist for faster
* Y.mix operations.
*
* @property Attribute._ATTR_CFG
* @type Array
* @static
* @protected
*/
Attribute._ATTR_CFG = [SETTER, GETTER, VALIDATOR, VALUE, VALUE_FN, WRITE_ONCE, READ_ONLY, LAZY_ADD, BROADCAST];
/**
* <p>
* Adds an attribute with the provided configuration to the host object.
* </p>
* <p>
* The config argument object literal supports the following optional properties:
* </p>
* <dl>
* <dt>value <Any></dt>
* <dd>The initial value to set on the attribute</dd>
* <dt>valueFn <Function></dt>
* <dd>A function, which will return the initial value to set on the attribute. This is useful
* for cases where the attribute configuration is defined statically, but needs to
* reference the host instance ("this") to obtain an initial value.
* If defined, this precedence over the value property.</dd>
* <dt>readOnly <Boolean></dt>
* <dd>Whether or not the attribute is read only. Attributes having readOnly set to true
* cannot be modified by invoking the set method.</dd>
* <dt>writeOnce <Boolean></dt>
* <dd>Whether or not the attribute is "write once". Attributes having writeOnce set to true,
* can only have their values set once, be it through the default configuration,
* constructor configuration arguments, or by invoking set.</dd>
* <dt>setter <Function></dt>
* <dd>The setter function used to massage or normalize the value passed to the set method for the attribute.
* The value returned by the setter will be the final stored value. Returning
* <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent
* the value from being stored.</dd>
* <dt>getter <Function></dt>
* <dd>The getter function used to massage or normalize the value returned by the get method for the attribute.
* The value returned by the getter function is the value which will be returned to the user when they
* invoke get.</dd>
* <dt>validator <Function></dt>
* <dd>The validator function invoked prior to setting the stored value. Returning
* false from the validator function will prevent the value from being stored.</dd>
* <dt>broadcast <Int></dt>
* <dd>If and how attribute change events for this attribute should be broadcast. See Event.Custom's <a href="Event.Custom.html#property_broadcast>broadcast</a> property for
* valid values. By default attribute change events are not broadcast.</dd>
* <dt>lazyAdd <boolean></dt>
* This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through
* the <a href="#method_addAttrs">addAttrs</a> method.</dd>
* </dl>
*
* <p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with
* the context ("this") set to the host object.</p>
*
* @method addAttr
*
* @param {String} name The name of the attribute.
* @param {Object} config An object literal specifying the configuration for the attribute.
* @param {boolean} lazy (optional) Whether or not to add this attribute lazily (on the first call to get/set).
*
* <strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need
* to protect the original values, you will need to merge or clone the object.
*
* @return {Object} A reference to the host object.
*
* @chainable
*/
} else {
if (this.attrAdded(name) && !conf.get(name, IS_LAZY_ADD)) { Y.log('Attribute: ' + name + ' already exists. Cannot add it again without removing it first', 'warn', 'attribute'); }
if (config.readOnly && !hasValue) { Y.log('readOnly attribute: ' + name + ', added without an initial value. Value will be set on initial call to set', 'warn', 'attribute');}
if(hasValue) {
// We'll go through set, don't want to set value in _conf directory
}
config.initializing = true;
if (hasValue) {
// Go through set, so that raw values get normalized/validated
}
}
}
return this;
},
/**
* Checks if the given attribute has been added to the host
*
* @method attrAdded
* @param {String} name The name of the attribute to check.
* @return {boolean}, true if an attribute with the given name has been added.
*/
},
/**
* Updates the configuration of an attribute which has already been added.
* <p>
* The properties which can be modified through this interface are limited
* to the following subset of attributes, which can be safely modified
* after a value has already been set on the attribute: readOnly, writeOnce,
* broadcast and getter.
* </p>
* @method modifyAttr
* @param {String} name The name of the attribute whose configuration is to be updated.
* @param {Object} config An object literal with the updated configuration properties.
*/
if (this._isLazyAttr(name)) {
this._addLazyAttr(name);
}
// If we reconfigured broadcast, need to republish
}
}
}
}
if (!this.attrAdded(name)) {Y.log('Attribute modifyAttr:' + name + ' has not been added. Use addAttr to add the attribute', 'warn', 'attribute');}
},
/**
* Removes an attribute from the host object
*
* @method removeAttr
* @param {String} name The name of the attribute to be removed.
*/
removeAttr: function(name) {
},
/**
* Returns the current value of the attribute. If the attribute
* has been configured with a 'getter' function, this method will delegate
* to the 'getter' to obtain the value of the attribute.
*
* @method get
*
* @param {String} name The name of the attribute. If the value of the attribute is an Object,
* dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)
*
* @return {Any} The value of the attribute
*/
path,
val;
}
// On Demand - Should be rare - handles out of order valueFn references
var cfg = {};
}
// Lazy Init
if (this._isLazyAttr(name)) {
this._addLazyAttr(name);
}
return val;
},
/**
* Checks whether or not the attribute is one which has been
* added lazily and still requires initialization.
*
* @method _isLazyAttr
* @private
* @param {String} name The name of the attribute
* @return {boolean} true if it's a lazily added attribute, false otherwise.
*/
_isLazyAttr: function(name) {
},
/**
* Finishes initializing an attribute which has been lazily added.
*
* @method _addLazyAttr
* @private
* @param {Object} name The name of the attribute
*/
_addLazyAttr: function(name) {
},
/**
* Sets the value of an attribute.
*
* @method set
* @chainable
*
* @param {String} name The name of the attribute. If the
* current value of the attribute is an Object, dot notation can be used
* to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).
*
* @param {Any} value The value to set the attribute to.
*
* @param {Object} opts (Optional) Optional event data to be mixed into
* the event facade passed to subscribers of the attribute's change event. This
* can be used as a flexible way to identify the source of a call to set, allowing
* the developer to distinguish between set called internally by the host, vs.
* set called externally by the application developer.
*
* @return {Object} A reference to the host object
*/
},
/**
* Resets the attribute (or all attributes) to its initial value, as long as
* the attribute is not readOnly, or writeOnce.
*
* @method reset
* @param {String} name Optional. The name of the attribute to reset. If omitted, all attributes are reset.
* @return A reference to the host object.
* @chainable
*/
if (name) {
if (this._isLazyAttr(name)) {
this._addLazyAttr(name);
}
} else {
this.reset(n);
}, this);
}
return this;
},
/**
* Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.
*
* @method _set
* @protected
* @chainable
*
* @param {String} name The name of the attribute.
* @param {Any} val The value to set the attribute to.
* @param {Object} opts (Optional) Optional event data to be mixed into
* the event facade passed to subscribers of the attribute's change event.
* @return {Object} A reference to the host object
*/
},
/**
* Provides the common implementation for the public set and protected _set methods.
*
* See <a href="#method_set">set</a> for argument details.
*
* @method _setAttr
* @protected
* @chainable
*
* @param {String} name The name of the attribute.
* @param {Any} value The value to set the attribute to.
* @param {Object} opts (Optional) Optional event data to be mixed into
* the event facade passed to subscribers of the attribute's change event.
* @param {boolean} force If true, allows the caller to set values for
* readOnly or writeOnce attributes which have already been set.
*
* @return {Object} A reference to the host object
*/
var allowSet = true,
path,
}
if (this._isLazyAttr(name)) {
this._addLazyAttr(name);
}
} else {
if (!initialSet && !force) {
allowSet = false;
}
allowSet = false;
}
}
if (allowSet) {
if (path) {
allowSet = false;
}
}
if (allowSet) {
} else {
}
}
}
}
return this;
},
/**
* Utility method to help setup the event payload and fire the attribute change event.
*
* @method _fireAttrChange
* @private
* @param {String} attrName The name of the attribute
* @param {String} subAttrName The full path of the property being changed,
* if this is a sub-attribute value being change. Otherwise null.
* @param {Any} currVal The current value of the attribute
* @param {Any} newVal The new value of the attribute
* @param {Object} opts Any additional event data to mix into the attribute change event's event facade.
*/
queuable:false,
defaultFn:this._defAttrChangeFn,
silent:true,
});
}
},
/**
* Default function for attribute change events.
*
* @private
* @method _defAttrChangeFn
* @param {Event.Facade} e The event object for attribute change events.
*/
_defAttrChangeFn : function(e) {
Y.log('State not updated and stopImmediatePropagation called for attribute: ' + e.attrName + ' , value:' + e.newVal, 'warn', 'attribute');
// Prevent "after" listeners from being invoked since nothing changed.
} else {
}
},
/**
* Updates the stored value of the attribute in the privately held State object,
* if validation and setter passes.
*
* @method _setAttrVal
* @private
* @param {String} attrName The attribute name.
* @param {String} subAttrName The sub-attribute name, if setting a sub-attribute property ("x.y.z").
* @param {Any} prevVal The currently stored value of the attribute.
* @param {Any} newVal The value which is going to be stored.
*
* @return {booolean} true if the new attribute value was stored, false if not.
*/
var allowSet = true,
if (validator) {
if (!valid && initializing) {
valid = true; // Assume it's valid, for perf.
}
}
if (setter) {
if (retVal === INVALID_VALUE) {
Y.log('Attribute: ' + attrName + ', setter returned Attribute.INVALID_VALUE for value:' + newVal, 'warn', 'attribute');
allowSet = false;
Y.log('Attribute: ' + attrName + ', raw value: ' + newVal + ' modified by setter to:' + retVal, 'info', 'attribute');
}
}
if (allowSet) {
allowSet = false;
} else {
// Store value
}
}
}
} else {
allowSet = false;
}
return allowSet;
},
/**
* Sets multiple attribute values.
*
* @method setAttrs
* @return A reference to the host object.
* @chainable
*/
}
}
return this;
},
/**
* Gets multiple attribute values.
*
* @method getAttrs
* @param {Array | Boolean} attrs Optional. An array of attribute names. If omitted, all attribute values are
* returned. If set to true, all attributes modified from their initial values are returned.
*/
modifiedOnly = (attrs === true);
// Go through get, to honor cloning/normalization
}
}
return o;
},
/**
* Configures a group of attributes, and sets initial values.
*
*
* @method addAttrs
* @chainable
*
* @param {Object} cfgs An object literal of attribute name/configuration pairs.
* @param {Object} values An object literal of attribute name/value pairs, defining the initial values to apply.
* Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
* @param {boolean} lazy Whether or not to delay the intialization of these attributes until the first call to get/set.
* Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
* See <a href="#method_addAttr">addAttr</a>.
*/
if (cfgs) {
}
return this;
},
/**
* Implementation behind the public addAttrs method.
*
* This method is invoked directly by get if it encounters a scenario
* in which an attribute's valueFn attempts to obtain the
* value an attribute in the same group of attributes, which has not yet
* been added (on demand initialization).
*
* @method _addAttrs
* @private
* @param {Object} cfgs An object literal of attribute name/configuration pairs.
* @param {Object} values An object literal of attribute name/value pairs, defining the initial values to apply.
* Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
* @param {boolean} lazy Whether or not to delay the intialization of these attributes until the first call to get/set.
* Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
* See <a href="#method_addAttr">addAttr</a>.
*/
var attr,
// Not Merging. Caller is responsible for isolating configs
// Handle simple, complex and user values, accounting for read-only
}
}
}
}
},
/**
* attributes can be keyed by the top level attribute name.
*
* @method _splitAttrVals
*
* @return {Object} Object literal with 2 properties - "simple" and "complex",
* containing simple and complex attribute values respectively keyed
* by the top level attribute name, or null, if valueHash is falsey.
*
* @private
*/
_splitAttrVals : function(valueHash) {
var vals = {},
subvals = {},
path,
attr,
v, k;
if (valueHash) {
for (k in valueHash) {
if (valueHash.hasOwnProperty(k)) {
v[v.length] = {
};
} else {
}
}
}
} else {
return null;
}
},
/**
* Returns the initial value of the given attribute from
* either the default configuration provided, or the
* over-ridden value if it exists in the set of initValues
* provided and the attribute is not read-only.
*
* @param {String} attr The name of the attribute
* @param {Object} cfg The attribute configuration object literal
* from _splitAttrVals
*
* @return {Any} The initial value of the attribute.
*
* @method _getAttrInitVal
* @private
*/
i,
l,
path,
// Simple Attributes
}
// Complex Attributes (complex values applied, after simple, incase both are set)
}
}
}
return val;
}
};
// Basic prototype augment - no lazy constructor invocation.