API Preview tool | The Dojo Toolkit

dojox/wire/ml/Data.js

Provides:
- dojox.wire.ml.DataProperty
Requires:
- dijit._Widget in common
- dijit._Container in common
- dojox.wire.ml.util in common

dojox.wire.ml.Data

type
```
Function
```
chains:
- dijit._Widget: (prototype)
- dijit._Container.prototype: (prototype)
- dijit._Widget: (call)
- dijit._Container: (call)
summary
```
A widget for a data object
```

description

This widget represents an object with '_properties' property.
If child 'DataProperty' widgets exist, they are used to initialize
propertiy values of '_properties' object.

dojox.wire.ml.Data.startup

summary
```
Call _initializeProperties()
```
description
```
See _initializeProperties().
```
type
```
Function
```

dojox.wire.ml.Data._initializeProperties

parameters:
- reset: (typeof Boolean)
```
A boolean to reset current properties
```
summary
```
Initialize a data object
```

description

If this widget has child DataProperty widgets, their getValue()
methods are called and set the return value to a property
specified by 'name' attribute of the child widgets.

type
```
Function
```

dojox.wire.ml.Data._properties
- type
```
Object
```

dojox.wire.ml.Data.getPropertyValue

parameters:
- property: (typeof String)
```
A property name
```
returns
```
anything
```
summary
```
Return a property value
```

description

This method returns the value of a property, specified with
'property' argument, in '_properties' object.

return_summary
```
A property value
```
type
```
Function
```

dojox.wire.ml.Data.setPropertyValue

parameters:
- property: (typeof String)
```
A property name
```
- value: (typeof anything)
```
A property value
```
summary
```
Store a property value
```

description

This method stores 'value' as a property, specified with
'property' argument, in '_properties' object.

type
```
Function
```

dojox.wire.ml.DataProperty

type
```
Function
```
chains:
- dijit._Widget: (prototype)
- dijit._Container.prototype: (prototype)
- dijit._Widget: (call)
- dijit._Container: (call)
summary
```
A widget to define a data property
```

description

Attributes of this widget are used to add a property to the parent
Data widget.
'type' attribute specifies one of "string", "number", "boolean",
"array", "object" and "element" (DOM Element)
(default to "string").
If 'type' is "array" or "object", child DataProperty widgets are
used to initialize the array elements or the object properties.

dojox.wire.ml.DataProperty.name
- type
```
A
```
- summary
```
property name
```
dojox.wire.ml.DataProperty.type
- type
```
A
```
- summary
```
property type name
```
dojox.wire.ml.DataProperty.value
- type
```
A
```
- summary
```
property value
```
dojox.wire.ml.DataProperty._getValueAttr
- type
```
Function
```

dojox.wire.ml.DataProperty.getValue

returns
```
anything
```
summary
```
Returns a property value
```

description

If 'type' is specified, 'value' attribute is converted to
the specified type and returned.
Otherwise, 'value' attribute is returned as is.

return_summary
```
A property value
```
type
```
Function
```

dojox.wire.ml
- type
```
Object
```
dojox.wire
- type
```
Object
```
dojox
- type
```
Object
```

dojox/wire/ml/Data.js

Provides:

Requires:

dojox.wire.ml.Data

dojox.wire.ml.Data.startup

dojox.wire.ml.Data._initializeProperties

dojox.wire.ml.Data._properties

dojox.wire.ml.Data.getPropertyValue

dojox.wire.ml.Data.setPropertyValue

dojox.wire.ml.DataProperty

dojox.wire.ml.DataProperty.name

dojox.wire.ml.DataProperty.type

dojox.wire.ml.DataProperty.value

dojox.wire.ml.DataProperty._getValueAttr

dojox.wire.ml.DataProperty.getValue

dojox.wire.ml

dojox.wire

dojox