dojox/mvc/StoreRefController (version 1.10)

dojox/mvc/ModelRefController

Summary

A child class of dojox.mvc.ModelRefController, which keeps a reference to Dojo Object Store (in store property).

Has several methods to work with the store:

dojo.Stateful get()/set()/watch() interfaces in dojox.mvc.StoreRefController will work with the data model from queryStore() or getStore().

NOTE - If this class is used with a widget by data-dojo-mixins, make sure putting the widget in data-dojo-type and putting this class to data-dojo-mixins.

See the dojox/mvc/StoreRefController reference documentation for more information.

Examples

Example 1

The text box refers to "value" property in the controller (with "ctrl" ID). The controller provides the "value" property, from the data coming from data store ("store" property in the controller). Two seconds later, the text box changes from "Foo" to "Bar" as the controller gets new data from data store. 

<html>
    <head>
        <script src="/path/to/dojo-toolkit/dojo/dojo.js" type="text/javascript" data-dojo-config="parseOnLoad: 0"></script>
        <script type="text/javascript">
            require([
                "dojo/parser", "dojo/when", "dojo/store/Memory", "dijit/registry", "dojo/domReady!"
            ], function(parser, when, Memory, registry){
                store = new Memory({data: [{id: "Foo", value: "Foo"}, {id: "Bar", value: "Bar"}]});
                when(parser.parse(), function(){
                    registry.byId("ctrl").getStore("Foo");
                    setTimeout(function(){ registry.byId("ctrl").getStore("Bar"); }, 2000);
                });
            });
        </script>
    </head>
    <body>
        <script type="dojo/require">at: "dojox/mvc/at"</script>
        <span id="ctrl" data-dojo-type="dojox.mvc.StoreRefController" data-dojo-props="store: store"></span>
        <input type="text" data-dojo-type="dijit/form/TextBox" data-dojo-props="value: at('widget:ctrl', 'value')">
    </body>
</html>

Property Summary

Method Summary

  • _changeAttrValue(name,value) Internal helper for directly changing an attribute value.
  • _dbpostscript(params,srcNodeRef) See if any parameters for this widget are dojox/mvc/at handles.
  • _get(name,names) Private function that does a get based off a hash of names
  • _getAttrNames(name) Helper function for get() and set().
  • _getExcludesAttr() Returns list of all properties that data binding is established with.
  • _getPropertiesAttr() Returns list of all properties in this widget, except "id".
  • _set(name,value) Set the value to the data model or to this object.
  • _setAtWatchHandle(name,value) Called if the value is a dojox/mvc/at handle.
  • _setBind(value) Sets data binding described in data-mvc-bindings.
  • _startAtWatchHandles(bindWith) Establish data bindings based on dojox/mvc/at handles.
  • _stopAtWatchHandles() Stops data binding synchronization handles as widget is destroyed.
  • addStore(object,options) Creates an object, throws an error if the object already exists.
  • destroy() Stops data binding as this object is destroyed.
  • get(name) If getter function is there, use it.
  • getStore(id,options) Retrieves an object by its identity.
  • hasControllerProperty(name) Returns true if this controller itself owns the given property.
  • postscript(params,srcNodeRef) Sets _relTargetProp so that the property specified by _refModelProp is used for relative data binding.
  • putStore(object,options) Stores an object.
  • queryStore(query,options) Queries the store for objects.
  • removeStore(id,options) Deletes an object by its identity
  • set(name,value) If the value given is dojox/mvc/at handle, use it for data binding.
  • startup() Starts up data binding as this object starts up.
  • watch(name,callback) Watch a property in the data model or in this object.

Properties

_attrPairNames
Defined by: dojo/Stateful

Used across all instances a hash to cache attribute names and their getter and setter names.

_refInModelProp
Defined by: dojox/mvc/ModelRefController

The property name for the data model, used as the input. Used when this controller needs data model (as input) that is different from the data model this controller provides.

_refModelProp
Defined by: dojox/mvc/ModelRefController

The property name for the data model.

_refSourceModelProp
Defined by: dojox/mvc/StoreRefController

The property name for the data model, that serves as the data source.

data-mvc-bindings
Defined by: dojox/mvc/_atBindingMixin
dataBindAttr
Defined by: dojox/mvc/_atBindingMixin

The attribute name for data binding.

getStatefulOptions
Defined by: dojox/mvc/StoreRefController

The options to get stateful object from plain value.

model
Defined by: dojox/mvc/ModelRefController

The data model.

ownProps
Defined by: dojox/mvc/ModelRefController

List of property names owned by this controller, instead of the data model.

store
Defined by: dojox/mvc/StoreRefController

The Dojo Object Store in use.

Methods

_changeAttrValue(name,value)
Defined by dojo/Stateful

Internal helper for directly changing an attribute value.

Directly change the value of an attribute on an object, bypassing any accessor setter. Also handles the calling of watch and emitting events. It is designed to be used by descendant class when there are two values of attributes that are linked, but calling .set() is not appropriate.

Parameter Type Description
name String

The property to set.
value Mixed

The value to set in the property.

Returns:function

Internal helper for directly changing an attribute value.

