dijit/_Templated (version 1.10)

dijit/_TemplatedMixin, dijit/_WidgetsInTemplateMixin

Summary

Deprecated mixin for widgets that are instantiated from a template. Widgets should use _TemplatedMixin plus if necessary _WidgetsInTemplateMixin instead.

Usage

var foo = new _Templated();
dijit/_Templated

See the dijit/_Templated reference documentation for more information.

Property Summary

  • _attachEventsList of connections associated with data-dojo-attach-event=... in the template
  • _attachPointsList of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]
  • _earlyTemplatedStartupA fallback to preserve the 1.0 - 1.3 behavior of children in templates having their startup called before the parent widget fires postCreate.
  • _renderedNot normally use, but this flag can be set by the app if the server has already rendered the template, i.e. already inlining the template for the widget into the main page.
  • _skipNodeCache
  • attachScopeObject to which attach points and events will be scoped.
  • contextRequireUsed to provide a context require to the dojo/parser in order to be able to use relative MIDs (e.g. ./Widget) in the widget's template.
  • searchContainerNode
  • templatePathPath to template (HTML file) for this widget relative to dojo.baseUrl.
  • templateStringA string that represents the widget template.
  • widgetsInTemplateShould we parse the template to find widgets that might be declared in markup inside it?

Method Summary

  • _attach(node,type,func) Roughly corresponding to dojo/on, this is the default function for processing a data-dojo-attach-event.
  • _attachTemplateNodes(rootNode) Iterate through the dom nodes and attach functions and nodes accordingly.
  • _beforeFillContent()
  • _detachTemplateNodes() Detach and clean up the attachments made in _attachtempalteNodes.
  • _escapeValue(val) Escape a value to be inserted into the template, either into an attribute value (ex: foo="${bar}") or as inner text of an element (ex: ${foo})
  • _fillContent(source) Relocate source contents to templated container node. this.containerNode must be able to receive children, or exceptions will be thrown.
  • _processNode(baseNode,getAttrFunc)
  • _processTemplateNode(baseNode,getAttrFunc,attachFunc) Process data-dojo-attach-point and data-dojo-attach-event for given node or widget.
  • _stringRepl(tmpl) Does substitution of ${foo} type properties in template string
  • buildRendering() Construct the UI for this widget from a template, setting this.domNode.
  • destroyRendering()
  • startup()

Properties

_attachEvents
Defined by: dijit/_AttachMixin

List of connections associated with data-dojo-attach-event=... in the template

_attachPoints
Defined by: dijit/_AttachMixin

List of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]

_earlyTemplatedStartup

A fallback to preserve the 1.0 - 1.3 behavior of children in templates having their startup called before the parent widget fires postCreate. Defaults to 'false', causing child widgets to have their .startup() called immediately before a parent widget .startup(), but always after the parent .postCreate(). Set to 'true' to re-enable to previous, arguably broken, behavior.

_rendered
Defined by: dijit/_TemplatedMixin

Not normally use, but this flag can be set by the app if the server has already rendered the template, i.e. already inlining the template for the widget into the main page. Reduces _TemplatedMixin to just function like _AttachMixin.

_skipNodeCache
Defined by: dijit/_TemplatedMixin
attachScope
Defined by: dijit/_AttachMixin

Object to which attach points and events will be scoped. Defaults to 'this'.

contextRequire

Used to provide a context require to the dojo/parser in order to be able to use relative MIDs (e.g. ./Widget) in the widget's template.

searchContainerNode
Defined by: dijit/_TemplatedMixin
templatePath
Defined by: dijit/_TemplatedMixin

Path to template (HTML file) for this widget relative to dojo.baseUrl. Deprecated: use templateString with require([... "dojo/text!..."], ...) instead

templateString
Defined by: dijit/_TemplatedMixin

A string that represents the widget template. Use in conjunction with dojo.cache() to load from a file.

widgetsInTemplate
Defined by: dijit/_Templated

Should we parse the template to find widgets that might be declared in markup inside it? False by default.

Methods

_attach(node,type,func)
Defined by dijit/_AttachMixin

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
Returns:undefined
_attachTemplateNodes(rootNode)
Defined by dijit/_AttachMixin

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:

  • dojoAttachPoint/data-dojo-attach-point
  • dojoAttachEvent/data-dojo-attach-event
Parameter Type Description
rootNode DomNode

The node to search for properties. All descendants will be searched.

_beforeFillContent()
Defined by dijit/_AttachMixin
_detachTemplateNodes()
Defined by dijit/_AttachMixin

Detach and clean up the attachments made in _attachtempalteNodes.

_escapeValue(val)

Escape a value to be inserted into the template, either into an attribute value (ex: foo="${bar}") or as inner text of an element (ex: ${foo})

Parameter Type Description
val String
Returns:undefined
_fillContent(source)

Relocate source contents to templated container node. this.containerNode must be able to receive children, or exceptions will be thrown.

Parameter Type Description
source DomNode
_processNode(baseNode,getAttrFunc)
Defined by dijit/_Templated
Parameter Type Description
baseNode undefined
getAttrFunc undefined
Returns:undefined
_processTemplateNode(baseNode,getAttrFunc,attachFunc)
Defined by dijit/_AttachMixin

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.

Returns:boolean
_stringRepl(tmpl)

Does substitution of ${foo} type properties in template string

Parameter Type Description
tmpl undefined
Returns:undefined
buildRendering()

Construct the UI for this widget from a template, setting this.domNode.

destroyRendering()
Defined by dijit/_AttachMixin
startup()
Error in the documentation? Can’t find what you are looking for? Let us know!