API Preview tool | The Dojo Toolkit

dojo/html.js

Provides:
- dojo.html
dojo.html._ContentSetter
- type
```
Function
```
- parameters:
  - params: (typeof Object)
  - node: (typeof String|DomNode)
- source: [view]
      dojo.mixin(this, params || {});
  
      // give precedence to params.node vs. the node argument
      // and ensure its a node, not an id string
      node = this.node = dojo.byId( this.node || node );
  
      if(!this.id){
       this.id = [
        "Setter",
        (node) ? node.id || node.tagName : "",
        idCounter++
       ].join("_");
      }
- summary
```
Provides a configurable, extensible object to wrap the setting on content on a node
call the set() method to actually set the content..

the original params are mixed directly into the instance &quot;this&quot;
```

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

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 &lt;html&gt;, &lt;body&gt; 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 &lt;html&gt;, &lt;body&gt; 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

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 &quot;dojo&quot; 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.


lifecyle methods

dojo.html._ContentSetter.set
- type
```
Function
```
- 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)
- source: [view]
      if(undefined !== cont){
       this.content = cont;
      }
      // in the re-use scenario, set needs to be able to mixin new configuration
      if(params){
       this._mixin(params);
      }
  
      this.onBegin();
      this.setContent();
      this.onEnd();
  
      return this.node;
- summary
```
front-end to the set-content sequence
```
dojo.html._ContentSetter.setContent
- type
```
Function
```
- source: [view]
      var node = this.node;
      if(!node) {
       // can't proceed
       throw new Error(this.declaredClass + ": setContent given no node");
      }
      try{
       node = dojo.html._setNodeContent(node, this.content);
      }catch(e){
       // check if a domfault occurs when we are appending this.errorMessage
       // like for instance if domNode is a UL and we try append a DIV
  
       // FIXME: need to allow the user to provide a content error message string
       var errMess = this.onContentError(e);
       try{
        node.innerHTML = errMess;
       }catch(e){
        console.error('Fatal ' + this.declaredClass + '.setContent could not change content due to '+e.message, e);
       }
      }
      // always put back the node for the next method
      this.node = node; // DomNode
