dojox/wire/Wire.js

• Provides:

  • dojox.wire.Wire

• Requires:

  • dojox.wire._base in common

• dojox.wire.Wire

  • type

    Function

  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      object:
      A root object (or another Wire to access a root object)
      property:
      A dotted notation to a descendant property
      type:
      A type of the return value (for the source Wire)

  • summary

    A default and base Wire to access an object property

  • description

    This class accesses a property of an object with a dotted notation
    specified to 'property' property, such as "a.b.c", which identifies
    a descendant property, "object.a.b.c".
    Property names in the dotted notation may have an array index, such
    as "a[0]", to identify an array element, literally, "object.a[0]".
    When a notation start with an array index, such as "[0].a", it
    specifies an array element of the root object (array),
    "object[0].a".
    This class also serves as a base class for other Wire classes,
    preparing a root object and converting a return value, so that
    sub-classes just can implement _getValue() and _setValue() called
    from getValue() and setValue() implemented by this calss.

• dojox.wire.Wire._wireClass

  • type

    String

• dojox.wire.Wire.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      object:
      A root object (or another Wire to access a root object)
      property:
      A dotted notation to a descendant property
      type:
      A type of the return value (for the source Wire)

  • summary

    Initialize properties

  • description

    If 'converter' property is specified and is a string for
    a converter class, an instanceof the converter class is
    created.

• dojox.wire.Wire.getValue

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

      A default root object

  • returns

    anything (null, undefined, etc)|anything

  • summary

    Return a value of an object

  • description

    This method first determins a root object as follows:
    1. If 'object' property specified,
    1.1 If 'object' is a Wire, its getValue() method is called to
    obtain a root object.
    1.2 Otherwise, use 'object' as a root object.
    2. Otherwise, use 'defaultObject' argument.
    3. If 'property' is specified, it is used to get a property
    value.
    Then, if a sub-class implements _getValue() method, it is
    called with the root object to get the return value.
    Otherwise, the root object (typically, a property valye) is
    used for the return value.
    Finally, if 'type' property is specified, the return value is
    converted to the specified primitive type ("string", "number",
    "boolean" and "array").
    If 'converter' property is specified, its convert() method is
    called to convert the value.

  • return_summary

    A value found

  • type

    Function

• dojox.wire.Wire.setValue

  • parameters:
    • value: (typeof anything)

      A value to set

    • defaultObject: (typeof Object||Array)

      A default root object

  • summary

    Set a value to an object

  • description

    This method first determins a root object as follows:
    1. If 'object' property specified,
    1.1 If 'object' is a Wire, its getValue() method is called to
    obtain a root object.
    1.2 Otherwise, use 'object' as a root object.
    2. Otherwise, use 'defaultObject' argument.
    3. If 'property' is specified, it is used to get a property
    value.
    Then, if a sub-class implements _setValue() method, it is
    called with the root object and 'value' argument to set
    the value.
    Otherwise, 'value' is set to a property specified with
    'property' property.
    If the root object is undefined and 'object' property is a Wire
    and a new object is created and returned by _setValue() it is
    set through 'object' (setValue() method).

  • type

    Function

• dojox.wire.Wire._getPropertyValue

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

      A default root object

    • property: (typeof String)

      A property name

  • returns

    anything

  • summary

    Return a property value of an object

  • description

    A value for 'property' of 'object' is returned.
    If 'property' ends with an array index, it is used to indentify
    an element of an array property.
    If 'object' implements getPropertyValue(), it is called with
    'property' to obtain the property value.
    If 'object' implements a getter for the property, it is called
    to obtain the property value.

  • return_summary

    A value found, otherwise 'undefined'

  • type

    Function

• dojox.wire.Wire._setPropertyValue

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

      An object

    • property: (typeof String)

      A property name

    • value: (typeof anything)

      A value to set

  • summary

    Set a property value to an object

  • description

    'value' is set to 'property' of 'object'.
    If 'property' ends with an array index, it is used to indentify
    an element of an array property to set the value.
    If 'object' implements setPropertyValue(), it is called with
    'property' and 'value' to set the property value.
    If 'object' implements a setter for the property, it is called
    with 'value' to set the property value.

  • type

    Function

• dojox.wire.Wire._useGet

  • parameters:
    • object: (typeof The)

      target object to set the property of.

  • summary

    Function to detect if dijit.get support exists on the target

  • type

    Function

• dojox.wire.Wire._useSet

  • parameters:
    • object: (typeof The)

      target object to set the property of.

  • summary

    Function to detect if dijit.set support exists on the target

  • type

    Function

• dojox.wire.Wire._useAttr

  • parameters:
    • object: (typeof The)

      target object to set the property of.

  • summary

    Function to detect if dijit.attr support exists on the target

  • type

    Function

• dojox.wire.Wire.converter

  • type

    A

  • summary

    converter object (or class name) to convert the return
    value (for the source Wire)

• dojox.wire

  • type

    Object

• dojox

  • type

    Object