Warning: Use of undefined constant Symbol - assumed 'Symbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215 Warning: Use of undefined constant JavaScriptSymbol - assumed 'JavaScriptSymbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215

dojo/html.js

  • Provides:

    • dojo.html

  • Requires:

    • dojo.parser in common

  • dojo.html._ContentSetter

    • type
      Function
    • parameters:
      • params: (typeof Object)
      • node: (typeof String|DomNode)
    • summary
      Provides a configurable, extensible object to wrap the setting on content on a node
call the set() method to actually set the content..

  • dojo.html._ContentSetter.node

    • type
      DomNode|String
    • summary
      An node which will be the parent element that we set content into

  • dojo.html._ContentSetter.content

    • type
      String|DomNode|DomNode[]
    • summary
      The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes

  • dojo.html._ContentSetter.id

    • optional
    • type
      String
    • summary
      Usually only used internally, and auto-generated with each instance

  • dojo.html._ContentSetter.cleanContent

    • type
      Boolean
    • summary
      Should the content be treated as a full html document,
and the real content stripped of <html>, <body> wrapper before injection

  • dojo.html._ContentSetter.extractContent

    • type
      Boolean
    • summary
      Should the content be treated as a full html document, and the real content stripped of <html>, <body> wrapper before injection

  • dojo.html._ContentSetter.parseContent

    • type
      Boolean
    • summary
      Should the node by passed to the parser after the new content is set

  • dojo.html._ContentSetter.parserScope

    • alias - dojo._scopeName
    • type
      String
    • summary
      Flag passed to parser.  Root for attribute names to search for.   If scopeName is dojo,
will search for data-dojo-type (or dojoType).  For backwards compatibility
reasons defaults to dojo._scopeName (which is "dojo" except when
multi-version support is used, when it will be something like dojo16, dojo20, etc.)

  • dojo.html._ContentSetter.startup

    • type
      Boolean
    • summary
      Start the child widgets after parsing them.   Only obeyed if parseContent is true.

  • dojo.html._ContentSetter.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • params: (typeof Object)
      • node: (typeof String|DomNode)
    • summary
      Provides a configurable, extensible object to wrap the setting on content on a node
call the set() method to actually set the content..

  • dojo.html._ContentSetter.set

    • parameters:
      • cont: (typeof String|DomNode|NodeList)
        An html string, node or enumerable list of nodes for insertion into the dom
If not provided, the object's content property will be used
      • params: (typeof Object)
    • summary
      front-end to the set-content sequence
    • type
      Function

  • dojo.html._ContentSetter.setContent

    • summary
      sets the content on the node
    • type
      Function

  • dojo.html._ContentSetter.empty

    • type
      Function

  • dojo.html._ContentSetter.onBegin

    • type
      Function

  • dojo.html._ContentSetter.onEnd

    • type
      Function

  • dojo.html._ContentSetter.tearDown

    • type
      Function

  • dojo.html._ContentSetter.onContentError

    • parameters:
      • err
    • type
      Function

  • dojo.html._ContentSetter._mixin

    • parameters:
      • params
    • type
      Function

  • dojo.html._ContentSetter._parse

    • summary
      runs the dojo parser over the node contents, storing any results in this.parseResults
Any errors resulting from parsing are passed to _onError for handling
    • type
      Function

  • dojo.html._ContentSetter.parseResults

    • type
      Object

  • dojo.html._ContentSetter._onError

    • parameters:
      • type
      • err
      • consoleText
    • summary
      shows user the string that is returned by on[type]Error
overide/implement on[type]Error and return your own string to customize
    • type
      Function

  • dojo

    • alias - dojo

  • dojo.html._secureForInnerHtml

    • parameters:
      • cont: (typeof String)
        An html string for insertion into the dom
    • returns
      String
    • summary
      removes !DOCTYPE and title elements from the html string.

khtml is picky about dom faults, you can't attach a style or <title> node as child of body
must go into head, so we need to cut out those tags
    • type
      Function

  • dojo.html._emptyNode

    • parameters:
      • node: (typeof DOMNode)
        the parent element
    • summary
      removes all child nodes from the given node
    • alias - dojo.empty
    • type
      Function

  • dojo.html._setNodeContent

    • parameters:
      • node: (typeof DomNode)
        the parent element
content:
the content to be set on the parent element.
This can be an html string, a node reference or a NodeList, dojo.NodeList, Array or other enumerable list of nodes
      • cont: (typeof String|DomNode|NodeList)
    • summary
      inserts the given content into the given node
    • type
      Function

  • dojo.html.set

    • parameters:
      • node: (typeof DomNode)
        the parent element that will receive the content
      • cont: (typeof String|DomNode|NodeList)
        the content to be set on the parent element.
This can be an html string, a node reference or a NodeList, dojo.NodeList, Array or other enumerable list of nodes
      • params: (typeof Object)
        Optional flags/properties to configure the content-setting. See dojo.html._ContentSetter
    • summary
      inserts (replaces) the given content into the given node. dojo.place(cont, node, "only")
may be a better choice for simple HTML insertion.
    • description
      Unless you need to use the params capabilities of this method, you should use
dojo.place(cont, node, "only"). dojo.place() has more robust support for injecting
an HTML string into the DOM, but it only handles inserting an HTML string as DOM
elements, or inserting a DOM node. dojo.place does not handle NodeList insertions
or the other capabilities as defined by the params object for this method.
    • example
      A safe string/node/nodelist content replacement/injection with hooks for extension
Example Usage:
dojo.html.set(node, "some string");
dojo.html.set(node, contentNode, {options});
dojo.html.set(node, myNode.childNodes, {options});
    • type
      Function

  • dojo.html

    • type
      Object