dojox/form/manager/_Mixin.js

• Provides:

  • dojox.form.manager._Mixin

• Requires:

  • dijit._Widget in common

• dijit._Widget

  • type

    Function

• dijit._Widget.observer

  • type

    String

• dojox.form.manager._Mixin

  • type

    Function

  • summary

    Mixin to orchestrate dynamic forms.

  • description

    This mixin provideas a foundation for an enhanced form
    functionality: unified access to individual form elements,
    unified "onchange" event processing, general event
    processing, I/O orchestration, and common form-related
    functionality. See additional mixins in dojox.form.manager
    namespace.

• dojox.form.manager._Mixin.watching

  • type

    Object

• dojox.form.manager._Mixin.startup

  • summary

    Called after all the widgets have been instantiated and their
    dom nodes have been inserted somewhere under dojo.doc.body.

  • type

    Function

• dojox.form.manager._Mixin.formWidgets

  • type

    Object

• dojox.form.manager._Mixin.formNodes

  • type

    Object

• dojox.form.manager._Mixin.destroy

  • summary

    Called when the widget is being destroyed

  • type

    Function

• dojox.form.manager._Mixin.registerWidget

  • parameters:
    • widget: (typeof String|Node|dijit.form._FormWidget:)

      A widget, or its widgetId, or its DOM node

  • summary

    Register a widget with the form manager

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._Mixin.unregisterWidget

  • parameters:
    • name: (typeof String:)

      Name of the to unregister

  • summary

    Removes the widget by name from internal tables unregistering
    connected observers

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._Mixin.registerWidgetDescendants

  • parameters:
    • widget: (typeof String|Node|dijit._Widget:)

      A widget, or its widgetId, or its DOM node

  • summary

    Register widget's descendants with the form manager

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._Mixin.unregisterWidgetDescendants

  • parameters:
    • widget: (typeof String|Node|dijit._Widget:)

      A widget, or its widgetId, or its DOM node

  • summary

    Unregister widget's descendants with the form manager

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._Mixin.formWidgetValue

  • parameters:
    • elem: (typeof String|Object|Array:)

      Form element's name, widget object, or array or radio widgets.

    • value: (typeof Object:)

      Optional. The value to set.

  • returns

    Object|self|String

  • summary

    Set or get a form widget by name.

  • return_summary

    Object:
    For a getter it returns the value, for a setter it returns
    self. If the elem is not valid, null will be returned.

  • type

    Function

• dojox.form.manager._Mixin.formPointValue

  • parameters:
    • elem: (typeof String|Object|Array:)

      A node.

    • value: (typeof Object:)

      Optional. The value to set.

  • returns

    Object|self|String

  • summary

    Set or get a node context by name (using dojoAttachPoint).

  • return_summary

    Object:
    For a getter it returns the value, for a setter it returns
    self. If the elem is not valid, null will be returned.

  • type

    Function

• dojox.form.manager._Mixin.inspectFormWidgets

  • parameters:
    • inspector: (typeof Function:)

      A function to be called on a widget. Takes three arguments: a name, a widget object
      or an array of widget objects, and a supplied value. Runs in the context of
      the form manager. Returns a value that will be collected and returned as a state.

    • state: (typeof Object:)

      Optional. If a name-value dictionary --- only listed names will be processed.
      If an array, all names in the array will be processed with defaultValue.
      If omitted or null, all widgets will be processed with defaultValue.

    • defaultValue: (typeof Object:)

      Optional. The default state (true, if omitted).

  • returns

    Object

  • summary

    Run an inspector function on controlled widgets returning a result object.

  • type

    Function

• dojox.form.manager._Mixin.inspectAttachedPoints

  • parameters:
    • inspector: (typeof Function:)

      A function to be called on a node. Takes three arguments: a name, a node or
      an array of nodes, and a supplied value. Runs in the context of the form manager.
      Returns a value that will be collected and returned as a state.

    • state: (typeof Object:)

      Optional. If a name-value dictionary --- only listed names will be processed.
      If an array, all names in the array will be processed with defaultValue.
      If omitted or null, all attached point nodes will be processed with defaultValue.

    • defaultValue: (typeof Object:)

      Optional. The default state (true, if omitted).

  • returns

    Object

  • summary

    Run an inspector function on "dojoAttachPoint" nodes returning a result object.

  • type

    Function

• dojox.form.manager._Mixin.inspect

  • parameters:
    • inspector: (typeof Function:)

      A function to be called on a widget, form element, and an attached node.
      Takes three arguments: a name, a node (domNode in the case of widget) or
      an array of such objects, and a supplied value. Runs in the context of
      the form manager. Returns a value that will be collected and returned as a state.

    • state: (typeof Object:)

      Optional. If a name-value dictionary --- only listed names will be processed.
      If an array, all names in the array will be processed with defaultValue.
      If omitted or null, all controlled elements will be processed with defaultValue.

    • defaultValue: (typeof Object:)

      Optional. The default state (true, if omitted).

  • returns

    Object

  • summary

    Run an inspector function on controlled elements returning a result object.

  • type

    Function

• dojox.form.manager

  • alias - dojox.form.manager

• dojox.form.manager.actionAdapter

  • parameters:
    • action: (typeof Function:)

      Function that takes three parameters: a name, an object
      (usually node or widget), and a value. This action will
      be applied to all elements of array.

  • summary

    Adapter that automates application of actions to arrays.

  • type

    Function

• dojox.form.manager.inspectorAdapter

  • parameters:
    • inspector: (typeof Function:)

      Function that takes three parameters: a name, an object
      (usually node or widget), and a value.

  • summary

    Adapter that applies an inspector only to the first item of the array.

  • type

    Function

• dojox.form.manager._keys

  • parameters:
    • o
  • type

    Function

• dojox.form

  • type

    Object

• dojox

  • type

    Object