API Preview tool | The Dojo Toolkit

dojox/wire/ml/Transfer.js

Provides:
- dojox.wire.ml.Transfer
Requires:
- dijit._Widget in common in project dijit
- dijit._Container in common in project dijit
- 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
- summary
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

type
```
Function
```
source: [view]
  var sourceWire = this._getWire("source");
  var targetWire = this._getWire("target");
  dojox.wire.transfer(sourceWire, targetWire, arguments);

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.

dojox.wire.ml.Transfer._getWire
- type
```
Function
```
- parameters:
  - which: (typeof String)
```
Which Wire arguments to build, &quot;source&quot; or &quot;target&quot;
```
- source: [view]
    var args = undefined;
    if(which == "source"){
     args = {
      object: this.source,
      dataStore: this.sourceStore,
      attribute: this.sourceAttribute,
      path: this.sourcePath,
      type: this.type,
      converter: this.converter
     };
    }else{ // "target"
     args = {
      object: this.target,
      dataStore: this.targetStore,
      attribute: this.targetAttribute,
      path: this.targetPath
     };
    }
    if(args.object){
     if(args.object.length >= 9 && args.object.substring(0, 9) == "arguments"){
      args.property = args.object.substring(9);
      args.object = null;
     }else{
      var i = args.object.indexOf('.');
      if(i < 0){
       args.object = dojox.wire.ml._getValue(args.object);
      }else{
       args.property = args.object.substring(i + 1);
       args.object = dojox.wire.ml._getValue(args.object.substring(0, i));
      }
     }
    }
    if(args.dataStore){
     args.dataStore = dojox.wire.ml._getValue(args.dataStore);
    }
    var childArgs = undefined;
    var children = this.getChildren();
    for(var i in children){
     var child = children[i];
     if(child instanceof dojox.wire.ml.ChildWire && child.which == which){
      if(!childArgs){
       childArgs = {};
      }
      child._addWire(this, childArgs);
     }
    }
    if(childArgs){ // make nested Wires
     childArgs.object = dojox.wire.create(args);
     childArgs.dataStore = args.dataStore;
     args = childArgs;
    }
    return args; //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
```
- returns
```
Object
```

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, &quot;source&quot; or &quot;target&quot;, default to
&quot;source&quot;

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
- type
```
Function
```
- parameters:
  - parent: (typeof Transfer)
```
A parent Transfer widget
```
  - args: (typeof Object)
```
Wire arguments
```
- source: [view]
    if(this.name){ // object
     if(!args.children){
      args.children = {};
     }
     args.children[this.name] = this._getWire(parent);
    }else{ // array
     if(!args.children){
      args.children = [];
     }
     args.children.push(this._getWire(parent));
    }
- 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'.
```
dojox.wire.ml.ChildWire._getWire
- type
```
Function
```
- parameters:
  - parent: (typeof Transfer)
```
A parent Transfer widget
```
- source: [view]
    return {
     object: (this.object ? dojox.wire.ml._getValue(this.object) : undefined),
     property: this.property,
     type: this.type,
     converter: this.converter,
     attribute: this.attribute,
     path: this.path
    }; //Object
- 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
```

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
- type
```
Function
```
- parameters:
  - parent: (typeof Transfer)
```
A parent Transfer widget
```
  - args: (typeof Object)
```
Wire arguments
```
- source: [view]
    if(this.column){ // object
     if(!args.columns){
      args.columns = {};
     }
     args.columns[this.column] = this._getWire(parent);
    }else{ // array
     if(!args.columns){
      args.columns = [];
     }
     args.columns.push(this._getWire(parent));
    }
- 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'.
```
dojox.wire.ml.NodeWire
- type
```
Function
```
- chains:
  - dojox.wire.ml.ChildWire: (prototype)
  - dojox.wire.ml.ChildWire: (call)
  - dijit._Container: (call)
- mixins:
  - dijit._Container.prototype: (prototype)
- 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
- type
```
Function
```
- parameters:
  - parent: (typeof Transfer)
```
A parent Transfer widget
```
  - args: (typeof Object)
```
Wire arguments
```
- source: [view]
    if(!args.nodes){
     args.nodes = [];
    }
    args.nodes.push(this._getWires(parent));
- summary
```
Add node Wires to Wire arguments
```
- description
```
Node Wires are added to 'nodes' array of 'args'.
```
dojox.wire.ml.NodeWire._getWires
- type
```
Function
```
- parameters:
  - parent: (typeof Transfer)
```
A parent Transfer widget
```
- source: [view]
    var args = {
     node: this._getWire(parent),
     title: {
      type: "string",
      property: this.titleProperty,
      attribute: this.titleAttribute,
      path: this.titlePath
     }
    };
    var childArgs = [];
    var children = this.getChildren();
    for(var i in children){
     var child = children[i];
     if(child instanceof dojox.wire.ml.NodeWire){
      childArgs.push(child._getWires(parent));
     }
    }
    if(childArgs.length > 0){
     args.children = childArgs;
    }
    return args; //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
```
- returns
```
Object
```

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
- type
```
Function
```
- parameters:
  - parent: (typeof Transfer)
```
A parent Transfer widget
```
  - args: (typeof Object)
```
Wire arguments
```
- source: [view]
    if(!args.segments){
     args.segments = [];
    }
    args.segments.push(this._getWire(parent));
    if(parent.delimiter && !args.delimiter){
     args.delimiter = parent.delimiter;
    }
- 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'.
```
dojox.wire.ml
- type
```
Object
```
- summary
dojox.wire
- type
```
Object
```
- summary
dojox
- type
```
Object
```
- summary

dojox/wire/ml/Transfer.js

Provides:

Requires:

dojox.wire.ml.Transfer

dojox.wire.ml.Transfer.source

dojox.wire.ml.Transfer.sourceStore

dojox.wire.ml.Transfer.sourceAttribute

dojox.wire.ml.Transfer.sourcePath

dojox.wire.ml.Transfer.type

dojox.wire.ml.Transfer.converter

dojox.wire.ml.Transfer.delimiter

dojox.wire.ml.Transfer.target

dojox.wire.ml.Transfer.targetStore

dojox.wire.ml.Transfer.targetAttribute

dojox.wire.ml.Transfer.targetPath

dojox.wire.ml.Transfer._run

dojox.wire.ml.Transfer._getWire

dojox.wire.ml.ChildWire

dojox.wire.ml.ChildWire.which

dojox.wire.ml.ChildWire.object

dojox.wire.ml.ChildWire.property

dojox.wire.ml.ChildWire.type

dojox.wire.ml.ChildWire.converter

dojox.wire.ml.ChildWire.attribute

dojox.wire.ml.ChildWire.path

dojox.wire.ml.ChildWire.name

dojox.wire.ml.ChildWire._addWire

dojox.wire.ml.ChildWire._getWire

dojox.wire.ml.ColumnWire

dojox.wire.ml.ColumnWire.column

dojox.wire.ml.ColumnWire._addWire

dojox.wire.ml.NodeWire

dojox.wire.ml.NodeWire.titleProperty

dojox.wire.ml.NodeWire.titleAttribute

dojox.wire.ml.NodeWire.titlePath

dojox.wire.ml.NodeWire._addWire

dojox.wire.ml.NodeWire._getWires

dojox.wire.ml.SegmentWire

dojox.wire.ml.SegmentWire._addWire

dojox.wire.ml

dojox.wire

dojox