dojox/form/manager/_NodeMixin.js

• Provides:

  • dojox.form.manager._NodeMixin

• Requires:

  • dojox.form.manager._Mixin in common

• dojox.form.manager._NodeMixin

  • type

    Function

  • summary

    Mixin to orchestrate dynamic forms (works with DOM nodes).

  • description

    This mixin provideas a foundation for an enhanced form
    functionality: unified access to individual form elements,
    unified "onchange" event processing, and general event
    processing. It complements dojox.form.manager._Mixin
    extending the functionality to DOM nodes.

• dojox.form.manager._NodeMixin.destroy

  • summary

    Called when the widget is being destroyed

  • type

    Function

• dojox.form.manager._NodeMixin.formNodes

  • type

    Object

• dojox.form.manager._NodeMixin.registerNode

  • parameters:
    • node: (typeof String|Node:)

      A node, or its id

  • summary

    Register a node with the form manager

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._NodeMixin.unregisterNode

  • parameters:
    • name: (typeof String:)

      Name of the to unregister

  • summary

    Removes the node by name from internal tables unregistering
    connected observers

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._NodeMixin.registerNodeDescendants

  • parameters:
    • node: (typeof String|Node:)

      A widget, or its widgetId, or its DOM node

  • summary

    Register node's descendants (form nodes) with the form manager

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._NodeMixin.unregisterNodeDescendants

  • parameters:
    • node: (typeof String|Node:)

      A widget, or its widgetId, or its DOM node

  • summary

    Unregister node's descendants (form nodes) with the form manager

  • return_summary

    Object:
    Returns self

  • type

    Function

• dojox.form.manager._NodeMixin.formNodeValue

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

      Form element's name, DOM node, or array or radio nodes.

    • value: (typeof Object:)

      Optional. The value to set.

  • returns

    Object|self|String

  • summary

    Set or get a form element 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._NodeMixin.inspectFormNodes

  • parameters:
    • inspector: (typeof Function:)

      A function to be called on a form element. 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 form 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 form elements returning a result object.

  • type

    Function

• dojox.form.manager

  • alias - dojox.form.manager

• dojox.form.manager.actionAdapter

  • alias - dojox.form.manager.actionAdapter

• dojox.form.manager._keys

  • alias - dojox.form.manager._keys

• dojox.form.manager.changeEvent

  • parameters:
    • node: (typeof Node:)

      Form node.

  • returns

    String

  • summary

    Function that returns a valid "onchange" event for a given form node.

  • type

    Function

• dojox.form

  • type

    Object

• dojox

  • type

    Object