API Docs for: 1.0.0
Show:

eZ.NotificationList Class

Extends ModelList
Defined in: Resources/public/js/models/structs/ez-notificationlist.js:13
Module: ez-contenttree

The Notification Model List

Constructor

Methods

_add

(
  • model
  • [options]
)
Model protected

Inherited from ModelList: app/js/model-list.js:917

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.

Parameters:

  • model Model | Object
    Model or object to add.
  • [options] Object optional
    Data to be mixed into the event facade of the add event for the added model.
    • [silent=false] Boolean optional

      If true, no add event will be fired.

Returns:

Model: The added model.

_addAttrs

(
  • cfgs
  • values
  • lazy
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:854

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).

Parameters:

  • 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.

_addLazyAttr

(
  • name
  • [lazyCfg]
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:360

Finishes initializing an attribute which has been lazily added.

Parameters:

  • name Object
    The name of the attribute
  • [lazyCfg] Object optional
    Optional 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
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:527

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: ... } });

Parameters:

  • name String
    attribute name
  • cfg Object
    attribute configuration

_afterIdChange

(
  • e
)
protected

Inherited from ModelList: app/js/model-list.js:1162

Updates the model maps when a model's id attribute changes.

Parameters:

_aggregateAttrs

(
  • allAttrs
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:618

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).

Parameters:

  • allAttrs Array
    An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object: The aggregate set of ATTRS definitions for the instance

_attachList

(
  • model
)
protected

Inherited from ModelList: app/js/model-list.js:969

Adds this list as a bubble target for the specified model's events.

Parameters:

  • model Model
    Model to attach to this list.

_attrCfgHash

() private

Inherited from BaseCore: base/js/BaseCore.js:581

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

_baseDestroy

() private

Inherited from BaseCore: base/js/BaseCore.js:364

Internal destroy implementation for BaseCore

_baseInit

() private

Inherited from BaseCore: base/js/BaseCore.js:336

Internal initialization implementation for BaseCore

_clear

() protected

Inherited from ModelList: app/js/model-list.js:982

Clears all internal state and the internal list of models, returning this list to an empty state. Automatically detaches all models in the list.

_cloneDefaultValue

(
  • cfg
)
private

Inherited from BaseCore: base/js/BaseCore.js:592

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.

Parameters:

  • cfg Object

_compare

(
  • a
  • b
)
Number protected

Inherited from ModelList: app/js/model-list.js:997

Available since 3.5.0

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.

Parameters:

  • a Mixed
    First value to compare.
  • b Mixed
    Second value to compare.

Returns:

Number: -1 if _a_ should come before _b_, 0 if they're equivalent, 1 if _a_ should come after _b_.

_defAddFn

(
  • e
)
protected

Inherited from ModelList: app/js/model-list.js:1197

Default event handler for add events.

Parameters:

_defAttrChangeFn

(
  • e
  • eventFastPath
)
private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:185

Default function for attribute change events.

Parameters:

  • 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

_defDestroyFn

(
  • e
)
protected

Inherited from BaseObservable: base/js/BaseObservable.js:202

Default destroy event handler

Parameters:

_defInitFn

(
  • e
)
protected

Inherited from BaseObservable: base/js/BaseObservable.js:190

Default init event handler

Parameters:

  • e EventFacade
    Event object, with a cfg property which refers to the configuration object passed to the constructor.

_defRemoveFn

(
  • e
)
protected

Inherited from ModelList: app/js/model-list.js:1218

Default event handler for remove events.

Parameters:

_defResetFn

(
  • e
)
protected

Inherited from ModelList: app/js/model-list.js:1239

Default event handler for reset events.

Parameters:

_destroyHierarchy

() private

Inherited from BaseCore: base/js/BaseCore.js:782

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

_detachList

(
  • model
)
protected

Inherited from ModelList: app/js/model-list.js:1015

Removes this list as a bubble target for the specified model's events.

Parameters:

  • model Model
    Model to detach.

_filterAdHocAttrs

