Mixin for containers of form widgets (i.e. widgets that represent a single value
and can be children of a <form>
node or dijit/form/Form widget)
Can extract all the form widgets values and combine them into a single javascript object, or alternately take such an object and set the values for all the contained form widgets
See the dijit/form/_FormMixin reference documentation for more information.
Will be "Error" if one or more of the child widgets has an invalid value, "Incomplete" if not all of the required child widgets are filled in. Otherwise, "", which indicates that the form is ready to be submitted.
Returns all form widget descendants, searching through non-form child widgets like BorderContainer
Parameter | Type | Description |
---|---|---|
children | dijit/_WidgetBase[] |
Optional
|
Compute what this.state should be based on state of children
Returns Object representing form values. See description of value
for details.
Fill in form values from according to an Object (in the format returned by get('value'))
Parameter | Type | Description |
---|---|---|
obj | Object |
You can call this function directly, ex. in the event that you programmatically add a widget to the form after the form has been initialized.
Parameter | Type | Description |
---|---|---|
inStartup | Boolean |
Deprecated method. Applications no longer need to call this. Remove for 2.0.
Returns true if all of the widgets are valid. Deprecated, will be removed in 2.0. Use get("state") instead.
returns if the form is valid - same as isValid - but provides a few additional (ui-specific) features:
Called when child's value or disabled state changes
Parameter | Type | Description |
---|---|---|
attr | String |
Stub function to connect to if you want to do something (like disable/enable a submit button) when the valid state changes on the form as a whole.
Deprecated. Will be removed in 2.0. Use watch("state", ...) instead.
Parameter | Type | Description |
---|---|---|
isValid | Boolean |