dijit/registry¶
| Author: | Colin Snover |
|---|---|
| since: | 1.7.0 |
Contents
Introduction¶
dijit/registry stores a collection of all the dijit widgets within a page.
It is commonly used to retrieve a reference to a widget from a related piece of data (such as the widget’s DOM node or ID).
It contains functions formerly found on the root dijit object for looking up widgets, such as dijit.byId and dijit.byNode.
In Dojo 1.6 and earlier, the registry is an instance of dijit.WidgetSet. Starting in Dojo 1.7, it is its own object.
Starting in Dojo 1.7, the registry does not include array iterator methods by default (forEach, filter, byClass, map, every, and some).
Requiring dijit/WidgetSet will automatically re-add these methods (until Dojo 2.0).
If you need to iterate over the entire registry, it is best to call registry.toArray
and use the standard dojo array functions.
Usage¶
Retrieving a widget from the registry using a widget ID¶
registry.byId returns the widget that corresponds to the given ID.
If no such widget exists, it returns undefined.
require(["dijit/registry"], function(registry){
var widget = registry.byId("myWidgetId");
});
Retrieving a widget from the registry using the widget’s DOM node¶
registry.byNode returns the widget that corresponds to the given DOM node.
If the DOM node does not belong to a widget, it returns undefined.
require(["dijit/registry"], function(registry){
var widget = registry.byNode(domNode);
});
Finding all widgets underneath a DOM node¶
registry.findWidgets returns an array of all non-nested widgets inside the given DOM node.
require(["dojo/_base/array", "dijit/registry", "dijit/form/TextBox"], function(arrayUtil, registry, TextBox){
var formWidgets = registry.findWidgets(formNode);
});
Note that registry.findWidgets will not descend into widgets.
That is to say, if you had a DOM like this:
<div id="root" data-dojo-type="dijit.Dialog">
<form data-dojo-type="dijit.form.Form">
<input data-dojo-type="dijit.form.TextBox">
</form>
<div>
<form data-dojo-type="dijit.form.Form">
<input data-dojo-type="dijit.form.TextBox">
</form>
</div>
</div>
Calling findWidgets on the root node would only return the Form widgets, not the TextBox widgets.
Finding the nearest enclosing widget for a DOM node¶
registry.getEnclosingWidget returns the closest widget to the given DOM node.
require(["dijit/registry"], function(registry){
var parentWidget = registry.getEnclosingWidget(domNode);
});
Note that getEnclosingWidget will check for and return the widget corresponding to the given DOM node, if one exists.
For instance, given the following DOM:
<div data-dojo-type="dijit.form.Form">
<input id="myTextField" data-dojo-type="dijit.form.TextBox">
</div>
The following will return the TextBox widget, not the Form widget:
require(["dojo/dom", "dijit/registry"], function(dom, registry){
registry.getEnclosingWidget(dom.byId("myTextField")); // returns TextBox
});