Mixin for widgets to attach to dom nodes and setup events via convenient data-dojo-attach-point and data-dojo-attach-event DOM attributes.
Superclass of _TemplatedMixin, and can also be used standalone when templates are pre-rendered on the server.
Does not [yet] handle widgets like ContentPane with this.containerNode set. It should skip scanning for data-dojo-attach-point and data-dojo-attach-event inside this.containerNode, but it doesn't.
| Parameter | Type | Description |
|---|---|---|
| params | Object | null | Hash of initialization parameters for widget, including scalar values (like title, duration etc.) and functions, typically callbacks like onClick. The hash can contain any of the widget's properties, excluding read-only properties. |
| srcNodeRef | DOMNode | String |
Optional If a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. |
See the dijit/_AttachMixin reference documentation for more information.
List of connections associated with data-dojo-attach-event=... in the template
List of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]
Object to which attach points and events will be scoped. Defaults to 'this'.
Search descendants of this.containerNode for data-dojo-attach-point and data-dojo-attach-event. Should generally be left false (the default value) both for performance and to avoid failures when this.containerNode holds other _AttachMixin instances with their own attach points and events.
Roughly corresponding to dojo/on, this is the default function for processing a data-dojo-attach-event. Meant to attach to DOMNodes, not to widgets.
| Parameter | Type | Description |
|---|---|---|
| node | DOMNode | The node to setup a listener on. |
| type | String | Event name like "click". |
| func | undefined |
Iterate through the dom nodes and attach functions and nodes accordingly.
Map widget properties and functions to the handlers specified in the dom node and it's descendants. This function iterates over all nodes and looks for these properties:
| Parameter | Type | Description |
|---|---|---|
| rootNode | DomNode | The node to search for properties. All descendants will be searched. |
Detach and clean up the attachments made in _attachtempalteNodes.
Process data-dojo-attach-point and data-dojo-attach-event for given node or widget. Returns true if caller should process baseNode's children too.
| Parameter | Type | Description |
|---|---|---|
| baseNode | DOMNode | Widget | |
| getAttrFunc | Function | Function to get the specified property for a given DomNode/Widget. |
| attachFunc | Function |
Optional Attaches an event handler from the specified node/widget to specified function. |