dojox/wire/TreeAdapter.js

• Provides:

  • dojox.wire.TreeAdapter

• Requires:

  • dojox.wire.CompositeWire in common

• dojox.wire.TreeAdapter

  • type

    Function

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

      Arguments to initialize properties
      nodes:
      An array containing objects for child Wires for node values

  • summary

    A composite Wire for tree nodes

  • description

    This class has multiple child Wires for tree nodes, their title and
    child nodes.
    The root object for this class must be an array.
    'node' Wires in 'nodes' property is used to identify an object
    representing a node.
    'title' Wires in 'nodes' property is used to get the title string
    of a node.
    'children' Wires in 'nodes' property is used to iterate over child
    node objects.
    The node values are returned in an array as follows:
    [
    {title: title1,
    children: [
    {title: title2,
    child: ...},
    {title: title3,
    child: ...},
    ...
    ]},
    ...
    ]
    This class only supports getValue(), but not setValue().

• dojox.wire.TreeAdapter._wireClass

  • type

    String

• dojox.wire.TreeAdapter.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      Arguments to initialize properties
      nodes:
      An array containing objects for child Wires for node values

  • summary

    Initialize properties

  • description

    If object properties ('node', 'title' and 'children') of array
    elements specified in 'nodes' property are not Wires, Wires are
    created from them as arguments, with 'parent' property set to
    this Wire instance.

• dojox.wire.TreeAdapter._getValue

  • parameters:
    • object: (typeof Array)

      A root array

  • returns

    Array

  • summary

    Return an array of tree node values

  • description

    This method iterates over an array specified to 'object'
    argument and calls getValue() method of 'node' Wires with each
    element of the array to get object(s) that represetns nodes.
    (If 'node' Wires are omitted, the array element is used for
    further processing.)
    Then, getValue() method of 'title' Wires are called to get
    title strings for nodes.
    (If 'title' Wires are omitted, the objects representing nodes
    are used as title strings.)
    And if an array of objects with 'node' and 'title' Wires is
    specified to 'children', it is used to gather child nodes and
    their title strings in the same way recursively.
    Finally, an array of the top-level node objects are retuned.

  • return_summary

    An array of tree node values

  • type

    Function

• dojox.wire.TreeAdapter._setValue

  • parameters:
    • object: (typeof Array)
    • value: (typeof Array)
  • summary

    Not supported

  • type

    Function

• dojox.wire.TreeAdapter._initializeChildren

  • parameters:
    • children: (typeof Array)

      An array of objects containing child Wires

  • returns

    undefined

  • summary

    Initialize child Wires

  • description

    If 'node' or 'title' properties of array elements specified in
    'children' argument are not Wires, Wires are created from them
    as arguments, with 'parent' property set to this Wire instance.
    If an array element has 'children' property, this method is
    called recursively with it.

  • type

    Function

• dojox.wire.TreeAdapter._getNodes

  • parameters:
    • object: (typeof Object)

      An object

    • child: (typeof Object)

      An object with child Wires

  • returns

    Array

  • summary

    Return an array of tree node values

  • description

    This method calls getValue() method of 'node' Wires with
    'object' argument to get object(s) that represents nodes.
    (If 'node' Wires are omitted, 'object' is used for further
    processing.)
    Then, getValue() method of 'title' Wires are called to get
    title strings for nodes.
    (If 'title' Wires are omitted, the objects representing nodes
    are used as title strings.)
    And if an array of objects with 'node' and 'title' Wires is
    specified to 'children', it is used to gather child nodes and
    their title strings in the same way recursively.
    Finally, an array of node objects are returned.

  • return_summary

  • type

    Function

• dojox.wire

  • type

    Object

• dojox

  • type

    Object