dijit/form/_FormMixin.js

• Provides:

  • dijit.form._FormMixin

• Requires:

  • dojo.window in common

• dijit.form._FormMixin

  • type

    Function

  • summary

    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)

  • description

    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

• dijit.form._FormMixin.state

  • tags: readonly
  • type

    String

  • summary

    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.

• dijit.form._FormMixin.reset

  • type

    Function

• dijit.form._FormMixin.validate

  • summary

    returns if the form is valid - same as isValid - but
    provides a few additional (ui-specific) features.
    1 - it will highlight any sub-widgets that are not
    valid
    2 - it will call focus() on the first invalid
    sub-widget

  • type

    Function

• dijit.form._FormMixin.setValues

  • parameters:
    • val
  • type

    Function

• dijit.form._FormMixin._setValueAttr

  • parameters:
    • obj: (typeof Object)
  • summary

    Fill in form values from according to an Object (in the format returned by get('value'))

  • type

    Function

• dijit.form._FormMixin.getValues

  • type

    Function

• dijit.form._FormMixin._getValueAttr

  • summary

    Returns Object representing form values.   See description of <code>value</code> for details.

  • type

    Function

• dijit.form._FormMixin.isValid

  • summary

    Returns true if all of the widgets are valid.
    Deprecated, will be removed in 2.0.  Use get("state") instead.

  • type

    Function

• dijit.form._FormMixin.onValidStateChange

  • parameters:
    • isValid
  • summary

    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.

  • type

    Function

• dijit.form._FormMixin._getState

  • summary

    Compute what this.state should be based on state of children

  • type

    Function

• dijit.form._FormMixin.disconnectChildren

  • summary

    Remove connections to monitor changes to children's value, error state, and disabled state,
    in order to update Form.value and Form.state.

  • type

    Function

• dijit.form._FormMixin.connectChildren

  • parameters:
    • inStartup: (typeof Boolean)
  • summary

    Setup connections to monitor changes to children's value, error state, and disabled state,
    in order to update Form.value and Form.state.
    
    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.

  • type

    Function

• dijit.form._FormMixin._descendants

  • type

    Object

• dijit.form._FormMixin._childConnections

  • type

    Array

• dijit.form._FormMixin._childWatches

  • type

    Array

• dijit.form._FormMixin.startup

  • type

    Function

• dijit.form._FormMixin.destroy

  • type

    Function

• dijit.form

  • type

    Object

• dijit

  • type

    Object