Model

mojo.Model.set = function( key, valueObj )

Sets the model data for a particular model key.  If a model registered under the key does not exist, it is created.

Parameters

Example

var data = [1 2,3];
mojo.Model.set("testModel", data); // store data into the "testModel" model

mojo.Model.add = function( key, valueObj )

Appends a data item to a model that is an array list.

Parameters

Example

var data = [1,2,3];
mojo.Model.set("testModel", data);
mojo.Model.add("testModel", 4); // model is now [1, 2, 3, 4]

mojo.Model.get = function( key )

Retrieves the data for a specified model based on the model key.

Parameters

Returns

{object} Mojo Model.

Examples

var temp = mojo.Model.get("testModel");

mojo.Model.getReference = function( key )

Retrieves the mojo.ModelReference object associated with a model.  If model doesn’t exist, this function will generate one.  Object can be observed in a Mojo Controller.

Parameters

Returns

{object} Model Reference Object

Example

// stand-alone usage
var modelObj = mojo.Model.getReference("testModel");

// usage in a Mojo Controller
this.addObserver(mojo.Model.getReference("testModel"), "onNotify", "SomeCommand");

mojo.Model.remove = function( key )

Clears the model data for a particular model key.

Parameters

Example

mojo.Model.remove("testModel");

mojo.Model.contains = function( key )

Returns whether or not a specified model exists.

Parameters

Returns

{boolean} Exists

Example

if (mojo.Model.contains("testModel")) {
    // the model exists!
}

mojo.Model.notify = function( key )

Notifies any registered observers of the specified model of a model change.  This method is automatically triggered on set, add, and remove Model methods.  This method is used with mojo.component.Template to re-databind the template.

Parameters

Example

// observe "testModel" model
mojo.Model.addObserver("testModel", {doSomething: function() {
    var data = mojo.Model.get("testModel");
    //do something
}}, "doSomething");
mojo.Model.notify("testModel"); // notify observer to do something with model

mojo.Model.addObserver = function( key, targetObj, targetFunc )

Registers an observer to a specified model.  Returns a handle to allow unregistering.

Parameters

Returns

{object} handle

Example

// observe "testModel" model
    mojo.Model.addObserver("testModel", {doSomething: function() {
        var data = mojo.Model.get("testModel");
        //do something
}}, "doSomething");
    mojo.Model.notify("testModel"); // notify observer to do something with model

mojo.Model.removeObserver = function( handle )

Unregisters an observer from a model.

Parameters

Example

// observe "testModel" model
var handle = mojo.Model.addObserver("testModel", {doSomething: function() {
    var data = mojo.Model.get("testModel");
    //do something
}}, "doSomething");
// remove observer
mojo.Model.removeObserver(handle);