Provides an API for managing an ordered list of Model instances.
In addition to providing convenient add, create, reset, and remove
methods for managing the models in the list, ModelLists are also bubble targets
for events on the model instances they contain. This means, for example, that
you can add several models to a list, and then subscribe to the *:change event
on the list to be notified whenever any model in the list changes.
ModelLists also maintain sort order efficiently as models are added and removed,
based on a custom comparator function you may define (if no comparator is
defined, models are sorted in insertion order).
_addmodel
[options]
Adds the specified model if it isn't already in this list.
If the model's clientId or id matches that of a model that's already in
the list, an error event will be fired and the model will not be added.
The added model.
_addAttrscfgs
values
lazy
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).
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An object with 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.
lazy
Boolean
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 addAttr.
_addLazyAttrname
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrdername
cfg
Utility method used by get/set to add attributes encountered out of order when calling addAttrs().
For example, if:
this.addAttrs({
foo: {
setter: function() {
// make sure this bar is available when foo is added
this.get("bar");
}
},
bar: {
value: ...
}
});_afterIdChangee
Updates the model maps when a model's id attribute changes.
_aggregateAttrsallAttrs
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).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
The aggregate set of ATTRS definitions for the instance
_attachListmodel
Adds this list as a bubble target for the specified model's events.
model
Model
Model to attach to this list.
_attrCfgHashUtility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroyInternal destroy implementation for BaseCore
_baseInitInternal initialization implementation for BaseCore
_clearClears all internal state and the internal list of models, returning this list to an empty state. Automatically detaches all models in the list.
_cloneDefaultValuecfg
This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.
cfg
Object
_comparea
b
Compares the value a to the value b for sorting purposes. Values are
assumed to be the result of calling a model's comparator() method. You can
override this method to implement custom sorting logic, such as a descending
sort or multi-field sorting.
a
Mixed
First value to compare.
b
Mixed
Second value to compare.
-1 if a should come before b, 0 if they're
equivalent, 1 if a should come after b.
_defAttrChangeFne
eventFastPath
Default function for attribute change events.
e
EventFacade
The event object for attribute change events.
eventFastPath
Boolean
Whether or not we're using this as a fast path in the case of no listeners or not
_defInitFne
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchyDestroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_detachListmodel
Removes this list as a bubble target for the specified model's events.
model
Model
Model to detach.
_filterAdHocAttrsallAttrs
userVals
allAttrs
Object
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.
userVals
Object
The config object passed in by the user, from which adhoc attrs are to be filtered.
The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.
_findIndexmodel
Returns the index at which the given model should be inserted to maintain the sort order of the list.
model
Model
The model being inserted.
Index at which the model should be inserted.
_fireAttrChangeattrName
subAttrName
currVal
newVal
opts
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
attrName
String
The name of the attribute
subAttrName
String
The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
currVal
Any
The current value of the attribute
newVal
Any
The new value of the attribute
opts
Object
Any additional event data to mix into the attribute change event's event facade.
[cfg]
Object
optional
The attribute config stored in State, if already available.
_getAttrname
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
The value of the attribute.
_getAttrCfgname
Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
The configuration properties for the given attribute, or all attributes.
_getAttrCfgsReturns an aggregated set of attribute configurations, by traversing the class hierarchy.
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.
_getAttrInitValattr
cfg
initValues
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.
The initial value of the attribute.
_getAttrsattrs
Implementation behind the public getAttrs method, to get multiple attribute values.
An object with attribute name/value pairs.
_getClassesReturns the class hierarchy for this object, with BaseCore being the last class in the array.
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.
_getFullTypetype
Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.
NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getInstanceAttrCfgsallCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs,
from the static cached ATTRS for the class.
allCfgs
Object
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.
The set of attributes to be added for this instance, suitable
for passing through to addAttrs.
_getStateValname
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
The stored value of the attribute
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_hasPotentialSubscribersfullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_initAttrHostattrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
attrs
Object
The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values
Object
The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initAttributeInitializes AttributeCore
_initAttrsattrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
attrs
Object
The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values
Object
The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initBaseconfig
Internal construction logic for BaseCore.
config
Object
The constructor configuration object
_initHierarchyuserVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyDataA 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.
_isLazyAttrname
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
true if it's a lazily added attribute, false otherwise.
_itemi
Protected method for optimizations that may be appropriate for API
mirroring. Similar in functionality to item, but is used by
methods added with ArrayList.addMethod().
i
Integer
Index of item to fetch
The item appropriate for pass through API methods
_monitorwhat
eventType
o
This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> click_attach, click_detach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.
what
String
'attach', 'detach', 'fire', or 'publish'
eventType
String | CustomEvent
The prefixed name of the event being monitored, or the CustomEvent object.
o
Object
Information about the event interaction, such as fire() args, subscription category, publish config
_normAttrValsvalueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
An 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.
_parseresponse
Calls the public, overrideable parse() method and returns the result.
Override this method to provide a custom pre-parsing implementation. This
provides a hook for custom persistence implementations to "prep" a response
before calling the parse() method.
response
Any
Server response.
Array of model attribute hashes.
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_preInitEventCfgconfig
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.
config
Object
The user configuration object
_protectAttrsattrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
A protected version of the attrs argument.
_publishfullType
etOpts
ceOpts
The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the type to fullType conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_removemodel
[options]
Removes the specified model if it's in this list.
Removed model.
_setname
val
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
A reference to the host object.
_setAttrname
value
[opts]
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
A reference to the host object.
_setAttrsattrs
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
A reference to the host object.
_setAttrValattrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
attrName
String
The attribute name.
subAttrName
String
The sub-attribute name, if setting a sub-attribute property ("x.y.z").
prevVal
Any
The currently stored value of the attribute.
newVal
Any
The value which is going to be stored.
[opts]
Object
optional
Optional data providing the circumstances for the change.
[attrCfg]
Object
optional
Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
true if the new attribute value was stored, false if not.
_setStateValname
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_sorta
b
[options]
Array sort function used by sort() to re-sort the models in the list.
-1 if a is less than b, 0 if equal, 1 if greater
(for ascending order, the reverse for descending order).
addmodels
[options]
Adds the specified model or array of models to this list. You may also pass another ModelList instance, in which case all the models in that list will be added to this one as well.
models
Model | Model[] | ModelList | Object | Object[]
Model or array of models to add. May be existing model instances or hashes of model attributes, in which case new model instances will be created from the hashes. You may also pass a ModelList instance to add all the models it contains.
[options]
Object
optional
Data to be mixed into the event facade of the
add event(s) for the added models.
[index]
Number
optional
Index at which to insert the added
models. If not specified, the models will automatically be inserted
in the appropriate place according to the current sort order as
dictated by the comparator() method, if any.
[silent=false]
Boolean
optional
If true, no add event(s)
will be fired.
// Add a single model instance.
list.add(new Model({foo: 'bar'}));
// Add a single model, creating a new instance automatically.
list.add({foo: 'bar'});
// Add multiple models, creating new instances automatically.
list.add([
{foo: 'bar'},
{baz: 'quux'}
]);
// Add all the models in another ModelList instance.
list.add(otherList);addAttrname
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
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 both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
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 Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
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.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
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.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
name
String
The name of the attribute.
config
Object
An object with attribute configuration property/value pairs, specifying the configuration for the attribute.
NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
lazy
Boolean
(optional) Whether or not to add this attribute lazily (on the first call to get/set).
A reference to the host object.
addAttrscfgs
values
lazy
Configures a group of attributes, and sets initial values.
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An object with 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.
lazy
Boolean
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 addAttr.
A reference to the host object.
addTargeto
Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.
Events can only bubble if emitFacade is true.
Included in the event-custom-complex submodule.
o
EventTarget
the target to add
aftertype
fn
[context]
[arg*]
Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.
A subscription handle capable of detaching the subscription
attrAddedname
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.
beforeExecutes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.
For DOM and custom events: type, callback, context, 0-n arguments
For methods: callback, object (method host), methodName, context, 0-n arguments
detach handle
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
comparatormodel
Define this method to provide a function that takes a model as a parameter and returns a value by which that model should be sorted relative to other models in this list.
By default, no comparator is defined, meaning that models will not be sorted (they'll be stored in the order they're added).
model
Model
Model being sorted.
var list = new Y.ModelList({model: Y.Model});
list.comparator = function (model) {
return model.get('id'); // Sort models by id.
};createmodel
[options]
[callback]
Creates or updates the specified model on the server, then adds it to this list if the server indicates success.
model
Model | Object
Model to create. May be an existing model instance or a hash of model attributes, in which case a new model instance will be created from the hash.
[options]
Object
optional
Options to be passed to the model's sync() and
set() methods and mixed into the create and add event facades.
[silent=false]
Boolean
optional
If true, no add event(s) will
be fired.
[callback]
Function
optional
Called when the sync operation finishes.
err
Error
If an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be falsy.
response
Any
The server's response.
Created model.
destroyDestroy lifecycle method. Invokes destructors for the class hierarchy.
A reference to this object
detachtype
fn
context
Detach one or more listeners the from the specified event
type
String | Object
Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
fn
Function
The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
context
Object
The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
the host
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
eachcallback
[thisObj]
Executes the supplied function on each model in this list.
By default, the callback function's this object will refer to the model
currently being iterated. Specify a thisObj to override the this object
if desired.
Note: Iteration is performed on a copy of the internal array of models, so it's safe to delete a model from the list during iteration.
filter[options]
callback
Executes the supplied function on each model in this list. Returns an array containing the models for which the supplied function returned a truthy value.
The callback function's this object will refer to this ModelList. Use
Y.bind() to bind the this object to another object if desired.
// Get an array containing only the models whose "enabled" attribute is
// truthy.
var filtered = list.filter(function (model) {
return model.get('enabled');
});
// Get a new ModelList containing only the models whose "enabled"
// attribute is truthy.
var filteredList = list.filter({asList: true}, function (model) {
return model.get('enabled');
});firetype
arguments
Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.
The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.
If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.
type
String | Object
The type of the event, or an object that contains a 'type' property.
arguments
Object*
an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
getname
If name refers to an attribute on this ModelList instance, returns the value of that attribute. Otherwise, returns an array containing the values of the specified attribute from each model in this list.
name
String
Attribute name or object property path.
Attribute value or array of attribute values.
getAsHTMLname
If name refers to an attribute on this ModelList instance, returns the HTML-escaped value of that attribute. Otherwise, returns an array containing the HTML-escaped values of the specified attribute from each model in this list.
The values are escaped using Escape.html().
name
String
Attribute name or object property path.
getAsURLname
If name refers to an attribute on this ModelList instance, returns the URL-encoded value of that attribute. Otherwise, returns an array containing the URL-encoded values of the specified attribute from each model in this list.
The values are encoded using the native encodeURIComponent() function.
name
String
Attribute name or object property path.
getAttrsattrs
Gets multiple attribute values.
An object with attribute name/value pairs.
getByClientIdclientId
Returns the model with the specified clientId, or null if not found.
clientId
String
Client id.
Model, or null if not found.
getByIdid
Returns the model with the specified id, or null if not found.
Note that models aren't expected to have an id until they're saved, so if
you're working with unsaved models, it may be safer to call
getByClientId().
Model, or null if not found.
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
getTargetsReturns an array of bubble targets for this object.
EventTarget[]
indexOfneedle
Finds the first index of the needle in the managed array of items.
needle
Mixed
The item to search for
Array index if found. Otherwise -1
initcfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
cfg
Object
Object with configuration property name/value pairs
A reference to this object
invokename
[args*]
Calls the named method on every model in the list. Any arguments provided after name will be passed on to the invoked method.
name
String
Name of the method to call on each model.
[args*]
Any
optional
Zero or more arguments to pass to the invoked method.
Array of return values, indexed according to the index of the model on which the method was called.
isEmptyIs this instance managing any items?
true if 1 or more items are being managed
itemindex
Returns the model at the specified index.
index
Number
Index of the model to fetch.
The model at the specified index, or undefined if there
isn't a model there.
itemsAreEquala
b
Default comparator for items stored in this list. Used by remove().
a
Mixed
item to test equivalence with.
b
Mixed
other item to test equivalance.
true if items are deemed equivalent.
load[options]
[callback]
Loads this list of models from the server.
This method delegates to the sync() method to perform the actual load
operation, which is an asynchronous action. Specify a callback function to
be notified of success or failure.
If the load operation succeeds, a reset event will be fired.
[options]
Object
optional
Options to be passed to sync() and to
reset() when adding the loaded models. It's up to the custom sync
implementation to determine what options it supports or requires, if any.
[callback]
Function
optional
Called when the sync operation finishes.
err
Error
If an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be falsy.
response
Any
The server's response. This value will
be passed to the parse() method, which is expected to parse it and
return an array of model attribute hashes.
mapfn
[thisObj]
Executes the specified function on each model in this list and returns an array of the function's collected return values.
Array of return values from fn.
modifyAttrname
config
Updates the configuration of an attribute which has already been added.
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:
Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).
ontype
fn
[context]
[arg*]
Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.
this.on("change", this._onChange, this);Callback functions for events published with emitFacade = true will
receive an EventFacade as the first argument (typically named "e").
These callbacks can then call e.preventDefault() to disable the
behavior published to that event's defaultFn. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade events will receive the arguments passed to fire()
after the event name.
To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback.
this.on({
"attrChange" : this._onAttrChange,
"change" : this._onChange
});You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback.
this.on([ "change", "attrChange" ], this._onChange);Returning false from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();. However, it is
recommended to use the event methods whenever possible.
A subscription handle capable of detaching that subscription
oncetype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to on except the
listener is immediatelly detached when it is executed.
A subscription handle capable of detaching the subscription
onceAftertype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to after except the
listener is immediatelly detached when it is executed.
A subscription handle capable of detaching that subscription
parseresponse
Called to parse the response when the list is loaded from the server. This method receives a server response and is expected to return an array of model attribute hashes.
The default implementation assumes that response is either an array of
attribute hashes or a JSON string that can be parsed into an array of
attribute hashes. If response is a JSON string and either Y.JSON or the
native JSON object are available, it will be parsed automatically. If a
parse error occurs, an error event will be fired and the model will not be
updated.
You may override this method to implement custom parsing logic if necessary.
response
Any
Server response.
Array of model attribute hashes.
parseTypetype
[pre]
Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.
an array containing:
publishtype
opts
Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
[broadcast=false]
Boolean
optional
whether or not the YUI instance and YUI global are notified when the event is fired.
[bubbles=true]
Boolean
optional
Whether or not this event bubbles. Events can
only bubble if emitFacade is true.
[context=this]
Object
optional
the default execution context for the listeners.
[defaultFn]
Function
optional
the default function to execute when this event fires if preventDefault was not called.
[emitFacade=false]
Boolean
optional
whether or not this event emits a facade.
[prefix]
String
optional
the prefix for this targets events, e.g., 'menu' in 'menu:click'.
[fireOnce=false]
Boolean
optional
if an event is configured to fire once, new subscribers after the fire will be notified immediately.
[async=false]
Boolean
optional
fireOnce event listeners will fire synchronously
if the event has already fired unless async is true.
[preventable=true]
Boolean
optional
whether or not preventDefault() has an effect.
[preventedFn]
Function
optional
a function that is executed when preventDefault() is called.
[queuable=false]
Boolean
optional
whether or not this event can be queued during bubbling.
[silent]
Boolean
optional
if silent is true, debug messages are not provided for this event.
[stoppedFn]
Function
optional
a function that is executed when stopPropagation is called.
[monitored]
Boolean
optional
specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
[type]
String
optional
the event type (valid option if not provided as the first parameter to publish).
the custom event
removemodels
[options]
Removes the specified model or array of models from this list. You may also pass another ModelList instance to remove all the models that are in both that instance and this instance, or pass numerical indices to remove the models at those indices.
removeAttrname
Removes an attribute from the host object
name
String
The name of the attribute to be removed.
reset[models]
[options]
Completely replaces all models in the list with those specified, and fires a
single reset event.
Use reset when you want to add or remove a large number of items at once
with less overhead, and without firing add or remove events for each
one.
[models]
Model[] | ModelList | Object[]
optional
Models to add. May be existing
model instances or hashes of model attributes, in which case new model
instances will be created from the hashes. If a ModelList is passed, all
the models in that list will be added to this list. Calling reset()
without passing in any models will clear the list.
[options]
Object
optional
Data to be mixed into the event facade of the
reset event.
[silent=false]
Boolean
optional
If true, no reset event will
be fired.
setname
value
[opts]
Sets the value of an attribute.
name
String
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. set("x.y.z", 5)).
value
Any
The value to set the attribute to.
[opts]
Object
optional
Optional data providing the circumstances for the change.
A reference to the host object.
setAttrsattrs
[opts]
Sets multiple attribute values.
A reference to the host object.
sizeHow many items are in this list?
Number of items in the list
somecallback
[thisObj]
Executes the supplied function on each model in this list, and stops
iterating if the callback returns true.
By default, the callback function's this object will refer to the model
currently being iterated. Specify a thisObj to override the this object
if desired.
Note: Iteration is performed on a copy of the internal array of models, so it's safe to delete a model from the list during iteration.
true if the callback returned true for any item,
false otherwise.
sort[options]
Forcibly re-sorts the list.
Usually it shouldn't be necessary to call this method since the list
maintains its sort order when items are added and removed, but if you change
the comparator function after items are already in the list, you'll need
to re-sort.
subscribesubscribe to an event
syncaction
[options]
[callback]
Override this method to provide a custom persistence implementation for this list. The default method just calls the callback without actually doing anything.
This method is called internally by load() and its implementations relies
on the callback being called. This effectively means that when a callback is
provided, it must be called at some point for the class to operate correctly.
action
String
Sync action to perform. May be one of the following:
create: Store a list of newly-created models for the first time.delete: Delete a list of existing models.read : Load a list of existing models.update: Update a list of existing models.
Currently, model lists only make use of the read action, but other
actions may be used in future versions.
[options]
Object
optional
Sync options. It's up to the custom sync implementation to determine what options it supports or requires, if any.
[callback]
Function
optional
Called when the sync operation finishes.
err
Error
If an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be falsy.
[response]
Any
optional
The server's response. This value will
be passed to the parse() method, which is expected to parse it and
return an array of model attribute hashes.
toArrayReturns an array containing the models in this list.
Array containing the models in this list.
toJSONReturns an array containing attribute hashes for each model in this list,
suitable for being passed to Y.JSON.stringify().
Under the hood, this method calls toJSON() on each model in the list and
pushes the results into an array.
Array of model attribute hashes.
toStringDefault toString implementation. Provides the constructor NAME and the instance guid, if set.
String representation for this object
unsubscribedetach a listener
unsubscribeAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_allowAdHocAttrsThis property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.
AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass._NON_ATTRS_CFG
Default: undefined (false)
_isYUIModelListTotal hack to allow us to identify ModelList instances without using
instanceof, which won't work when the instance was created in another
window or YUI sandbox.
Default: true
modelThe Model class or subclass of the models in this list.
The class specified here will be used to create model instances
automatically based on attribute hashes passed to the add(), create(),
and reset() methods.
You may specify the class as an actual class reference or as a string that resolves to a class reference at runtime (the latter can be useful if the specified class will be loaded lazily).
Default: Y.Model
destroyedFlag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
destroyedChange
Fires when the value for the configuration attribute destroyed is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
initializedFlag indicating whether or not this object has been through the init lifecycle phase.
Default: false
initializedChange
Fires when the value for the configuration attribute initialized is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
addFired when a model is added to the list.
Listen to the on phase of this event to be notified before a model is
added to the list. Calling e.preventDefault() during the on phase will
prevent the model from being added.
Listen to the after phase of this event to be notified after a model has
been added to the list.
createFired when a model is created or updated via the create() method, but
before the model is actually saved or added to the list. The add event
will be fired after the model has been saved and added to the list.
model
Model
The model being created/updated.
destroyLifecycle 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 destruction).
e
EventFacade
Event object
errorFired when an error occurs, such as when an attempt is made to add a duplicate model to the list, or when a sync layer response can't be parsed.
error
Any
Error message, object, or exception generated by the
error. Calling toString() on this should result in a meaningful error
message.
src
String
Source of the error. May be one of the following (or any custom error source defined by a ModelList subclass):
add: Error while adding a model (probably because it's already in the
list and can't be added again). The model in question will be provided
as the model property on the event facade.parse: An error parsing a JSON response. The response in question will
be provided as the response property on the event facade.remove: Error while removing a model (probably because it isn't in the
list and can't be removed). The model in question will be provided as
the model property on the event facade.initLifecycle 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).
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
loadFired after models are loaded from a sync layer.
parsed
Object
The parsed version of the sync layer's response to the load request.
response
Mixed
The sync layer's raw, unparsed response to the load request.
removeFired when a model is removed from the list.
Listen to the on phase of this event to be notified before a model is
removed from the list. Calling e.preventDefault() during the on phase
will prevent the model from being removed.
Listen to the after phase of this event to be notified after a model has
been removed from the list.
resetFired when the list is completely reset via the reset() method or sorted
via the sort() method.
Listen to the on phase of this event to be notified before the list is
reset. Calling e.preventDefault() during the on phase will prevent
the list from being reset.
Listen to the after phase of this event to be notified after the list has
been reset.