Warning: Use of undefined constant Symbol - assumed 'Symbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215 Warning: Use of undefined constant JavaScriptSymbol - assumed 'JavaScriptSymbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215

dojox/wire/ml/Transfer.js

  • Provides:

    • dojox.wire.ml.SegmentWire
  • Requires:

    • dijit._Widget in common
    • dijit._Container in common
    • dojox.wire._base in common
    • dojox.wire.ml.Action in common
  • dojox.wire.ml.Transfer

    • type
      Function
    • chains:
      • dojox.wire.ml.Action: (prototype)
      • dojox.wire.ml.Action: (call)
    • summary
      A widget to transfer values through source and target Wires
    • description
      This widget represents a controller task to transfer a value from
      a source to a target, through a source and a target Wires, when
      an event (a function) or a topic is issued.
      If this widget has child ChildWire widgets, their _addWire()
      methods are called to add Wire arguments to a source or a target
      Wire.
  • dojox.wire.ml.Transfer.source

    • type
      A
    • summary
      source object and/or property
  • dojox.wire.ml.Transfer.sourceStore

    • type
      A
    • summary
      data store for a source data item
  • dojox.wire.ml.Transfer.sourceAttribute

    • type
      An
    • summary
      attribute of a source data item
  • dojox.wire.ml.Transfer.sourcePath

    • type
      A
    • summary
      simplified XPath to a source property of an XML element
  • dojox.wire.ml.Transfer.type

    • type
      A
    • summary
      type of the value to be transferred
  • dojox.wire.ml.Transfer.converter

    • type
      A
    • summary
      class name of a converter for the value to be transferred
  • dojox.wire.ml.Transfer.delimiter

    • type
      String
  • dojox.wire.ml.Transfer.target

    • type
      A
    • summary
      target object and/or property
  • dojox.wire.ml.Transfer.targetStore

    • type
      A
    • summary
      data store for a target data item
  • dojox.wire.ml.Transfer.targetAttribute

    • type
      An
    • summary
      attribute of a target data item
  • dojox.wire.ml.Transfer.targetPath

    • type
      A
    • summary
      simplified XPath to a target property of an XML element
  • dojox.wire.ml.Transfer._run

    • summary
      Transfer a value from a source to a target
    • description
      First, Wires for a source and a target are created from attributes.
      Then, a value is obtained by getValue() of the source Wire is set
      by setValue() of the target Wire.
      The arguments to this method is passed to getValue() and setValue()
      of Wires, so that they can be used to identify the root objects off
      the arguments.
    • type
      Function
  • dojox.wire.ml.Transfer._getWire

    • parameters:
      • which: (typeof String)
        Which Wire arguments to build, "source" or "target"
    • returns
      Object
    • summary
      Build Wire arguments from attributes
    • description
      Arguments object for a source or a target Wire, specified by
      'which' argument, are build from corresponding attributes,
      including '*Store' (for 'dataStore'), '*Attribute'
      (for 'attribute), '*Path' (for 'path'), 'type' and 'converter'.
      'source' or 'target' attribute is parsed as:
      "object_id.property_name[.sub_property_name...]"
      If 'source' or 'target' starts with "arguments", 'object'
      argument for a Wire is set to null, so that the root object is
      given as an event or topic arguments.
      If this widget has child ChildWire widgets with a corresponding
      'which' attribute, their _addWire() methods are called to add
      additional Wire arguments and nested Wire is created,
      specifying the Wire defined by this widget to 'object' argument.
    • return_summary
      Wire arguments object
    • type
      Function
  • dojox.wire.ml.ChildWire

    • type
      Function
    • chains:
      • dijit._Widget: (prototype)
      • dijit._Widget: (call)
    • summary
      A widget to add a child wire
    • description
      Attributes of this widget are used to add a child Wire to
      a composite Wire of the parent Transfer widget.
  • dojox.wire.ml.ChildWire.which

    • type
      Which
    • summary
      Wire to add a child Wire, "source" or "target", default to
      "source"
  • dojox.wire.ml.ChildWire.object

    • type
      A
    • summary
      root object for the value
  • dojox.wire.ml.ChildWire.property

    • type
      A
    • summary
      property for the value
  • dojox.wire.ml.ChildWire.type

    • type
      A
    • summary
      type of the value
  • dojox.wire.ml.ChildWire.converter

    • type
      A
    • summary
      class name of a converter for the value
  • dojox.wire.ml.ChildWire.attribute

    • type
      A
    • summary
      data item attribute for the value
  • dojox.wire.ml.ChildWire.path

    • type
      A
    • summary
      simplified XPath for the value
  • dojox.wire.ml.ChildWire.name

    • type
      A
    • summary
      composite property name
  • dojox.wire.ml.ChildWire._addWire

    • parameters:
      • parent: (typeof Transfer)
        A parent Transfer widget
      • args: (typeof Object)
        Wire arguments
    • summary
      Add a child Wire to Wire arguments
    • description
      If 'name' attribute is specified, a child Wire is added as
      the named property of 'children' object of 'args'.
      Otherwise, a child Wire is added to 'children' array of 'args'.
    • type
      Function
  • dojox.wire.ml.ChildWire._getWire

    • parameters:
      • parent: (typeof Transfer)
        A parent Transfer widget
    • summary
      Build child Wire arguments from attributes
    • description
      Arguments object for a child Wire are build from attributes,
      including 'object', 'property', 'type', 'converter',
      'attribute' and 'path'.
    • return_summary
      Wire arguments object
    • type
      Function
  • dojox.wire.ml.ColumnWire

    • type
      Function
    • chains:
      • dojox.wire.ml.ChildWire: (prototype)
      • dojox.wire.ml.ChildWire: (call)
    • summary
      A widget to add a column wire
    • description
      Attributes of this widget are used to add a column Wire to
      a TableAdapter of the parent Transfer widget.
  • dojox.wire.ml.ColumnWire.column

    • type
      A
    • summary
      column name
  • dojox.wire.ml.ColumnWire._addWire

    • parameters:
      • parent: (typeof Transfer)
        A parent Transfer widget
      • args: (typeof Object)
        Wire arguments
    • summary
      Add a column Wire to Wire arguments
    • description
      If 'column' attribute is specified, a column Wire is added as
      the named property of 'columns' object of 'args'.
      Otherwise, a column Wire is added to 'columns' array of 'args'.
    • type
      Function
  • dojox.wire.ml.NodeWire

    • type
      Function
    • chains:
      • dojox.wire.ml.ChildWire: (prototype)
      • dijit._Container.prototype: (prototype)
      • dojox.wire.ml.ChildWire: (call)
      • dijit._Container: (call)
    • summary
      A widget to add node wires
    • description
      Attributes of this widget are used to add node Wires to
      a TreeAdapter of the parent Transfer widget.
  • dojox.wire.ml.NodeWire.titleProperty

    • type
      A
    • summary
      property for the node title
  • dojox.wire.ml.NodeWire.titleAttribute

    • type
      A
    • summary
      data item attribute for the node title
  • dojox.wire.ml.NodeWire.titlePath

    • type
      A
    • summary
      simplified XPath for the node title
  • dojox.wire.ml.NodeWire._addWire

    • parameters:
      • parent: (typeof Transfer)
        A parent Transfer widget
      • args: (typeof Object)
        Wire arguments
    • summary
      Add node Wires to Wire arguments
    • description
      Node Wires are added to 'nodes' array of 'args'.
    • type
      Function
  • dojox.wire.ml.NodeWire._getWires

    • parameters:
      • parent: (typeof Transfer)
        A parent Transfer widget
    • returns
      Object
    • summary
      Build node Wires arguments from attributes
    • description
      Arguments object for 'node' Wire are build from attributes,
      including 'object', 'property', 'type', 'converter',
      'attribute' and 'path'.
      Arguments object for 'title' Wire are build from another set of
      attributes, 'titleProperty', 'titleAttribute' and 'titlePath'.
      If this widget has child NodeWire widgets, their _getWires()
      methods are called recursively to build 'children' array of
      'args'.
    • return_summary
      Wire arguments object
    • type
      Function
  • dojox.wire.ml.SegmentWire

    • type
      Function
    • chains:
      • dojox.wire.ml.ChildWire: (prototype)
      • dojox.wire.ml.ChildWire: (call)
    • summary
      A widget to add a segment wire
    • description
      Attributes of this widget are used to add a segment Wire to
      a TextAdapter of the parent Transfer widget.
  • dojox.wire.ml.SegmentWire._addWire

    • parameters:
      • parent: (typeof Transfer)
        A parent Transfer widget
      • args: (typeof Object)
        Wire arguments
    • summary
      Add a segument Wire to Wire arguments
    • description
      A segment Wire is added to 'segments' array of 'args'.
      If 'parent' has 'delimiter' attribute, it is used for
      'delimiter' property of 'args'.
    • type
      Function
  • dojox.wire.ml

    • type
      Object
  • dojox.wire

    • type
      Object
  • dojox

    • type
      Object