A controller that keeps a reference to dojo/Stateful-based data model.
Does the following on behalf of such model:
Can also be used to do some application-specific stuffs upon change in properties in model, by defining setter functions. Doing so will help keep models and widgets free from application-specific logic, and will help keep application logic free from specifics of models and widgets. Such kind of setter functions can be defined in the same manner as widgets (_setXXXAttr()).
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/_base.ModelRefController reference documentation for more information.
The text box refers to "value" property in the controller (with "ctrl" ID). The controller provides the "value" property on behalf of the model ("model" property in the controller). Two seconds later, the text box changes from "Foo" to "Bar" as the controller changes the data model it refers to.
<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/Stateful", "dijit/registry",
"dijit/form/TextBox", "dojox/mvc/ModelRefController", "dojo/domReady!"
], function(parser, Stateful, registry){
modelFoo = new Stateful({value: "Foo"});
modelBar = new Stateful({value: "Bar"});
setTimeout(function(){ registry.byId("ctrl").set("model", modelBar); }, 2000);
parser.parse();
});
</script>
</head>
<body>
<script type="dojo/require">at: "dojox/mvc/at"</script>
<span id="ctrl" data-dojo-type="dojox/mvc/ModelRefController" data-dojo-props="model: modelFoo"></span>
<input type="text" data-dojo-type="dijit/form/TextBox" data-dojo-props="value: at('widget:ctrl', 'value')">
</body>
</html>
Used across all instances a hash to cache attribute names and their getter and setter names.
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.
List of property names owned by this controller, instead of the data model.
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. |
Internal helper for directly changing an attribute value.
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 |
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 |
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 list of all properties that data binding is established with.
Returns list of all properties in this widget, except "id".
The list of all properties in this widget, except "id"..
Set the value to the data model or to this object.
| Parameter | Type | Description |
|---|---|---|
| name | String | The property name. |
| value | Anything | The property value. |
Set the value to the data model or to this object.
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 |
Sets data binding described in data-mvc-bindings.
| Parameter | Type | Description |
|---|---|---|
| value | Object |
Establish data bindings based on dojox/mvc/at handles.
| Parameter | Type | Description |
|---|---|---|
| bindWith | dojo/Stateful | The dojo/Stateful to bind properties with. |
Stops data binding synchronization handles as widget is destroyed.
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 true if this controller itself owns the given property.
| Parameter | Type | Description |
|---|---|---|
| name | String | The property name. |
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
|
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. |
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.
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. |