Constructordojox.wire.ml.Transfer

dojo.require("dojox.wire.ml.Transfer");
defined in dojox/wire/ml/Transfer.js

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.

Usage

function ()
parametertypedescription
paramsObjectOptional.
srcNodeRefDomNode|String 
dijit._Container (from dojox.wire.ml.Action)

Jump to PropertiesFunctionsBack to top

FunctionaddChild(widget, insertIndex: Integer?)
Defined by dijit._Container
Process the given child widget, inserting it's dom node as a child of our dom node
Defined by dijit._Widget
Construct the UI for this widget, setting this.domNode. Most widgets will mixin TemplatedWidget, which overrides this method.
Functionconnect(obj: Object, event: String, method: String|Function)
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Functioncreate(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Kick off the life-cycle of a widget
Functiondestroy(finalize: Boolean)
Defined by dijit._Widget
Destroy this widget, but not its descendants
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Functiondisconnect(handles: Object)
Defined by dijit._Widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
Defined by dijit._Container
Returns array of children widgets
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
Defined by dijit._Container
Returns true if widget has children
Defined by dijit._Widget
Return true if this widget can currently be focused and false if not
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
Call _connect()
Defined by dijit._Widget
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
Functionpostscript(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
FunctionremoveChild(widget)
Defined by dijit._Container
Removes the passed widget instance from this widget but does not destroy it
Functionrun()
Run a task
FunctionsetAttribute(attr: String, value)
Defined by dijit._Widget
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
Defined by dijit._Widget
Called after a widget's children, and other widgets on the page, have been created. Provides an opportunity to manipulate any children before they are displayed. This is useful for composite widgets that need to control or layout sub-widgets. Many layout widgets can use this as a wiring phase.
Defined by dijit._Widget
Over-ride of base widget unitialize function to do some connection cleanup.
Connect run() method to an event or a topic
Disconnect run() method from an event or a topic
Defined by dijit._Container
Get the next or previous widget sibling of child
Function_getWire(which: String)
Build Wire arguments from attributes
Defined by dijit._Widget
Defined by dijit._Widget
Function_run()
Transfer a value from a source to a target

Jump to FunctionsPropertiesBack to top

Defined by dijit._Widget
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
Defined by dijit._Widget
HTML class attribute
class name of a converter for the value to be transferred
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
Defined by dijit._Widget
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
source object and/or property
attribute of a source data item
simplified XPath to a source property of an XML element
data store for a source data item
Defined by dijit._Widget
pointer to original dom node
Defined by dijit._Widget
HTML style attribute
target object and/or property
attribute of a target data item
simplified XPath to a target property of an XML element
data store for a target data item
Defined by dijit._Widget
event scope
event (function) name
topic name
type of the value to be transferred
Defined by dijit._Widget