(
  • allAttrs
  • userVals
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:470

Parameters:

  • 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.

Returns:

Object: The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

_findIndex

(
  • model
)
Number protected

Inherited from ModelList: app/js/model-list.js:1031

Returns the index at which the given _model_ should be inserted to maintain the sort order of the list.

Parameters:

  • model Model
    The model being inserted.

Returns:

Number: Index at which the model should be inserted.

_fireAttrChange

(
  • attrName
  • subAttrName
  • currVal
  • newVal
  • opts
  • [cfg]
)
private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:120

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

  • 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.

_getAttr

(
  • name
)
Any protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:564

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method. See get for argument details.

Parameters:

  • name String
    The name of the attribute.

Returns:

Any: The value of the attribute.

_getAttrCfg

(
  • name
)
Object protected

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:125

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.

Parameters:

  • name String
    Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object: The configuration properties for the given attribute, or all attributes.

_getAttrCfgs

() Object protected

Inherited from BaseCore: base/js/BaseCore.js:394

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object: 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.

_getAttrInitVal

(
  • attr
  • cfg
  • initValues
)
Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:963

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.

Parameters:

  • attr String
    The name of the attribute
  • cfg Object
    The attribute configuration object
  • initValues Object
    The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any: The initial value of the attribute.

_getAttrs

(
  • attrs
)
Object protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:792

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

  • attrs String | Boolean
    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.

Returns:

Object: An object with attribute name/value pairs.

_getClasses

() Function protected

Inherited from BaseCore: base/js/BaseCore.js:378

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function: 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.

_getFullType

(
  • type
)
String private

Inherited from EventTarget: event-custom/js/event-target.js:564

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.

Parameters:

  • type String
    The short type to prefix

Returns:

String: The prefixed type, if a prefix is set, otherwise the type passed in

_getInstanceAttrCfgs

(
  • allCfgs
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:411

A helper method used to isolate the attrs config for this instance to pass to addAttrs, from the static cached ATTRS for the class.

Parameters:

  • 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.

Returns:

Object: The set of attributes to be added for this instance, suitable for passing through to addAttrs.

_getStateVal

(
  • name
  • [cfg]
)
Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:618

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

  • name String
    The name of the attribute
  • [cfg] 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.

Returns:

Any: The stored value of the attribute

_getType

() private

Inherited from EventTarget: event-custom/js/event-target.js:36

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

_hasPotentialSubscribers

(
  • fullType
)
Boolean private

Inherited from EventTarget: event-custom/js/event-facade.js:643

Parameters:

  • fullType String
    The fully prefixed type name

Returns:

Boolean: Whether the event has potential subscribers or not

_initAttrHost

(
  • attrs
  • values
  • lazy
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:140

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

  • 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).

_initAttribute

() private

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:309

Initializes AttributeCore

_initAttrs

(
  • attrs
  • values
  • lazy
)
protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:1029

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

  • 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).

_initBase

(
  • config
)
private

Inherited from BaseCore: base/js/BaseCore.js:274

Internal construction logic for BaseCore.

Parameters:

  • config Object
    The constructor configuration object

_initHierarchy

(
  • userVals
)
private

Inherited from BaseCore: base/js/BaseCore.js:702

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.

Parameters:

  • userVals Object
    Object with configuration property name/value pairs

_initHierarchyData

() private

Inherited from BaseCore: base/js/BaseCore.js:500

A 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.

_isLazyAttr

(
  • name
)
Boolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:347

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

  • name String
    The name of the attribute

Returns:

Boolean: true if it's a lazily added attribute, false otherwise.

_item

(
  • i
)
Mixed protected

Inherited from ArrayList: collection/js/arraylist.js:138

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().

Parameters:

  • i Integer
    Index of item to fetch

Returns:

Mixed: The item appropriate for pass through API methods

_monitor

(
  • what
  • eventType
  • o
)
private

Inherited from EventTarget: event-custom/js/event-target.js:636

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.

Parameters:

  • 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

_normAttrVals

(
  • valueHash
)
Object private

Inherited from AttributeCore: attribute/js/AttributeCore.js:915

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

  • valueHash Object
    An object with attribute name/value pairs

Returns:

Object: 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.

_parse

(
  • response
)
Object protected

Inherited from ModelList: app/js/model-list.js:1068

Available since 3.7.0

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.

Parameters:

  • response Any
    Server response.

Returns:

Object: Array of model attribute hashes.

_parseType

() private

Inherited from EventTarget: event-custom/js/event-target.js:52

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

_preInitEventCfg

(
  • config
)
private

Inherited from BaseObservable: base/js/BaseObservable.js:110

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.

Parameters:

  • config Object
    The user configuration object

_protectAttrs

(
  • attrs
)
Object deprecated protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:901

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

  • attrs Object
    A hash of attribute to configuration object pairs.

Returns:

Object: A protected version of the attrs argument.

_publish

(
  • fullType
  • etOpts
  • ceOpts
)
CustomEvent private

Inherited from EventTarget: event-custom/js/event-target.js:588

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.

Parameters:

  • fullType String
    The prefixed type of the event to publish.
  • etOpts Object
    The EventTarget specific configuration to mix into the published event.
  • ceOpts Object
    The publish specific configuration to mix into the published event.

Returns:

CustomEvent: The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

_remove

(
  • model
  • [options]
)
Model protected

Inherited from ModelList: app/js/model-list.js:1086

Removes the specified _model_ if it's in this list.

Parameters:

  • model Model | Number
    Model or index of the model to remove.
  • [options] Object optional
    Data to be mixed into the event facade of the remove event for the removed model.
    • [silent=false] Boolean optional

      If true, no remove event will be fired.

Returns:

Model: Removed model.

_set

(
  • name
  • val
  • [opts]
)
Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:405

Allows setting of readOnly/writeOnce attributes. See set for argument details.

Parameters:

  • name String
    The name of the attribute.
  • val Any
    The value to set the attribute to.
  • [opts] Object optional
    Optional data providing the circumstances for the change.

Returns:

Object: A reference to the host object.

_setAttr

(
  • name
  • value
  • [opts]
  • force
)
Object protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:421

Provides the common implementation for the public set and protected _set methods. See set for argument details.

Parameters:

  • name String
    The name of the attribute.
  • value Any
    The value to set the attribute to.
  • [opts] Object optional
    Optional data providing the circumstances for the change.
  • force Boolean
    If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object: A reference to the host object.

_setAttrs

(
  • attrs
  • [opts]
)
Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:760

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

  • attrs Object
    An object with attributes name/value pairs.
  • [opts] Object optional
    Optional data providing the circumstances for the change

Returns:

Object: A reference to the host object.

_setAttrVal

(
  • attrName
  • subAttrName
  • prevVal
  • newVal
  • [opts]
  • [attrCfg]
)
Boolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:658

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

  • 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.

Returns:

Boolean:

true if the new attribute value was stored, false if not.

_setStateVal

(
  • name
  • value
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:640

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

  • name String
    The name of the attribute
  • value Any
    The value of the attribute

_sort

(
  • a
  • b
  • [options]
)
Number protected

Inherited from ModelList: app/js/model-list.js:1135

Array sort function used by sort() to re-sort the models in the list.

Parameters:

  • a Model
    First model to compare.
  • b Model
    Second model to compare.
  • [options] Object optional
    Options passed from sort() function.
    • [descending=false] Boolean optional

      If true, the sort is performed in descending order.

Returns:

Number: -1 if _a_ is less than _b_, 0 if equal, 1 if greater (for ascending order, the reverse for descending order).

add

(
  • models
  • [options]
)
Model | Model[]

Inherited from ArrayList but overwritten in app/js/model-list.js:208

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.

Parameters:

  • 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.

Returns:

Model | Model[]: Added model or array of added models.

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
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:157

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 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).

Returns:

Object:

A reference to the host object.

addAttrs

(
  • cfgs
  • values
  • lazy
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:823

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.

Parameters:

  • 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.

Returns:

Object: A reference to the host object.

addTarget

(
  • o
)
chainable

Inherited from EventTarget: event-custom/js/event-facade.js:496

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.

Parameters:

after

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:812

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.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

attrAdded

(
  • name
)
Boolean

Inherited from AttributeCore: attribute/js/AttributeCore.js:319

Checks if the given attribute has been added to the host

Parameters:

  • name String
    The name of the attribute to check.

Returns:

Boolean: 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.

before

()

Inherited from EventTarget: event-custom/js/event-target.js:849

Executes 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

Returns:

detach handle

bubble

(
  • evt
)
Boolean

Inherited from EventTarget: event-custom/js/event-facade.js:554

Propagate an event. Requires the event-custom-complex module.

Parameters:

Returns:

Boolean: the aggregated return value from Event.Custom.fire

comparator

(
  • model
)
Number | String

Inherited from ModelList: app/js/model-list.js:271

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).

Parameters:

  • model Model
    Model being sorted.

Returns:

Number | String: Value by which the model should be sorted relative to other models in this list.

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]
)
Model

