eZ.NotificationList Class
The Notification Model List
Constructor
eZ.NotificationList
()
Item Index
Methods
- _add
- _addAttrs
- _addLazyAttr
- _addOutOfOrder
- _afterIdChange
- _aggregateAttrs
- _attachList
- _attrCfgHash
- _baseDestroy
- _baseInit
- _clear
- _cloneDefaultValue
- _compare
- _defAddFn
- _defAttrChangeFn
- _defDestroyFn
- _defInitFn
- _defRemoveFn
- _defResetFn
- _destroyHierarchy
- _detachList
- _filterAdHocAttrs
- _findIndex
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getFullType
- _getInstanceAttrCfgs
- _getStateVal
- _getType
- _hasPotentialSubscribers
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _isLazyAttr
- _item
- _monitor
- _normAttrVals
- _parse
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _remove
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setStateVal
- _sort
- add
- addAttr
- addAttrs
- addTarget
- after
- attrAdded
- before
- bubble
- comparator
- create
- destroy
- detach
- detachAll
- each
- ez-notificationlist
- filter
- fire
- get
- getAsHTML
- getAsURL
- getAttrs
- getByClientId
- getById
- getEvent
- getTargets
- indexOf
- init
- invoke
- isEmpty
- item
- itemsAreEqual deprecated
- load
- map
- modifyAttr
- on
- once
- onceAfter
- parse
- parseType
- publish
- remove
- removeAttr
- removeTarget
- reset
- set
- setAttrs
- size
- some
- sort
- subscribe deprecated
- sync
- toArray
- toJSON
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
- _allowAdHocAttrs
- _isYUIModelList
- model
- name deprecated
Attributes
Methods
_add
-
model
-
[options]
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.
Parameters:
-
model
Model | ObjectModel or object to add. -
[options]
Object optionalData to be mixed into the event facade of theadd
event for the added model.-
[silent=false]
Boolean optionalIf
true
, noadd
event will be fired.
-
Returns:
_addAttrs
-
cfgs
-
values
-
lazy
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn 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
BooleanWhether 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.
_addLazyAttr
-
name
-
[lazyCfg]
Parameters:
-
name
ObjectThe name of the attribute -
[lazyCfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.
_addOutOfOrder
-
name
-
cfg
Parameters:
-
name
Stringattribute name -
cfg
Objectattribute configuration
_afterIdChange
-
e
id
attribute changes.
Parameters:
_aggregateAttrs
-
allAttrs
Parameters:
-
allAttrs
ArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_attachList
-
model
Parameters:
-
model
ModelModel to attach to this list.
_attrCfgHash
()
private
_baseDestroy
()
private
_baseInit
()
private
_clear
()
protected
_cloneDefaultValue
-
cfg
Parameters:
-
cfg
Object
_compare
-
a
-
b
comparator()
method. You can
override this method to implement custom sorting logic, such as a descending
sort or multi-field sorting.
Parameters:
-
a
MixedFirst value to compare. -
b
MixedSecond value to compare.
Returns:
_defAttrChangeFn
-
e
-
eventFastPath
Parameters:
-
e
EventFacadeThe event object for attribute change events. -
eventFastPath
BooleanWhether or not we're using this as a fast path in the case of no listeners or not
_defInitFn
-
e
Parameters:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchy
()
private
_detachList
-
model
Parameters:
-
model
ModelModel to detach.
_filterAdHocAttrs
-
allAttrs
-
userVals
Parameters:
-
allAttrs
ObjectThe 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
ObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_findIndex
-
model
Parameters:
-
model
ModelThe model being inserted.
Returns:
_fireAttrChange
-
attrName
-
subAttrName
-
currVal
-
newVal
-
opts
-
[cfg]
Parameters:
-
attrName
StringThe name of the attribute -
subAttrName
StringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null. -
currVal
AnyThe current value of the attribute -
newVal
AnyThe new value of the attribute -
opts
ObjectAny additional event data to mix into the attribute change event's event facade. -
[cfg]
Object optionalThe attribute config stored in State, if already available.
_getAttr
-
name
Parameters:
-
name
StringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Parameters:
-
name
StringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns:
_getAttrInitVal
-
attr
-
cfg
-
initValues
Parameters:
-
attr
StringThe name of the attribute -
cfg
ObjectThe attribute configuration object -
initValues
ObjectThe object with simple and complex attribute name/value pairs returned from _normAttrVals
Returns:
_getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. 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.
Returns:
_getClasses
()
Function
protected
Returns:
_getFullType
-
type
Parameters:
-
type
StringThe short type to prefix
Returns:
_getInstanceAttrCfgs
-
allCfgs
addAttrs
,
from the static cached ATTRS for the class.
Parameters:
-
allCfgs
ObjectThe 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.
Returns:
addAttrs
.
_getStateVal
-
name
-
[cfg]
Parameters:
-
name
StringThe name of the attribute -
[cfg]
Object optionalOptional 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.
Returns:
_getType
()
private
_hasPotentialSubscribers
-
fullType
Parameters:
-
fullType
StringThe fully prefixed type name
Returns:
_initAttrHost
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe 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
ObjectThe 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
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
_initAttrs
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe 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
ObjectThe 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
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Parameters:
-
config
ObjectThe constructor configuration object
_initHierarchy
-
userVals
Parameters:
-
userVals
ObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
_isLazyAttr
-
name
Parameters:
-
name
StringThe name of the attribute
Returns:
_item
-
i
item
, but is used by
methods added with ArrayList.addMethod()
.
Parameters:
-
i
IntegerIndex of item to fetch
Returns:
_monitor
-
what
-
eventType
-
o
Parameters:
-
what
String'attach', 'detach', 'fire', or 'publish' -
eventType
String | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object. -
o
ObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Parameters:
-
valueHash
ObjectAn object with attribute name/value pairs
Returns:
_parse
-
response
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.
Parameters:
-
response
AnyServer response.
Returns:
_parseType
()
private
_preInitEventCfg
-
config
Parameters:
-
config
ObjectThe user configuration object
_protectAttrs
-
attrs
Parameters:
-
attrs
ObjectA hash of attribute to configuration object pairs.
Returns:
_publish
-
fullType
-
etOpts
-
ceOpts
type
to fullType
conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
Parameters:
-
fullType
StringThe prefixed type of the event to publish. -
etOpts
ObjectThe EventTarget specific configuration to mix into the published event. -
ceOpts
ObjectThe publish specific configuration to mix into the published event.
Returns:
etOpts
or ceOpts
, this will
be the default CustomEvent
instance, and can be configured independently.
_remove
-
model
-
[options]
Parameters:
Returns:
_set
-
name
-
val
-
[opts]
Parameters:
-
name
StringThe name of the attribute. -
val
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
_setAttr
-
name
-
value
-
[opts]
-
force
Parameters:
-
name
StringThe name of the attribute. -
value
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change. -
force
BooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs. -
[opts]
Object optionalOptional data providing the circumstances for the change
Returns:
_setAttrVal
-
attrName
-
subAttrName
-
prevVal
-
newVal
-
[opts]
-
[attrCfg]
Parameters:
-
attrName
StringThe attribute name.
-
subAttrName
StringThe sub-attribute name, if setting a sub-attribute property ("x.y.z").
-
prevVal
AnyThe currently stored value of the attribute.
-
newVal
AnyThe value which is going to be stored.
-
[opts]
Object optionalOptional data providing the circumstances for the change.
-
[attrCfg]
Object optionalOptional 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.
Returns:
true if the new attribute value was stored, false if not.
_setStateVal
-
name
-
value
Parameters:
-
name
StringThe name of the attribute -
value
AnyThe value of the attribute
_sort
-
a
-
b
-
[options]
sort()
to re-sort the models in the list.
Parameters:
Returns:
-1
if _a_ is less than _b_, 0
if equal, 1
if greater
(for ascending order, the reverse for descending order).
add
-
models
-
[options]
Parameters:
-
models
Model | Model[] | ModelList | Object | ObjectModel 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 optionalData to be mixed into the event facade of theadd
event(s) for the added models.-
[index]
Number optionalIndex 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 optionalIf
true
, noadd
event(s) will be fired.
-
Example:
// 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);
addAttr
-
name
-
config
-
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
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.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
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.
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)
- setter <Function | String>
-
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.
- getter <Function | String>
-
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.
- validator <Function | String>
-
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.
- lazyAdd <boolean>
- Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.
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.
Parameters:
-
name
StringThe name of the attribute.
-
config
ObjectAn 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).
Returns:
A reference to the host object.
addAttrs
-
cfgs
-
values
-
lazy
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn 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
BooleanWhether 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.
Returns:
addTarget
-
o
Parameters:
-
o
EventTargetthe target to add
after
-
type
-
fn
-
[context]
-
[arg*]
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
attrAdded
-
name
Parameters:
-
name
StringThe name of the attribute to check.
Returns:
before
()
Returns:
bubble
-
evt
Parameters:
-
evt
CustomEventthe custom event to propagate
Returns:
comparator
-
model
Parameters:
-
model
ModelModel being sorted.
Returns:
Example:
var list = new Y.ModelList({model: Y.Model});
list.comparator = function (model) {
return model.get('id'); // Sort models by id.
};
create
-
model
-
[options]
-
[callback]
Parameters:
-
model
Model | ObjectModel 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 optionalOptions to be passed to the model'ssync()
andset()
methods and mixed into thecreate
andadd
event facades.-
[silent=false]
Boolean optionalIf
true
, noadd
event(s) will be fired.
-
-
[callback]
Function optionalCalled when the sync operation finishes.-
err
ErrorIf an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be falsy.
-
response
AnyThe server's response.
-
Returns:
destroy
()
BaseCore
chainable
Returns:
A reference to this object
detach
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectEither 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
FunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed. -
context
ObjectThe 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)
Returns:
detachAll
-
type
Parameters:
-
type
StringThe type, or name of the event
each
-
callback
-
[thisObj]
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.
ez-notificationlist
()
Provides the notification model list
filter
-
[options]
-
callback
this
object will refer to this ModelList. Use
Y.bind()
to bind the this
object to another object if desired.
Parameters:
-
[options]
Object optionalFilter options.-
[asList=false]
Boolean optionalIf truthy, results will be returned as a new ModelList instance rather than as an array.
-
-
callback
FunctionFunction to execute on each model.
Returns:
Example:
// 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');
});
fire
-
type
-
arguments
Parameters:
-
type
String | ObjectThe type of the event, or an object that contains a 'type' property. -
arguments
Objectan 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.
Returns:
get
-
name
Parameters:
-
name
StringAttribute name or object property path.
Returns:
getAsHTML
-
name
Escape.html()
.
Parameters:
-
name
StringAttribute name or object property path.
Returns:
getAsURL
-
name
encodeURIComponent()
function.
Parameters:
-
name
StringAttribute name or object property path.
Returns:
getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. 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.
Returns:
getByClientId
-
clientId
null
if not found.
Parameters:
-
clientId
StringClient id.
Returns:
null
if not found.
getById
-
id
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()
.
Parameters:
-
id
String | NumberModel id.
Returns:
null
if not found.
getEvent
-
type
-
prefixed
Parameters:
-
type
Stringthe type, or name of the event -
prefixed
Stringif true, the type is prefixed already
Returns:
getTargets
()
Returns:
indexOf
-
needle
Parameters:
-
needle
MixedThe item to search for
Returns:
init
-
cfg
Parameters:
-
cfg
ObjectObject with configuration property name/value pairs
Returns:
invoke
-
name
-
[args*]
Parameters:
-
name
StringName of the method to call on each model. -
[args*]
Any optionalZero or more arguments to pass to the invoked method.
Returns:
isEmpty
()
Boolean
Returns:
item
-
index
Parameters:
-
index
NumberIndex of the model to fetch.
Returns:
undefined
if there
isn't a model there.
itemsAreEqual
-
a
-
b
Parameters:
-
a
Mixeditem to test equivalence with. -
b
Mixedother item to test equivalance.
Returns:
load
-
[options]
-
[callback]
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.
Parameters:
-
[options]
Object optionalOptions to be passed tosync()
and toreset()
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 optionalCalled when the sync operation finishes.-
err
ErrorIf an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be falsy.
-
response
AnyThe 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.
-
map
-
fn
-
[thisObj]
Parameters:
Returns:
modifyAttr
-
name
-
config
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.
Note: New attributes cannot be added using this interface. New attributes must be added using {{#crossLink "AttributeCore/addAttr:method"}}addAttr{{/crossLink}}, or an appropriate manner for a class which utilises Attributes (e.g. the {{#crossLink "Base/ATTRS:property"}}ATTRS{{/crossLink}} property in {{#crossLink "Base"}}Base{{/crossLink}}).
Parameters:
-
name
StringThe name of the attribute whose configuration is to be updated. -
config
ObjectAn object with configuration property/value pairs, specifying the configuration properties to modify.
on
-
type
-
fn
-
[context]
-
[arg*]
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.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
once
-
type
-
fn
-
[context]
-
[arg*]
on
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
onceAfter
-
type
-
fn
-
[context]
-
[arg*]
after
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
parse
-
response
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.
Parameters:
-
response
AnyServer response.
Returns:
parseType
-
type
-
[pre]
Parameters:
-
type
Stringthe type -
[pre]
String optionalThe prefix. Defaults to this._yuievt.config.prefix
Returns:
publish
-
type
-
opts
Parameters:
-
type
Stringthe type, or name of the event -
opts
Objectoptional config params. Valid properties are:-
[broadcast=false]
Boolean optionalwhether or not the YUI instance and YUI global are notified when the event is fired.
-
[bubbles=true]
Boolean optionalWhether or not this event bubbles. Events can only bubble if
emitFacade
is true. -
[context=this]
Object optionalthe default execution context for the listeners.
-
[defaultFn]
Function optionalthe default function to execute when this event fires if preventDefault was not called.
-
[emitFacade=false]
Boolean optionalwhether or not this event emits a facade.
-
[prefix]
String optionalthe prefix for this targets events, e.g., 'menu' in 'menu:click'.
-
[fireOnce=false]
Boolean optionalif an event is configured to fire once, new subscribers after the fire will be notified immediately.
-
[async=false]
Boolean optionalfireOnce event listeners will fire synchronously if the event has already fired unless
async
istrue
. -
[preventable=true]
Boolean optionalwhether or not
preventDefault()
has an effect. -
[preventedFn]
Function optionala function that is executed when
preventDefault()
is called. -
[queuable=false]
Boolean optionalwhether or not this event can be queued during bubbling.
-
[silent]
Boolean optionalif silent is true, debug messages are not provided for this event.
-
[stoppedFn]
Function optionala function that is executed when stopPropagation is called.
-
[monitored]
Boolean optionalspecifies whether or not this event should send notifications about when the event has been attached, detached, or published.
-
[type]
String optionalthe event type (valid option if not provided as the first parameter to publish).
-
Returns:
remove
-
models
-
[options]
Parameters:
removeAttr
-
name
Parameters:
-
name
StringThe name of the attribute to be removed.
reset
-
[models]
-
[options]
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.
Parameters:
-
[models]
Model[] | ModelList | Object optionalModels 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. Callingreset()
without passing in any models will clear the list. -
[options]
Object optionalData to be mixed into the event facade of thereset
event.-
[silent=false]
Boolean optionalIf
true
, noreset
event will be fired.
-
set
-
name
-
value
-
[opts]
Parameters:
-
name
StringThe 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
AnyThe value to set the attribute to.
-
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
A reference to the host object.
setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs.
-
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
A reference to the host object.
size
()
Integer
Returns:
some
-
callback
-
[thisObj]
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.
Parameters:
Returns:
true
if the callback returned true
for any item,
false
otherwise.
sort
-
[options]
comparator
function after items are already in the list, you'll need
to re-sort.
Parameters:
-
[options]
Object optionalData to be mixed into the event facade of thereset
event.-
[silent=false]
Boolean optionalIf
true
, noreset
event will be fired. -
[descending=false]
Boolean optionalIf
true
, the sort is performed in descending order.
-
subscribe
()
deprecated
sync
-
action
-
[options]
-
[callback]
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.
Parameters:
-
action
StringSync 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 theread
action, but other actions may be used in future versions. -
[options]
Object optionalSync options. It's up to the custom sync implementation to determine what options it supports or requires, if any. -
[callback]
Function optionalCalled when the sync operation finishes.-
err
ErrorIf an error occurred, this parameter will contain the error. If the sync operation succeeded, err will be falsy.
-
[response]
Any optionalThe 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.
-
toArray
()
Model[]
Returns:
toJSON
()
Object
Y.JSON.stringify()
.
Under the hood, this method calls toJSON()
on each model in the list and
pushes the results into an array.
Returns:
toString
()
String
Returns:
unsubscribe
()
deprecated
unsubscribeAll
-
type
Parameters:
-
type
StringThe type, or name of the event
Properties
_allowAdHocAttrs
Boolean
protected
Default: undefined (false)
_isYUIModelList
Boolean
protected
instanceof
, which won't work when the instance was created in another
window or YUI sandbox.
Default: true
model
Model | String
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
name
String
deprecated
Attributes
Events
add
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.
create
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.
Event Payload:
-
model
ModelThe model being created/updated.
destroy
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 destruction).
Event Payload:
-
e
EventFacadeEvent object
error
Event Payload:
-
error
AnyError message, object, or exception generated by the error. CallingtoString()
on this should result in a meaningful error message. -
src
StringSource 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 themodel
property on the event facade. *parse
: An error parsing a JSON response. The response in question will be provided as theresponse
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 themodel
property on the event facade.
init
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).
Event Payload:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
load
Event Payload:
-
parsed
ObjectThe parsed version of the sync layer's response to the load request. -
response
MixedThe sync layer's raw, unparsed response to the load request.
remove
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.
reset
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.
Event Payload:
-
models
Model[]Array of the list's new models after the reset. -
src
StringSource of the event. May be either'reset'
or'sort'
.