- summary
```
sets the content on the node
```
dojo.html._ContentSetter.empty
- type
```
Function
```
- source: [view]
 define("dojo/html", ["dojo", "dojo/parser"], function(dojo) {
 dojo.getObject("html", true, dojo);
 
 // the parser might be needed..
 (function(){ // private scope, sort of a namespace
 
 // idCounter is incremented with each instantiation to allow asignment of a unique id for tracking, logging purposes
 var idCounter = 0,
 d = dojo;
 
 dojo.html._secureForInnerHtml = function(/*String*/ cont){
 // summary:
 // removes !DOCTYPE and title elements from the html string.
 //
 // khtml is picky about dom faults, you can't attach a style or node as child of body // must go into head, so we need to cut out those tags // cont: // An html string for insertion into the dom // return cont.replace(/(?:\s*<!DOCTYPE\s[^>]+>|<title[^>]*>[\s\S]*?<\/title>)/ig, ""); // String }; /*==== dojo.html._emptyNode = function(node){ // summary: // removes all child nodes from the given node // node: DOMNode // the parent element }; =====*/ dojo.html._emptyNode = dojo.empty; dojo.html._setNodeContent = function(/* DomNode */ node, /* String|DomNode|NodeList */ cont){ // summary: // inserts the given content into the given node // node: // 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 // always empty d.empty(node); if(cont) { if(typeof cont == "string") { cont = d._toDom(cont, node.ownerDocument); } if(!cont.nodeType && d.isArrayLike(cont)) { // handle as enumerable, but it may shrink as we enumerate it for(var startlen=cont.length, i=0; i<cont.length; i=startlen==cont.length ? i+1 : 0) { d.place( cont[i], node, "last"); } } else { // pass nodes, documentFragments and unknowns through to dojo.place d.place(cont, node, "last"); } } // return DomNode return node; }; // we wrap up the content-setting operation in a object dojo.declare("dojo.html._ContentSetter", null, { // node: DomNode|String // An node which will be the parent element that we set content into node: "", // content: String|DomNode|DomNode[] // The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes content: "", // id: String? // Usually only used internally, and auto-generated with each instance id: "", // cleanContent: Boolean // Should the content be treated as a full html document, // and the real content stripped of <html>, <body> wrapper before injection cleanContent: false, // extractContent: Boolean // Should the content be treated as a full html document, and the real content stripped of <html>, <body> wrapper before injection extractContent: false, // parseContent: Boolean // Should the node by passed to the parser after the new content is set parseContent: false, // parserScope: String // 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.) parserScope: dojo._scopeName, // startup: Boolean // Start the child widgets after parsing them. Only obeyed if parseContent is true. startup: true, // lifecyle methods constructor: function(/* Object */params, /* String|DomNode */node){ // summary: // Provides a configurable, extensible object to wrap the setting on content on a node // call the set() method to actually set the content.. // the original params are mixed directly into the instance "this" dojo.mixin(this, params || {}); // give precedence to params.node vs. the node argument // and ensure its a node, not an id string node = this.node = dojo.byId( this.node || node ); if(!this.id){ this.id = [ "Setter", (node) ? node.id || node.tagName : "", idCounter++ ].join("_"); } }, set: function(/* String|DomNode|NodeList? */ cont, /* Object? */ params){ // summary: // front-end to the set-content sequence // cont: // 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 if(undefined !== cont){ this.content = cont; } // in the re-use scenario, set needs to be able to mixin new configuration if(params){ this._mixin(params); } this.onBegin(); this.setContent(); this.onEnd(); return this.node; }, setContent: function(){ // summary: // sets the content on the node var node = this.node; if(!node) { // can't proceed throw new Error(this.declaredClass + ": setContent given no node"); } try{ node = dojo.html._setNodeContent(node, this.content); }catch(e){ // check if a domfault occurs when we are appending this.errorMessage // like for instance if domNode is a UL and we try append a DIV // FIXME: need to allow the user to provide a content error message string var errMess = this.onContentError(e); try{ node.innerHTML = errMess; }catch(e){ console.error('Fatal ' + this.declaredClass + '.setContent could not change content due to '+e.message, e); } } // always put back the node for the next method this.node = node; // DomNode }, empty: function() { // summary // cleanly empty out existing content // destroy any widgets from a previous run // NOTE: if you dont want this you'll need to empty // the parseResults array property yourself to avoid bad things happenning if(this.parseResults && this.parseResults.length) { dojo.forEach(this.parseResults, function(w) { if(w.destroy){ w.destroy(); } }); delete this.parseResults; } // this is fast, but if you know its already empty or safe, you could // override empty to skip this step dojo.html._emptyNode(this.node); </div> <li>returns<div><pre>String</pre></div></li><li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._ContentSetter.onBegin</h4><ul> <li>type<div><pre>Function</pre></div></li><li class="source">source: [<a onclick="tgShow('unique5');">view</a>] <div class="nosho" id="unique5"> define("dojo/html", ["dojo", "dojo/parser"], function(dojo) { dojo.getObject("html", true, dojo); // the parser might be needed.. (function(){ // private scope, sort of a namespace // idCounter is incremented with each instantiation to allow asignment of a unique id for tracking, logging purposes var idCounter = 0, d = dojo; dojo.html._secureForInnerHtml = function(/*String*/ cont){ // 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 // cont: // An html string for insertion into the dom // return cont.replace(/(?:\s*<!DOCTYPE\s[^>]+>|<title[^>]*>[\s\S]*?<\/title>)/ig, ""); // String }; /*==== dojo.html._emptyNode = function(node){ // summary: // removes all child nodes from the given node // node: DOMNode // the parent element }; =====*/ dojo.html._emptyNode = dojo.empty; dojo.html._setNodeContent = function(/* DomNode */ node, /* String|DomNode|NodeList */ cont){ // summary: // inserts the given content into the given node // node: // 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 // always empty d.empty(node); if(cont) { if(typeof cont == "string") { cont = d._toDom(cont, node.ownerDocument); } if(!cont.nodeType && d.isArrayLike(cont)) { // handle as enumerable, but it may shrink as we enumerate it for(var startlen=cont.length, i=0; i<cont.length; i=startlen==cont.length ? i+1 : 0) { d.place( cont[i], node, "last"); } } else { // pass nodes, documentFragments and unknowns through to dojo.place d.place(cont, node, "last"); } } // return DomNode return node; }; // we wrap up the content-setting operation in a object dojo.declare("dojo.html._ContentSetter", null, { // node: DomNode|String // An node which will be the parent element that we set content into node: "", // content: String|DomNode|DomNode[] // The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes content: "", // id: String? // Usually only used internally, and auto-generated with each instance id: "", // cleanContent: Boolean // Should the content be treated as a full html document, // and the real content stripped of <html>, <body> wrapper before injection cleanContent: false, // extractContent: Boolean // Should the content be treated as a full html document, and the real content stripped of <html>, <body> wrapper before injection extractContent: false, // parseContent: Boolean // Should the node by passed to the parser after the new content is set parseContent: false, // parserScope: String // 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.) parserScope: dojo._scopeName, // startup: Boolean // Start the child widgets after parsing them. Only obeyed if parseContent is true. startup: true, // lifecyle methods constructor: function(/* Object */params, /* String|DomNode */node){ // summary: // Provides a configurable, extensible object to wrap the setting on content on a node // call the set() method to actually set the content.. // the original params are mixed directly into the instance "this" dojo.mixin(this, params || {}); // give precedence to params.node vs. the node argument // and ensure its a node, not an id string node = this.node = dojo.byId( this.node || node ); if(!this.id){ this.id = [ "Setter", (node) ? node.id || node.tagName : "", idCounter++ ].join("_"); } }, set: function(/* String|DomNode|NodeList? */ cont, /* Object? */ params){ // summary: // front-end to the set-content sequence // cont: // 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 if(undefined !== cont){ this.content = cont; } // in the re-use scenario, set needs to be able to mixin new configuration if(params){ this._mixin(params); } this.onBegin(); this.setContent(); this.onEnd(); return this.node; }, setContent: function(){ // summary: // sets the content on the node var node = this.node; if(!node) { // can't proceed throw new Error(this.declaredClass + ": setContent given no node"); } try{ node = dojo.html._setNodeContent(node, this.content); }catch(e){ // check if a domfault occurs when we are appending this.errorMessage // like for instance if domNode is a UL and we try append a DIV // FIXME: need to allow the user to provide a content error message string var errMess = this.onContentError(e); try{ node.innerHTML = errMess; }catch(e){ console.error('Fatal ' + this.declaredClass + '.setContent could not change content due to '+e.message, e); } } // always put back the node for the next method this.node = node; // DomNode }, empty: function() { // summary // cleanly empty out existing content // destroy any widgets from a previous run // NOTE: if you dont want this you'll need to empty // the parseResults array property yourself to avoid bad things happenning if(this.parseResults && this.parseResults.length) { dojo.forEach(this.parseResults, function(w) { if(w.destroy){ w.destroy(); } }); delete this.parseResults; } // this is fast, but if you know its already empty or safe, you could // override empty to skip this step dojo.html._emptyNode(this.node); }, onBegin: function(){ // summary // Called after instantiation, but before set(); // It allows modification of any of the object properties // - including the node and content provided - before the set operation actually takes place // This default implementation checks for cleanContent and extractContent flags to // optionally pre-process html string content var cont = this.content; if(dojo.isString(cont)){ if(this.cleanContent){ cont = dojo.html._secureForInnerHtml(cont); } if(this.extractContent){ var match = cont.match(/<body[^>]*>\s*([\s\S]+)\s*<\/body>/im); if(match){ cont = match[1]; } } } // clean out the node and any cruft associated with it - like widgets this.empty(); this.content = cont; return this.node; /* DomNode */ </div> <li>returns<div><pre>String|DomNode</pre></div></li><li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._ContentSetter.onEnd</h4><ul> <li>type<div><pre>Function</pre></div></li><li class="source">source: [<a onclick="tgShow('unique6');">view</a>] <div class="nosho" id="unique6"> define("dojo/html", ["dojo", "dojo/parser"], function(dojo) { dojo.getObject("html", true, dojo); // the parser might be needed.. (function(){ // private scope, sort of a namespace // idCounter is incremented with each instantiation to allow asignment of a unique id for tracking, logging purposes var idCounter = 0, d = dojo; dojo.html._secureForInnerHtml = function(/*String*/ cont){ // 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 // cont: // An html string for insertion into the dom // return cont.replace(/(?:\s*<!DOCTYPE\s[^>]+>|<title[^>]*>[\s\S]*?<\/title>)/ig, ""); // String }; /*==== dojo.html._emptyNode = function(node){ // summary: // removes all child nodes from the given node // node: DOMNode // the parent element }; =====*/ dojo.html._emptyNode = dojo.empty; dojo.html._setNodeContent = function(/* DomNode */ node, /* String|DomNode|NodeList */ cont){ // summary: // inserts the given content into the given node // node: // 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 // always empty d.empty(node); if(cont) { if(typeof cont == "string") { cont = d._toDom(cont, node.ownerDocument); } if(!cont.nodeType && d.isArrayLike(cont)) { // handle as enumerable, but it may shrink as we enumerate it for(var startlen=cont.length, i=0; i<cont.length; i=startlen==cont.length ? i+1 : 0) { d.place( cont[i], node, "last"); } } else { // pass nodes, documentFragments and unknowns through to dojo.place d.place(cont, node, "last"); } } // return DomNode return node; }; // we wrap up the content-setting operation in a object dojo.declare("dojo.html._ContentSetter", null, { // node: DomNode|String // An node which will be the parent element that we set content into node: "", // content: String|DomNode|DomNode[] // The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes content: "", // id: String? // Usually only used internally, and auto-generated with each instance id: "", // cleanContent: Boolean // Should the content be treated as a full html document, // and the real content stripped of <html>, <body> wrapper before injection cleanContent: false, // extractContent: Boolean // Should the content be treated as a full html document, and the real content stripped of <html>, <body> wrapper before injection extractContent: false, // parseContent: Boolean // Should the node by passed to the parser after the new content is set parseContent: false, // parserScope: String // 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.) parserScope: dojo._scopeName, // startup: Boolean // Start the child widgets after parsing them. Only obeyed if parseContent is true. startup: true, // lifecyle methods constructor: function(/* Object */params, /* String|DomNode */node){ // summary: // Provides a configurable, extensible object to wrap the setting on content on a node // call the set() method to actually set the content.. // the original params are mixed directly into the instance "this" dojo.mixin(this, params || {}); // give precedence to params.node vs. the node argument // and ensure its a node, not an id string node = this.node = dojo.byId( this.node || node ); if(!this.id){ this.id = [ "Setter", (node) ? node.id || node.tagName : "", idCounter++ ].join("_"); } }, set: function(/* String|DomNode|NodeList? */ cont, /* Object? */ params){ // summary: // front-end to the set-content sequence // cont: // 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 if(undefined !== cont){ this.content = cont; } // in the re-use scenario, set needs to be able to mixin new configuration if(params){ this._mixin(params); } this.onBegin(); this.setContent(); this.onEnd(); return this.node; }, setContent: function(){ // summary: // sets the content on the node var node = this.node; if(!node) { // can't proceed throw new Error(this.declaredClass + ": setContent given no node"); } try{ node = dojo.html._setNodeContent(node, this.content); }catch(e){ // check if a domfault occurs when we are appending this.errorMessage // like for instance if domNode is a UL and we try append a DIV // FIXME: need to allow the user to provide a content error message string var errMess = this.onContentError(e); try{ node.innerHTML = errMess; }catch(e){ console.error('Fatal ' + this.declaredClass + '.setContent could not change content due to '+e.message, e); } } // always put back the node for the next method this.node = node; // DomNode }, empty: function() { // summary // cleanly empty out existing content // destroy any widgets from a previous run // NOTE: if you dont want this you'll need to empty // the parseResults array property yourself to avoid bad things happenning if(this.parseResults && this.parseResults.length) { dojo.forEach(this.parseResults, function(w) { if(w.destroy){ w.destroy(); } }); delete this.parseResults; } // this is fast, but if you know its already empty or safe, you could // override empty to skip this step dojo.html._emptyNode(this.node); }, onBegin: function(){ // summary // Called after instantiation, but before set(); // It allows modification of any of the object properties // - including the node and content provided - before the set operation actually takes place // This default implementation checks for cleanContent and extractContent flags to // optionally pre-process html string content var cont = this.content; if(dojo.isString(cont)){ if(this.cleanContent){ cont = dojo.html._secureForInnerHtml(cont); } if(this.extractContent){ var match = cont.match(/<body[^>]*>\s*([\s\S]+)\s*<\/body>/im); if(match){ cont = match[1]; } } } // clean out the node and any cruft associated with it - like widgets this.empty(); this.content = cont; return this.node; /* DomNode */ }, onEnd: function(){ // summary // Called after set(), when the new content has been pushed into the node // It provides an opportunity for post-processing before handing back the node to the caller // This default implementation checks a parseContent flag to optionally run the dojo parser over the new content if(this.parseContent){ // populates this.parseResults if you need those.. this._parse(); } return this.node; /* DomNode */ </div> <li>returns<div><pre>String|DomNode</pre></div></li><li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._ContentSetter.tearDown</h4><ul> <li>type<div><pre>Function</pre></div></li><li class="source">source: [<a onclick="tgShow('unique7');">view</a>] <div class="nosho" id="unique7"> define("dojo/html", ["dojo", "dojo/parser"], function(dojo) { dojo.getObject("html", true, dojo); // the parser might be needed.. (function(){ // private scope, sort of a namespace // idCounter is incremented with each instantiation to allow asignment of a unique id for tracking, logging purposes var idCounter = 0, d = dojo; dojo.html._secureForInnerHtml = function(/*String*/ cont){ // 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 // cont: // An html string for insertion into the dom // return cont.replace(/(?:\s*<!DOCTYPE\s[^>]+>|<title[^>]*>[\s\S]*?<\/title>)/ig, ""); // String }; /*==== dojo.html._emptyNode = function(node){ // summary: // removes all child nodes from the given node // node: DOMNode // the parent element }; =====*/ dojo.html._emptyNode = dojo.empty; dojo.html._setNodeContent = function(/* DomNode */ node, /* String|DomNode|NodeList */ cont){ // summary: // inserts the given content into the given node // node: // 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 // always empty d.empty(node); if(cont) { if(typeof cont == "string") { cont = d._toDom(cont, node.ownerDocument); } if(!cont.nodeType && d.isArrayLike(cont)) { // handle as enumerable, but it may shrink as we enumerate it for(var startlen=cont.length, i=0; i<cont.length; i=startlen==cont.length ? i+1 : 0) { d.place( cont[i], node, "last"); } } else { // pass nodes, documentFragments and unknowns through to dojo.place d.place(cont, node, "last"); } } // return DomNode return node; }; // we wrap up the content-setting operation in a object dojo.declare("dojo.html._ContentSetter", null, { // node: DomNode|String // An node which will be the parent element that we set content into node: "", // content: String|DomNode|DomNode[] // The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes content: "", // id: String? // Usually only used internally, and auto-generated with each instance id: "", // cleanContent: Boolean // Should the content be treated as a full html document, // and the real content stripped of <html>, <body> wrapper before injection cleanContent: false, // extractContent: Boolean // Should the content be treated as a full html document, and the real content stripped of <html>, <body> wrapper before injection extractContent: false, // parseContent: Boolean // Should the node by passed to the parser after the new content is set parseContent: false, // parserScope: String // 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.) parserScope: dojo._scopeName, // startup: Boolean // Start the child widgets after parsing them. Only obeyed if parseContent is true. startup: true, // lifecyle methods constructor: function(/* Object */params, /* String|DomNode */node){ // summary: // Provides a configurable, extensible object to wrap the setting on content on a node // call the set() method to actually set the content.. // the original params are mixed directly into the instance "this" dojo.mixin(this, params || {}); // give precedence to params.node vs. the node argument // and ensure its a node, not an id string node = this.node = dojo.byId( this.node || node ); if(!this.id){ this.id = [ "Setter", (node) ? node.id || node.tagName : "", idCounter++ ].join("_"); } }, set: function(/* String|DomNode|NodeList? */ cont, /* Object? */ params){ // summary: // front-end to the set-content sequence // cont: // 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 if(undefined !== cont){ this.content = cont; } // in the re-use scenario, set needs to be able to mixin new configuration if(params){ this._mixin(params); } this.onBegin(); this.setContent(); this.onEnd(); return this.node; }, setContent: function(){ // summary: // sets the content on the node var node = this.node; if(!node) { // can't proceed throw new Error(this.declaredClass + ": setContent given no node"); } try{ node = dojo.html._setNodeContent(node, this.content); }catch(e){ // check if a domfault occurs when we are appending this.errorMessage // like for instance if domNode is a UL and we try append a DIV // FIXME: need to allow the user to provide a content error message string var errMess = this.onContentError(e); try{ node.innerHTML = errMess; }catch(e){ console.error('Fatal ' + this.declaredClass + '.setContent could not change content due to '+e.message, e); } } // always put back the node for the next method this.node = node; // DomNode }, empty: function() { // summary // cleanly empty out existing content // destroy any widgets from a previous run // NOTE: if you dont want this you'll need to empty // the parseResults array property yourself to avoid bad things happenning if(this.parseResults && this.parseResults.length) { dojo.forEach(this.parseResults, function(w) { if(w.destroy){ w.destroy(); } }); delete this.parseResults; } // this is fast, but if you know its already empty or safe, you could // override empty to skip this step dojo.html._emptyNode(this.node); }, onBegin: function(){ // summary // Called after instantiation, but before set(); // It allows modification of any of the object properties // - including the node and content provided - before the set operation actually takes place // This default implementation checks for cleanContent and extractContent flags to // optionally pre-process html string content var cont = this.content; if(dojo.isString(cont)){ if(this.cleanContent){ cont = dojo.html._secureForInnerHtml(cont); } if(this.extractContent){ var match = cont.match(/<body[^>]*>\s*([\s\S]+)\s*<\/body>/im); if(match){ cont = match[1]; } } } // clean out the node and any cruft associated with it - like widgets this.empty(); this.content = cont; return this.node; /* DomNode */ }, onEnd: function(){ // summary // Called after set(), when the new content has been pushed into the node // It provides an opportunity for post-processing before handing back the node to the caller // This default implementation checks a parseContent flag to optionally run the dojo parser over the new content if(this.parseContent){ // populates this.parseResults if you need those.. this._parse(); } return this.node; /* DomNode */ }, tearDown: function(){ // summary // manually reset the Setter instance if its being re-used for example for another set() // description // tearDown() is not called automatically. // In normal use, the Setter instance properties are simply allowed to fall out of scope // but the tearDown method can be called to explicitly reset this instance. delete this.parseResults; delete this.node; delete this.content; </div> <li>returns<div><pre>String|DomNode</pre></div></li><li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._ContentSetter.onContentError</h4><ul> <li>type<div><pre>Function</pre></div></li><li>parameters: <ul><li>err: (typeof )<div></div></li></ul></li><li class="source">source: [<a onclick="tgShow('unique8');">view</a>] <div class="nosho" id="unique8"> return "Error occured setting content: " + err; </div> <li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._ContentSetter._mixin</h4><ul> <li>type<div><pre>Function</pre></div></li><li>parameters: <ul><li>params: (typeof )<div></div></li></ul></li><li class="source">source: [<a onclick="tgShow('unique9');">view</a>] <div class="nosho" id="unique9"> define("dojo/html", ["dojo", "dojo/parser"], function(dojo) { dojo.getObject("html", true, dojo); // the parser might be needed.. (function(){ // private scope, sort of a namespace // idCounter is incremented with each instantiation to allow asignment of a unique id for tracking, logging purposes var idCounter = 0, d = dojo; dojo.html._secureForInnerHtml = function(/*String*/ cont){ // 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 // cont: // An html string for insertion into the dom // return cont.replace(/(?:\s*<!DOCTYPE\s[^>]+>|<title[^>]*>[\s\S]*?<\/title>)/ig, ""); // String }; /*==== dojo.html._emptyNode = function(node){ // summary: // removes all child nodes from the given node // node: DOMNode // the parent element }; =====*/ dojo.html._emptyNode = dojo.empty; dojo.html._setNodeContent = function(/* DomNode */ node, /* String|DomNode|NodeList */ cont){ // summary: // inserts the given content into the given node // node: // 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 // always empty d.empty(node); if(cont) { if(typeof cont == "string") { cont = d._toDom(cont, node.ownerDocument); } if(!cont.nodeType && d.isArrayLike(cont)) { // handle as enumerable, but it may shrink as we enumerate it for(var startlen=cont.length, i=0; i<cont.length; i=startlen==cont.length ? i+1 : 0) { d.place( cont[i], node, "last"); } } else { // pass nodes, documentFragments and unknowns through to dojo.place d.place(cont, node, "last"); } } // return DomNode return node; }; // we wrap up the content-setting operation in a object dojo.declare("dojo.html._ContentSetter", null, { // node: DomNode|String // An node which will be the parent element that we set content into node: "", // content: String|DomNode|DomNode[] // The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes content: "", // id: String? // Usually only used internally, and auto-generated with each instance id: "", // cleanContent: Boolean // Should the content be treated as a full html document, // and the real content stripped of <html>, <body> wrapper before injection cleanContent: false, // extractContent: Boolean // Should the content be treated as a full html document, and the real content stripped of <html>, <body> wrapper before injection extractContent: false, // parseContent: Boolean // Should the node by passed to the parser after the new content is set parseContent: false, // parserScope: String // 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.) parserScope: dojo._scopeName, // startup: Boolean // Start the child widgets after parsing them. Only obeyed if parseContent is true. startup: true, // lifecyle methods constructor: function(/* Object */params, /* String|DomNode */node){ // summary: // Provides a configurable, extensible object to wrap the setting on content on a node // call the set() method to actually set the content.. // the original params are mixed directly into the instance "this" dojo.mixin(this, params || {}); // give precedence to params.node vs. the node argument // and ensure its a node, not an id string node = this.node = dojo.byId( this.node || node ); if(!this.id){ this.id = [ "Setter", (node) ? node.id || node.tagName : "", idCounter++ ].join("_"); } }, set: function(/* String|DomNode|NodeList? */ cont, /* Object? */ params){ // summary: // front-end to the set-content sequence // cont: // 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 if(undefined !== cont){ this.content = cont; } // in the re-use scenario, set needs to be able to mixin new configuration if(params){ this._mixin(params); } this.onBegin(); this.setContent(); this.onEnd(); return this.node; }, setContent: function(){ // summary: // sets the content on the node var node = this.node; if(!node) { // can't proceed throw new Error(this.declaredClass + ": setContent given no node"); } try{ node = dojo.html._setNodeContent(node, this.content); }catch(e){ // check if a domfault occurs when we are appending this.errorMessage // like for instance if domNode is a UL and we try append a DIV // FIXME: need to allow the user to provide a content error message string var errMess = this.onContentError(e); try{ node.innerHTML = errMess; }catch(e){ console.error('Fatal ' + this.declaredClass + '.setContent could not change content due to '+e.message, e); } } // always put back the node for the next method this.node = node; // DomNode }, empty: function() { // summary // cleanly empty out existing content // destroy any widgets from a previous run // NOTE: if you dont want this you'll need to empty // the parseResults array property yourself to avoid bad things happenning if(this.parseResults && this.parseResults.length) { dojo.forEach(this.parseResults, function(w) { if(w.destroy){ w.destroy(); } }); delete this.parseResults; } // this is fast, but if you know its already empty or safe, you could // override empty to skip this step dojo.html._emptyNode(this.node); }, onBegin: function(){ // summary // Called after instantiation, but before set(); // It allows modification of any of the object properties // - including the node and content provided - before the set operation actually takes place // This default implementation checks for cleanContent and extractContent flags to // optionally pre-process html string content var cont = this.content; if(dojo.isString(cont)){ if(this.cleanContent){ cont = dojo.html._secureForInnerHtml(cont); } if(this.extractContent){ var match = cont.match(/<body[^>]*>\s*([\s\S]+)\s*<\/body>/im); if(match){ cont = match[1]; } } } // clean out the node and any cruft associated with it - like widgets this.empty(); this.content = cont; return this.node; /* DomNode */ }, onEnd: function(){ // summary // Called after set(), when the new content has been pushed into the node // It provides an opportunity for post-processing before handing back the node to the caller // This default implementation checks a parseContent flag to optionally run the dojo parser over the new content if(this.parseContent){ // populates this.parseResults if you need those.. this._parse(); } return this.node; /* DomNode */ }, tearDown: function(){ // summary // manually reset the Setter instance if its being re-used for example for another set() // description // tearDown() is not called automatically. // In normal use, the Setter instance properties are simply allowed to fall out of scope // but the tearDown method can be called to explicitly reset this instance. delete this.parseResults; delete this.node; delete this.content; }, onContentError: function(err){ return "Error occured setting content: " + err; }, _mixin: function(params){ // mix properties/methods into the instance // TODO: the intention with tearDown is to put the Setter's state // back to that of the original constructor (vs. deleting/resetting everything regardless of ctor params) // so we could do something here to move the original properties aside for later restoration var empty = {}, key; for(key in params){ if(key in empty){ continue; } // TODO: here's our opportunity to mask the properties we dont consider configurable/overridable // .. but history shows we'll almost always guess wrong this[key] = params[key]; } </div> <li>returns<div><pre>String|DomNode</pre></div></li><li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._ContentSetter._parse</h4><ul> <li>type<div><pre>Function</pre></div></li><li class="source">source: [<a onclick="tgShow('unique10');">view</a>] <div class="nosho" id="unique10"> var rootNode = this.node; try{ // store the results (widgets, whatever) for potential retrieval var inherited = {}; dojo.forEach(["dir", "lang", "textDir"], function(name){ if(this[name]){ inherited[name] = this[name]; } }, this); this.parseResults = dojo.parser.parse({ rootNode: rootNode, noStart: !this.startup, inherited: inherited, scope: this.parserScope }); }catch(e){ this._onError('Content', e, "Error parsing in _ContentSetter#"+this.id); } </div> <li>summary<div><pre>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</pre></div></li></ul></li><li><h4>dojo.html._ContentSetter._onError</h4><ul> <li>type<div><pre>Function</pre></div></li><li>parameters: <ul><li>type: (typeof )<div></div></li><li>err: (typeof )<div></div></li><li>consoleText: (typeof )<div></div></li></ul></li><li class="source">source: [<a onclick="tgShow('unique11');">view</a>] <div class="nosho" id="unique11"> var errText = this['on' + type + 'Error'].call(this, err); if(consoleText){ console.error(consoleText, err); }else if(errText){ // a empty string won't change current content dojo.html._setNodeContent(this.node, errText, true); } </div> <li>summary<div><pre>shows user the string that is returned by on[type]Error overide/implement on[type]Error and return your own string to customize</pre></div></li></ul></li><li><h4>dojo.html._ContentSetter.parseResults</h4><ul> <li>summary<div><pre></pre></div></li></ul></li><li><h4>d</h4><ul> <li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._emptyNode</h4><ul> <li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html._secureForInnerHtml</h4><ul> <li>type<div><pre>Function</pre></div></li><li>parameters: <ul><li>cont: (typeof String)<div><pre>An html string for insertion into the dom</pre></div></li></ul></li><li class="source">source: [<a onclick="tgShow('unique12');">view</a>] <div class="nosho" id="unique12"> return cont.replace(/(?:\s*<!DOCTYPE\s[^>]+>|<title[^>]*>[\s\S]*?<\/title>)/ig, ""); // String </div> <li>summary<div><pre>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</pre></div></li><li>returns<div><pre>String</pre></div></li></ul></li><li><h4>dojo.html._setNodeContent</h4><ul> <li>type<div><pre>Function</pre></div></li><li>parameters: <ul><li>node: (typeof DomNode)<div><pre>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 always empty</pre></div></li><li>cont: (typeof String|DomNode|NodeList)<div></div></li></ul></li><li class="source">source: [<a onclick="tgShow('unique13');">view</a>] <div class="nosho" id="unique13"> d.empty(node); if(cont) { if(typeof cont == "string") { cont = d._toDom(cont, node.ownerDocument); } if(!cont.nodeType && d.isArrayLike(cont)) { // handle as enumerable, but it may shrink as we enumerate it for(var startlen=cont.length, i=0; i<cont.length; i=startlen==cont.length ? i+1 : 0) { d.place( cont[i], node, "last"); } } else { // pass nodes, documentFragments and unknowns through to dojo.place d.place(cont, node, "last"); } } // return DomNode return node; </div> <li>summary<div><pre>inserts the given content into the given node</pre></div></li></ul></li><li><h4>dojo.html.set</h4><ul> <li>type<div><pre>Function</pre></div></li><li>parameters: <ul><li>node: (typeof DomNode)<div><pre>the parent element that will receive the content</pre></div></li><li>cont: (typeof String|DomNode|NodeList)<div><pre>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</pre></div></li><li>params: (typeof Object)<div><pre>Optional flags/properties to configure the content-setting. See dojo.html._ContentSetter</pre></div></li></ul></li><li class="source">source: [<a onclick="tgShow('unique14');">view</a>] <div class="nosho" id="unique14"> if(undefined == cont){ console.warn("dojo.html.set: no cont argument provided, using empty string"); cont = ""; } if(!params){ // simple and fast return dojo.html._setNodeContent(node, cont, true); }else{ // more options but slower // note the arguments are reversed in order, to match the convention for instantiation via the parser var op = new dojo.html._ContentSetter(dojo.mixin( params, { content: cont, node: node } )); return op.set(); } </div> <li>summary<div><pre>inserts (replaces) the given content into the given node. dojo.place(cont, node, "only") may be a better choice for simple HTML insertion.</pre></div></li><li>description<div><pre>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.</pre></div></li><li>example<div><pre>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});</pre></div></li></ul></li><li><h4>params.content</h4><ul> <li>summary<div><pre></pre></div></li></ul></li><li><h4>params.node</h4><ul> <li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo.html</h4><ul> <li>type<div><pre>Object</pre></div></li><li>summary<div><pre></pre></div></li></ul></li><li><h4>dojo</h4><ul> <li>type<div><pre>Object</pre></div></li><li>summary<div><pre></pre></div></li></ul></li></ul></div> </div> </div> </div> </body> </html>

dojo/html.js

Provides:

dojo.html._ContentSetter

dojo.html._ContentSetter.node

dojo.html._ContentSetter.content

dojo.html._ContentSetter.id

dojo.html._ContentSetter.cleanContent

dojo.html._ContentSetter.extractContent

dojo.html._ContentSetter.parseContent

dojo.html._ContentSetter.parserScope

dojo.html._ContentSetter.startup

dojo.html._ContentSetter.set

dojo.html._ContentSetter.setContent

dojo.html._ContentSetter.empty