Inherited from ModelList: app/js/model-list.js:294

Creates or updates the specified model on the server, then adds it to this list if the server indicates success.

Parameters:

  • 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.

Returns:

Model: Created model.

destroy

() BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:352

Destroy lifecycle method. Invokes destructors for the class hierarchy.

Returns:

BaseCore:

A reference to this object

detach

(
  • type
  • fn
  • context
)
EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:356

Detach one or more listeners the from the specified event

Parameters:

  • 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)

Returns:

EventTarget: the host

detachAll

(
  • type
)

Inherited from EventTarget: event-custom/js/event-target.js:479

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String
    The type, or name of the event

each

(
  • callback
  • [thisObj]
)
chainable

Inherited from ArrayList but overwritten in app/js/model-list.js:343

Available since 3.6.0

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.

Parameters:

  • callback Function
    Function to execute on each model.
    • model Model

      Model instance.

    • index Number

      Index of the current model.

    • list ModelList

      The ModelList being iterated.

  • [thisObj] Object optional
    Object to use as the this object when executing the callback.

ez-notificationlist

()

Defined in Resources/public/js/models/structs/ez-notificationlist.js:7

Provides the notification model list

filter

(
  • [options]
  • callback
)
Model[] | ModelList

Inherited from ArrayList but overwritten in app/js/model-list.js:375

