API Preview tool | The Dojo Toolkit

dojox/wire/_base.js

Provides:
- dojox.wire._base
dojox.wire._defaultWireClass
- alias - dojox.wire._defaultWireClass
- type
```
String
```
dojox.wire._wireClasses
- type
```
Object
```
dojox.wire._wireClasses.attribute
- type
```
String
```
dojox.wire._wireClasses.path
- type
```
String
```
dojox.wire._wireClasses.children
- type
```
String
```
dojox.wire._wireClasses.columns
- type
```
String
```
dojox.wire._wireClasses.nodes
- type
```
String
```
dojox.wire._wireClasses.segments
- type
```
String
```

dojox.wire.register

parameters:

wireClass: (typeof Function||String)
```
A class or full qualified class name
```

key: (typeof String)

A key property of arguments to create a Wire

returns
```
undefined
```

summary

Register a Wire class
desription:
The specified Wire class or a class name is registered with
a key property of arguments to create a Wire

type
```
Function
```

dojox.wire._getClass

parameters:
- name: (typeof String)
```
A class name
```
returns
```
Function
```
summary
```
Returns a class
```

description

The class is loaded by dojo.require() and returned
by dojo.getObject().

return_summary
```
A class
```
type
```
Function
```

dojox.wire.create

parameters:
- args: (typeof Object)
```
Arguments to create a Wire
```
returns
```
Object
```
summary
```
Create a Wire from arguments
```

description

If 'args' specifies 'wireClass', it is used as a class or full
qualified class name to create a Wire with 'args' as arguments.
Otherwise, a Wire class is determined by other proeprties of 'args'
checking if 'args' specifies a key property for a Wire class.
If no key property found, the default Wire class is used.

return_summary
```
A Wire
```
type
```
Function
```

dojox.wire.isWire

parameters:
- wire: (typeof Object)
```
An object to check
```
returns
```
Boolean
```
summary
```
Check if an object is a Wire
```

description

If the specified object is a Wire, true is returned.
Otherwise, false is returned.

return_summary

True if the object is a Wire, otherwise false

type
```
Function
```

dojox.wire.transfer

parameters:

source: (typeof Wire||Object)

A Wire or arguments to create a Wire for a source value

target: (typeof Wire||Object)

A Wire or arguments to create a Wire for a target value

defaultObject: (typeof Object)

defaultTargetObject; Optional default root objects passed to Wires

defaultTargetObject: (typeof Object)

returns
```
undefined
```

summary

Transfer a source value to a target value

description

If 'source' and/or 'target' are not Wires, Wires are created with
them as arguments.
A value is got through the source Wire and set through the target
Wire.
'defaultObject' is passed to Wires as a default root object.
If 'defaultTargetObject' is specified, it is passed to the target
Wire as a default root object, instead of 'defaultObject'.

type
```
Function
```

dojox.wire.connect

parameters:

trigger: (typeof Object)
```
An event or topic to trigger a transfer
```

source: (typeof Wire||Object)

A Wire or arguments to create a Wire for a source value

target: (typeof Wire||Object)

A Wire or arguments to create a Wire for a target value

returns
```
undefined|Object
```

summary

Transfer a source value to a target value on a trigger event or
topic

description

If 'trigger' specifies 'topic', the topic is subscribed to transer
a value on the topic.
Otherwise, the event specified to 'event' of 'trigger' is listened
to transfer a value.
On the specified event or topic, transfer() is called with
'source', 'target' and the arguments of the event or topic (as
default root objects).

return_summary
```
A connection handle for disconnect()
```
type
```
Function
```

dojox.wire.disconnect

parameters:

connection: (typeof Object)

A connection handle returned by connect()

returns
```
undefined
```

summary

Remove a connection or subscription for transfer

description

If 'handle' has 'topic', the topic is unsubscribed.
Otherwise, the listener to an event is removed.

type
```
Function
```

dojox.wire._base
- type
```
Object
```
dojox.wire
- type
```
Object
```
dojox
- type
```
Object
```

dojox/wire/_base.js

Provides:

dojox.wire._defaultWireClass

dojox.wire._wireClasses

dojox.wire._wireClasses.attribute

dojox.wire._wireClasses.path

dojox.wire._wireClasses.children

dojox.wire._wireClasses.columns

dojox.wire._wireClasses.nodes

dojox.wire._wireClasses.segments

dojox.wire.register

dojox.wire._getClass

dojox.wire.create

dojox.wire.isWire

dojox.wire.transfer

dojox.wire.connect

dojox.wire.disconnect

dojox.wire._base

dojox.wire

dojox