dojox/wire/DataWire.js

• Provides:

  • dojox.wire.DataWire

• Requires:

  • dojox.wire.Wire in common

• dojox.wire.DataWire

  • type

    Function

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

      Arguments to initialize properties

  • summary

    A Wire for item attributes of data stores

  • description

    This class accesses item attributes of data stores with a dotted
    notation of attribute names specified to 'attribute' property,
    using data APIs of a data store specified to 'dataStore' property.
    The root object for this class must be an item of the data store.
    Intermediate attribute names in the dotted notation specify
    attributes for child items, which are used for repeated calls to
    data APIs until reached to a descendant attribute.
    Attribute names may have an array index, such as "a[0]", to
    identify an array element of the attribute value.

• dojox.wire.DataWire._wireClass

  • type

    String

• dojox.wire.DataWire.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties

  • summary

    Initialize properties

  • description

    If 'dataStore' property is not specified, but 'parent' property
    is specified, 'dataStore' property is copied from the parent.

• dojox.wire.DataWire._getValue

  • parameters:
    • object: (typeof Object)

      A root item

  • returns

    Object|undefined|anything

  • summary

    Return an attribute value of an item

  • description

    This method uses a root item passed in 'object' argument and
    'attribute' property to call getValue() method of
    'dataStore'.
    If an attribute name have an array suffix ("[]"), getValues()
    method is called, instead.
    If an index is specified in the array suffix, an array element
    for the index is returned, instead of the array itself.

  • return_summary

    A value found, otherwise 'undefined'

  • type

    Function

• dojox.wire.DataWire._setValue

  • parameters:
    • object: (typeof Object)

      A root item

    • value: (typeof anything)

      A value to set

  • returns

    Object|undefined

  • summary

    Set an attribute value to an item

  • description

    This method uses a root item passed in 'object' argument and
    'attribute' property to identify an item.
    Then, setValue() method of 'dataStore' is called with a leaf
    attribute name and 'value' argument.
    If an attribute name have an array suffix ("[]"), setValues()
    method is called, instead.
    If an index is specified in the array suffix, an array element
    for the index is set to 'value', instead of the array itself.

  • return_summary

    'object', or 'undefined' for invalid attribute

  • type

    Function

• dojox.wire.DataWire._getAttributeValue

  • parameters:
    • item: (typeof Object)

      An item
      attribute
      An attribute name

    • attribute: (typeof String)
  • returns

    anything

  • summary

    Return an attribute value of an item

  • description

    This method uses an item passed in 'item' argument and
    'attribute' argument to call getValue() method of 'dataStore'.
    If an attribute name have an array suffix ("[]"), getValues()
    method is called, instead.
    If an index is specified in the array suffix, an array element
    for the index is returned, instead of the array itself.

  • return_summary

    A value found, otherwise 'undefined'

  • type

    Function

• dojox.wire.DataWire._setAttributeValue

  • parameters:
    • item: (typeof Object)

      An item

    • attribute: (typeof String)

      An attribute name

    • value: (typeof anything)

      A value to set

  • summary

    Set an attribute value to an item

  • description

    This method uses an item passed in 'item' argument and
    'attribute' argument to call setValue() method of 'dataStore'
    with 'value' argument.
    If an attribute name have an array suffix ("[]"), setValues()
    method is called, instead.
    If an index is specified in the array suffix, an array element
    for the index is set to 'value', instead of the array itself.

  • type

    Function

• dojox.wire.DataWire.dataStore

  • type

    A

  • summary

    data store
    attribute:
    A dotted notation to a descendant attribute

• dojox.wire

  • type

    Object

• dojox

  • type

    Object