Available since 3.5.0

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.

Parameters:

  • [options] Object optional
    Filter options.
    • [asList=false] Boolean optional

      If truthy, results will be returned as a new ModelList instance rather than as an array.

  • callback Function
    Function to execute on each model.
    • model Model

      Model instance.

    • index Number

      Index of the current model.

    • list ModelList

      The ModelList being filtered.

Returns:

Model[] | ModelList: Array of models for which the callback function returned a truthy value (empty if it never returned a truthy value). If the options.asList option is truthy, a new ModelList instance will be returned instead of an array.

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
)
Boolean

Inherited from EventTarget: event-custom/js/event-target.js:673

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.

Parameters:

  • 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.

Returns:

Boolean: True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

get

(
  • name
)
Any | Any

Inherited from AttributeCore but overwritten in app/js/model-list.js:445

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.

Parameters:

  • name String
    Attribute name or object property path.

Returns:

Any | Any: Attribute value or array of attribute values.

getAsHTML

(
  • name
)
String | String

Inherited from ModelList: app/js/model-list.js:463

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().

Parameters:

  • name String
    Attribute name or object property path.

Returns:

String | String: HTML-escaped value or array of HTML-escaped values.

getAsURL

(
  • name
)
String | String

Inherited from ModelList: app/js/model-list.js:485

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.

Parameters:

  • name String
    Attribute name or object property path.

Returns:

String | String: URL-encoded value or array of URL-encoded values.

getAttrs

(
  • attrs
)
Object

Inherited from AttributeCore: attribute/js/AttributeCore.js:780

Gets multiple attribute values.

Parameters:

  • attrs String | Boolean
    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.

Returns:

Object: An object with attribute name/value pairs.

getByClientId

(
  • clientId
)
Model

Inherited from ModelList: app/js/model-list.js:506

Returns the model with the specified _clientId_, or null if not found.

Parameters:

  • clientId String
    Client id.

Returns:

Model: Model, or null if not found.

getById

(
  • id
)
Model

Inherited from ModelList: app/js/model-list.js:517

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().

Parameters:

  • id String | Number
    Model id.

Returns:

Model: Model, or null if not found.

getEvent

