dijit/_Templated.js

• Provides:

  • dijit._Templated

• Requires:

  • dijit._Widget in common
  • dojo.string in common
  • dojo.parser in common
  • dojo.cache in common

• dijit._Widget

  • type

    Function

• dijit._Widget.dojoAttachEvent

  • type

    String

• dijit._Widget.dojoAttachPoint

  • type

    String

• dijit._Widget.waiRole

  • type

    String

• dijit._Widget.waiState

  • type

    String

• dijit._Templated

  • type

    Function

  • summary

    Mixin for widgets that are instantiated from a template

• dijit._Templated.templateString

  • tags:
  • type

    String

  • summary

    A string that represents the widget template. Pre-empts the
    templatePath. In builds that have their strings "interned", the
    templatePath is converted to an inline templateString, thereby
    preventing a synchronous network call.
    
    Use in conjunction with dojo.cache() to load from a file.

• dijit._Templated.templatePath

  • tags:
  • type

    String

  • summary

    Path to template (HTML file) for this widget relative to dojo.baseUrl.
    Deprecated: use templateString with dojo.cache() instead.

• dijit._Templated.widgetsInTemplate

  • tags:
  • type

    Boolean

  • summary

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

• dijit._Templated._skipNodeCache

  • type

    bool

• dijit._Templated._earlyTemplatedStartup

  • type

    Boolean

  • summary

    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.

• dijit._Templated._attachPoints

  • tags:
  • type

    String[]

  • summary

    List of widget attribute names associated with dojoAttachPoint=... in the
    template, ex: ["containerNode", "labelNode"]

• dijit._Templated._attachEvents

  • tags:
  • type

    Handle[]

  • summary

    List of connections associated with dojoAttachEvent=... in the
    template

• dijit._Templated.constructor

  • constructor - constructor
  • type

    Function

• dijit._Templated._stringRepl

  • parameters:
    • tmpl
  • summary

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

  • tags:
  • type

    Function

• dijit._Templated.declaredClass

• dijit._Templated.buildRendering

  • summary

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

  • tags:
  • type

    Function

• dijit._Templated.domNode

• dijit._Templated._startupWidgets

  • type

    Object

• dijit._Templated._supportingWidgets

  • type

    Object

• dijit._Templated._fillContent

  • parameters:
    • source: (typeof DomNode)
  • summary

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

  • tags:
  • type

    Function

• dijit._Templated.containerNode

• dijit._Templated._attachTemplateNodes

  • parameters:
    • rootNode: (typeof DomNode|Array[Widgets])

      the node to search for properties. All children will be searched.

    • getAttrFunc: (typeof Function)

      a function which will be used to obtain property for a given
      DomNode/Widget

  • summary

    Iterate through the template and attach functions and nodes accordingly.
    Alternately, if rootNode is an array of widgets, then will process dojoAttachPoint
    etc. for those widgets.

  • description

    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
    * dojoAttachEvent
    * waiRole
    * waiState

  • tags:
  • type

    Function

• dijit._Templated.startup

  • type

    Function

• dijit._Templated.destroyRendering

  • type

    Function

• dijit._Templated._templateCache

  • alias - dijit._Templated._templateCache
  • type

    Object

• dijit._Templated.getCachedTemplate

  • parameters:
    • templatePath: (typeof String||dojo.uri.Uri)

      The URL to get the template from.

    • templateString: (typeof String)

      a string to use in lieu of fetching the template from a URL. Takes precedence
      over templatePath

    • alwaysUseString
  • returns

    String|Node

  • summary

    Static method to get a template based on the templatePath or
    templateString key

  • return_summary

    Mixed
    Either string (if there are ${} variables that need to be replaced) or just
    a DOM tree (if the node can be cloned directly)

  • type

    Function

• dijit

  • type

    Object