_dbpostscript(params,srcNodeRef)
Defined by dojox/mvc/_atBindingMixin

See if any parameters for this widget are dojox/mvc/at handles. If so, move them under this._refs to prevent widget implementations from referring them.

Parameter Type Description
params Object
Optional
srcNodeRef DomNode | String
_get(name,names)
Defined by dojo/Stateful

Private function that does a get based off a hash of names

Parameter Type Description
name undefined
names undefined

Hash of names of custom attributes
Returns:undefined
_getAttrNames(name)
Defined by dojo/Stateful

Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.

Parameter Type Description
name undefined
Returns:undefined | object
_getExcludesAttr()
Defined by dojox/mvc/_atBindingMixin

Returns list of all properties that data binding is established with.

Returns:undefined | Array
_getPropertiesAttr()
Defined by dojox/mvc/_atBindingMixin

Returns list of all properties in this widget, except "id".

Returns:String[] | undefined

The list of all properties in this widget, except "id"..

_set(name,value)
Defined by dojox/mvc/ModelRefController

Set the value to the data model or to this object.

Parameter Type Description
name String

The property name.
value Anything

The property value.
Returns:function | undefined

Set the value to the data model or to this object.

_setAtWatchHandle(name,value)
Defined by dojox/mvc/_atBindingMixin

Called if the value is a dojox/mvc/at handle. If this widget has started, start data binding with the new dojox/mvc/at handle. Otherwise, queue it up to this._refs so that _dbstartup() can pick it up.

Parameter Type Description
name String
value Anything
_setBind(value)
Defined by dojox/mvc/_atBindingMixin

Sets data binding described in data-mvc-bindings.

Parameter Type Description
value Object
_startAtWatchHandles(bindWith)
Defined by dojox/mvc/_atBindingMixin

Establish data bindings based on dojox/mvc/at handles.

Parameter Type Description
bindWith dojo/Stateful

The dojo/Stateful to bind properties with.
_stopAtWatchHandles()
Defined by dojox/mvc/_atBindingMixin

Stops data binding synchronization handles as widget is destroyed.

addStore(object,options)
Defined by dojox/mvc/StoreRefController

Creates an object, throws an error if the object already exists.

Parameter Type Description
object Object

The object to store.
options dojo/store/api/Store.PutDirectives
Optional

Additional metadata for storing the data. Includes an "id" property if a specific id is to be used.
Returns:Number | undefined
destroy()
Defined by dojox/mvc/_Controller

Stops data binding as this object is destroyed.

get(name)
Defined by dojox/mvc/ModelRefController

If getter function is there, use it. Otherwise, get the data from data model of this object.

Parameter Type Description
name String

The property name.
Returns:undefined
getStore(id,options)
Defined by dojox/mvc/StoreRefController

Retrieves an object by its identity.

Parameter Type Description
id Number

The identity to use to lookup the object.
options Object

The options for dojo/store.*.get().
Returns:Object | undefined

The object in the store that matches the given id.

hasControllerProperty(name)
Defined by dojox/mvc/ModelRefController

Returns true if this controller itself owns the given property.

Parameter Type Description
name String

The property name.
Returns:boolean
postscript(params,srcNodeRef)
Defined by dojox/mvc/ModelRefController

Sets _relTargetProp so that the property specified by _refModelProp is used for relative data binding.

Parameter Type Description
params Object
Optional
srcNodeRef DomNode | String
Optional
putStore(object,options)
Defined by dojox/mvc/StoreRefController

Stores an object.

Parameter Type Description
object Object

The object to store.
options dojo/store/api/Store.PutDirectives
Optional

Additional metadata for storing the data. Includes an "id" property if a specific id is to be used.
Returns:Number | undefined
queryStore(query,options)
Defined by dojox/mvc/StoreRefController

Queries the store for objects.

Parameter Type Description
query Object

The query to use for retrieving objects from the store.
options dojo/store/api/Store.QueryOptions
Optional

The optional arguments to apply to the resultset.
Returns:dojo/store/api/Store.QueryResults | undefined

The results of the query, extended with iterative methods.

removeStore(id,options)
Defined by dojox/mvc/StoreRefController

Deletes an object by its identity

Parameter Type Description
id Number

The identity to use to delete the object
options Object

The options for dojo/store/*.remove().
Returns:Boolean | undefined

Returns true if an object was removed, falsy (undefined) if no object matched the id.

set(name,value)
Defined by dojox/mvc/_Controller

If the value given is dojox/mvc/at handle, use it for data binding. Otherwise, if setter function is there, use it. Otherwise, set the value to the data model or to this object.

Parameter Type Description
name String

The property name.
value Anything

The property value.
Returns:function | undefined

If the value given is dojox/mvc/at handle, use it for data binding. Otherwise, if setter function is there, use it. Otherwise, set the value to the data model or to this object.

startup()
Defined by dojox/mvc/_Controller

Starts up data binding as this object starts up.

watch(name,callback)
Defined by dojox/mvc/ModelRefController

Watch a property in the data model or in this object.

Parameter Type Description
name String
Optional

The property name.
callback Function

The callback function.
Returns:undefined | object
Error in the documentation? Can’t find what you are looking for? Let us know!