(
  • type
  • prefixed
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:793

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

  • type String
    the type, or name of the event
  • prefixed String
    if true, the type is prefixed already

Returns:

CustomEvent: the custom event or null

getTargets

()

Inherited from EventTarget: event-custom/js/event-facade.js:523

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

indexOf

(
  • needle
)
Integer

Inherited from ArrayList: collection/js/arraylist.js:95

Finds the first index of the needle in the managed array of items.

Parameters:

  • needle Mixed
    The item to search for

Returns:

Integer: Array index if found. Otherwise -1

init

(
  • cfg
)
BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:319

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

  • cfg Object
    Object with configuration property name/value pairs

Returns:

BaseCore: A reference to this object

invoke

(
  • name
  • [args*]
)
Any

Inherited from ModelList: app/js/model-list.js:532

Calls the named method on every model in the list. Any arguments provided after _name_ will be passed on to the invoked method.

Parameters:

  • name String
    Name of the method to call on each model.
  • [args*] Any optional
    Zero or more arguments to pass to the invoked method.

Returns:

Any: Array of return values, indexed according to the index of the model on which the method was called.

isEmpty

() Boolean

Inherited from ArrayList: collection/js/arraylist.js:116

Is this instance managing any items?

Returns:

Boolean: true if 1 or more items are being managed

item

(
  • index
)
Model

Inherited from ArrayList but overwritten in app/js/model-list.js:547

Returns the model at the specified _index_.

Parameters:

  • index Number
    Index of the model to fetch.

Returns:

Model: The model at the specified index, or undefined if there isn't a model there.

itemsAreEqual

(
  • a
  • b
)
Boolean deprecated

Inherited from ArrayList: collection/js/arraylist-add.js:68

Deprecated: Use ModelList or a custom ArrayList subclass

Default comparator for items stored in this list. Used by remove().

Parameters:

  • a Mixed
    item to test equivalence with.
  • b Mixed
    other item to test equivalance.

Returns:

Boolean: true if items are deemed equivalent.

load

(
  • [options]
  • [callback]
)
chainable

Inherited from ModelList: app/js/model-list.js:558

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.

Parameters:

  • [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.

map

(
  • fn
  • [thisObj]
)
Array

Inherited from ModelList: app/js/model-list.js:626

Executes the specified function on each model in this list and returns an array of the function's collected return values.

Parameters:

  • fn Function
    Function to execute on each model.
    • model Model

      Current model being iterated.

    • index Number

      Index of the current model in the list.

    • models Model[]

      Array of models being iterated.

  • [thisObj] Object optional
    this object to use when calling _fn_.

Returns:

Array: Array of return values from _fn_.

modifyAttr

(
  • name
  • config
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:40

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:

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 String
    The name of the attribute whose configuration is to be updated.
  • config Object
    An object with configuration property/value pairs, specifying the configuration properties to modify.

on

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:188

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.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

once

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:124

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.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

onceAfter

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:146

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.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

parse

(
  • response
)
Object

Inherited from ModelList: app/js/model-list.js:642

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.

Parameters:

  • response Any
    Server response.

Returns:

Object: Array of model attribute hashes.

parseType

(
  • type
  • [pre]
)
Array

Inherited from EventTarget: event-custom/js/event-target.js:168

Available since 3.3.0

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.

Parameters:

  • type String
    the type
  • [pre] String optional
    The prefix. Defaults to this._yuievt.config.prefix

Returns:

Array: an array containing: * the detach category, if supplied, * the prefixed event type, * whether or not this is an after listener, * the supplied event type

publish

(
  • type
  • opts
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:503

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.

Parameters:

  • 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).

Returns:

CustomEvent: the custom event

remove

(
  • models
  • [options]
)
Model | Model[]

Inherited from ArrayList but overwritten in app/js/model-list.js:678

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.

Parameters:

  • models Model | Model[] | ModelList | Number | Number[]
    Models or indices of models to remove.
  • [options] Object optional
    Data to be mixed into the event facade of the remove event(s) for the removed models.
    • [silent=false] Boolean optional

      If true, no remove event(s) will be fired.

Returns:

Model | Model[]: Removed model or array of removed models.

removeAttr

(
  • name
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:90

Removes an attribute from the host object

Parameters:

  • name String
    The name of the attribute to be removed.

removeTarget

(
  • o
)
chainable

Inherited from EventTarget: event-custom/js/event-facade.js:533

Removes a bubble target

Parameters:

reset

(
  • [models]
  • [options]
)
chainable

Inherited from AttributeExtras but overwritten in app/js/model-list.js:718

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.

Parameters:

  • [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.

set

(
  • name
  • value
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:388

Sets the value of an attribute.

Parameters:

  • 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.

Returns:

Object:

A reference to the host object.

setAttrs

(
  • attrs
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:747

Sets multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

size

() Integer

Inherited from ArrayList: collection/js/arraylist.js:106

How many items are in this list?

Returns:

Integer: Number of items in the list

some

(
  • callback
  • [thisObj]
)
Boolean

Inherited from ArrayList but overwritten in app/js/model-list.js:770

Available since 3.6.0

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.

Parameters:

  • callback Function
    Function to execute on each model.
    • model Model

      Model instance.

    • index Number

      Index of the current model.

    • list ModelList

      The ModelList being iterated.

  • [thisObj] Object optional
    Object to use as the this object when executing the callback.

Returns:

Boolean: true if the callback returned true for any item, false otherwise.

sort

(
  • [options]
)
chainable

Inherited from ModelList: app/js/model-list.js:807

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.

Parameters:

  • [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.

    • [descending=false] Boolean optional

      If true, the sort is performed in descending order.

subscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:346

Deprecated: use on

subscribe to an event

sync

(
  • action
  • [options]
  • [callback]
)

Inherited from ModelList: app/js/model-list.js:850

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.

Parameters:

  • 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.

toArray

() Model[]

Inherited from ModelList: app/js/model-list.js:888

Returns an array containing the models in this list.

Returns:

Model[]: Array containing the models in this list.

toJSON

() Object

Inherited from ArrayList but overwritten in app/js/model-list.js:898

Returns 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.

Returns:

Object: Array of model attribute hashes.

toString

() String

Inherited from BaseCore: base/js/BaseCore.js:815

Default toString implementation. Provides the constructor NAME and the instance guid, if set.

Returns:

String: String representation for this object

unsubscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:469

Deprecated: use detach

detach a listener

unsubscribeAll

(
  • type
)
deprecated

Inherited from EventTarget: event-custom/js/event-target.js:490

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String
    The type, or name of the event

Properties

_allowAdHocAttrs

Boolean protected

Inherited from BaseCore: base/js/BaseCore.js:155

This 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)

_isYUIModelList

Boolean protected

Inherited from ModelList: app/js/model-list.js:161

Available since 3.5.0

Total 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

model

Model | String

Inherited from ModelList: app/js/model-list.js:142

The 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

Inherited from BaseCore: base/js/BaseCore.js:297

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

Attributes

destroyed

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:212

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

initialized

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:198

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

Events

add

Inherited from ModelList: app/js/model-list.js:37

Fired 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.

Event Payload:

  • model Model
    The model being added.
  • index Number
    The index at which the model will be added.

create

Inherited from ModelList: app/js/model-list.js:54

Available since 3.5.0

Fired 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.

Event Payload:

  • model Model
    The model being created/updated.

destroy

Inherited from BaseObservable: base/js/BaseObservable.js:163

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:

error

Inherited from ModelList: app/js/model-list.js:65

Fired 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.

Event Payload:

  • 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.

init

Inherited from BaseObservable: base/js/BaseObservable.js:62

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 EventFacade
    Event object, with a cfg property which refers to the configuration object passed to the constructor.

load

Inherited from ModelList: app/js/model-list.js:87

Available since 3.5.0

Fired after models are loaded from a sync layer.

Event Payload:

  • 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.

remove

Inherited from ModelList: app/js/model-list.js:99

Fired 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.

Event Payload:

  • model Model
    The model being removed.
  • index Number
    The index of the model being removed.

reset

Inherited from ModelList: app/js/model-list.js:116

Fired 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.

Event Payload:

  • models Model[]
    Array of the list's new models after the reset.
  • src String
    Source of the event. May be either 'reset' or 'sort'.