dojox/wire/CompositeWire.js

• Provides:

  • dojox.wire.CompositeWire

• Requires:

  • dojox.wire._base in common
  • dojox.wire.Wire in common

• dojox.wire.CompositeWire

  • type

    Function

  • chains:
    • dojox.wire.Wire: (prototype)
    • dojox.wire.Wire: (call)
  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      children:
      An object or array containing child Wires

  • summary

    A Wire for composite values in object or array

  • description

    This class has multiple child Wires for object properties or array
    elements.
    When an object with Wires is specified to 'children' property, they
    are used to get or set an object with property values.
    When an array of Wiares is specified to 'children' property, they
    are used to get or set an array with element values.

• dojox.wire.CompositeWire._wireClass

  • type

    String

• dojox.wire.CompositeWire.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      children:
      An object or array containing child Wires

  • summary

    Initialize properties

  • description

    If object properties or array elements specified in 'children'
    property are not Wires, Wires are created from them as
    arguments, with 'parent' property set to this Wire instance.

• dojox.wire.CompositeWire._getValue

  • parameters:
    • object: (typeof Object||Array)

      A root object

  • returns

    Object||Array

  • summary

    Return an object with property values or an array with element
    values

  • description

    This method calls getValue() method of the child Wires with
    'object' argument and returns an object with the values as
    properties or an arary of the values as elements.

  • return_summary

    An object or array with values

  • type

    Function

• dojox.wire.CompositeWire._setValue

  • parameters:
    • object: (typeof Object||Array)

      A root object

    • value: (typeof Object||Array)

      An object or array with values to set

  • returns

    Object||Array

  • summary

    Set an object properties or an array elements to an object
    desription:
    This method calls setValues() method of the child Wires with
    a corresponding property or element in 'value' argument and
    'object' argument.

  • return_summary

    'object'

  • type

    Function

• dojox.wire.CompositeWire._initializeChildren

  • parameters:
    • children: (typeof Object||Array)

      An object or array containing child Wires

  • returns

    undefined

  • summary

    Initialize child Wires

  • description

    If object properties or array elements specified in 'children'
    argument are not Wires, Wires are created from them as
    arguments, with 'parent' property set to this Wire instance.

  • type

    Function

• dojox.wire

  • type

    Object

• dojox

  • type

    Object