10 * @class Roo.DomTemplate
11 * @extends Roo.Template
12 * An effort at a dom based template engine..
14 * Similar to XTemplate, except it uses dom parsing to create the template..
21 {a_variable} - output encoded.
22 {a_variable.format:("Y-m-d")} - call a method on the variable
23 {a_variable:raw} - unencoded output
24 {a_variable:toFixed(1,2)} - Roo.util.Format."toFixed"
25 {a_variable:this.method_on_template(...)} - call a method on the template object.
30 <div roo-for="a_variable or condition.."></div>
31 <div roo-if="a_variable or condition"></div>
32 <div roo-exec="some javascript"></div>
33 <div roo-name="named_template"></div>
38 Roo.DomTemplate = function()
40 Roo.DomTemplate.superclass.constructor.apply(this, arguments);
47 Roo.extend(Roo.DomTemplate, Roo.Template, {
49 * id counter for sub templates.
53 * flag to indicate if dom parser is inside a pre,
54 * it will strip whitespace if not.
59 * The various sub templates
67 * basic tag replacing syntax
70 * // you can fake an object call by doing this
74 re : /(\{|\%7B)([\w-\.]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?(\}|\%7D)/g,
75 //re : /\{([\w-\.]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
77 iterChild : function (node, method) {
79 var oldPre = this.inPre;
80 if (node.tagName == 'PRE') {
83 for( var i = 0; i < node.childNodes.length; i++) {
84 method.call(this, node.childNodes[i]);
92 * compile the template
94 * This is not recursive, so I'm not sure how nested templates are really going to be handled..
101 // covert the html into DOM...
103 var div = document.createElement('div');
104 div.innerHTML = this.html ;
108 this.iterChild(div, function(n) {_t.compileNode(n, true); });
110 var tpls = this.tpls;
112 // create a top level template from the snippet..
114 //Roo.log(div.innerHTML);
121 body : div.innerHTML,
134 Roo.each(tpls, function(tp){
136 this.tpls[tp.id] = tp;
139 this.master = tpls[0];
145 compileNode : function(node, istop) {
150 // skip anything not a tag..
151 if (node.nodeType != 1) {
152 if (node.nodeType == 3 && !this.inPre) {
153 // reduce white space..
154 node.nodeValue = node.nodeValue.replace(/\s+/g, ' ');
177 case (node.hasAttribute('roo-for')): tpl.attr = 'for'; break;
178 case (node.hasAttribute('roo-if')): tpl.attr = 'if'; break;
179 case (node.hasAttribute('roo-name')): tpl.attr = 'name'; break;
180 case (node.hasAttribute('roo-exec')): tpl.attr = 'exec'; break;
186 // just itterate children..
187 this.iterChild(node,this.compileNode);
191 tpl.value = node.getAttribute('roo-' + tpl.attr);
192 node.removeAttribute('roo-'+ tpl.attr);
193 if (tpl.attr != 'name') {
194 var placeholder = document.createTextNode('{domtpl' + tpl.uid + '}');
195 node.parentNode.replaceChild(placeholder, node);
198 var placeholder = document.createElement('span');
199 placeholder.className = 'roo-tpl-' + tpl.value;
200 node.parentNode.replaceChild(placeholder, node);
203 // parent now sees '{domtplXXXX}
204 this.iterChild(node,this.compileNode);
206 // we should now have node body...
207 var div = document.createElement('div');
208 div.appendChild(node);
210 // this has the unfortunate side effect of converting tagged attributes
211 // eg. href="{...}" into %7C...%7D
212 // this has been fixed by searching for those combo's although it's a bit hacky..
215 tpl.body = div.innerHTML;
223 case '.': tpl.forCall = new Function('values', 'parent', 'with(values){ return values; }'); break;
224 case '..': tpl.forCall= new Function('values', 'parent', 'with(values){ return parent; }'); break;
225 default: tpl.forCall= new Function('values', 'parent', 'with(values){ return '+tpl.value+'; }');
230 tpl.execCall = new Function('values', 'parent', 'with(values){ '+(Roo.util.Format.htmlDecode(tpl.value))+'; }');
234 tpl.ifCall = new Function('values', 'parent', 'with(values){ return '+(Roo.util.Format.htmlDecode(tpl.value))+'; }');
238 tpl.id = tpl.value; // replace non characters???
254 * Compile a segment of the template into a 'sub-template'
260 compileTpl : function(tpl)
262 var fm = Roo.util.Format;
263 var useF = this.disableFormats !== true;
265 var sep = Roo.isGecko ? "+\n" : ",\n";
267 var undef = function(str) {
268 Roo.debug && Roo.log("Property not found :" + str);
276 var fn = function(m, lbrace, name, format, args)
279 //Roo.log(arguments);
280 args = args ? args.replace(/\\'/g,"'") : args;
281 //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"]
282 if (typeof(format) == 'undefined') {
283 format = 'htmlEncode';
285 if (format == 'raw' ) {
289 if(name.substr(0, 6) == 'domtpl'){
290 return "'"+ sep +'this.applySubTemplate('+name.substr(6)+', values, parent)'+sep+"'";
293 // build an array of options to determine if value is undefined..
295 // basically get 'xxxx.yyyy' then do
296 // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ?
297 // (function () { Roo.log("Property not found"); return ''; })() :
302 Roo.each(name.split('.'), function(st) {
303 lookfor += (lookfor.length ? '.': '') + st;
304 udef_ar.push( "(typeof(" + lookfor + ") == 'undefined')" );
307 var udef_st = '((' + udef_ar.join(" || ") +") ? undef('" + name + "') : "; // .. needs )
312 args = args ? ',' + args : "";
314 if(format.substr(0, 5) != "this."){
315 format = "fm." + format + '(';
317 format = 'this.call("'+ format.substr(5) + '", ';
321 return "'"+ sep + udef_st + format + name + args + "))"+sep+"'";
325 // called with xxyx.yuu:(test,test)
327 return "'"+ sep + udef_st + name + '(' + args + "))"+sep+"'";
329 // raw.. - :raw modifier..
330 return "'"+ sep + udef_st + name + ")"+sep+"'";
334 // branched to use + in gecko and [].join() in others
336 body = "tpl.compiled = function(values, parent){ with(values) { return '" +
337 tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
340 body = ["tpl.compiled = function(values, parent){ with (values) { return ['"];
341 body.push(tpl.body.replace(/(\r\n|\n)/g,
342 '\\n').replace(/'/g, "\\'").replace(this.re, fn));
343 body.push("'].join('');};};");
344 body = body.join('');
348 Roo.debug && Roo.log(body.replace(/\\n/,'\n'));
350 /** eval:var:tpl eval:var:fm eval:var:useF eval:var:undef */
357 * same as applyTemplate, except it's done to one of the subTemplates
358 * when using named templates, you can do:
360 * var str = pl.applySubTemplate('your-name', values);
363 * @param {Number} id of the template
364 * @param {Object} values to apply to template
365 * @param {Object} parent (normaly the instance of this object)
367 applySubTemplate : function(id, values, parent)
371 var t = this.tpls[id];
375 if(t.ifCall && !t.ifCall.call(this, values, parent)){
376 Roo.log('if call on ' + t.value + ' return false');
380 Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on roo-if="' + t.value + '" - ' + e.toString());
387 if(t.execCall && t.execCall.call(this, values, parent)){
391 Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on roo-for="' + t.value + '" - ' + e.toString());
397 var vs = t.forCall ? t.forCall.call(this, values, parent) : values;
398 parent = t.target ? values : parent;
399 if(t.forCall && vs instanceof Array){
401 for(var i = 0, len = vs.length; i < len; i++){
403 buf[buf.length] = t.compiled.call(this, vs[i], parent);
405 Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on body="' + t.value + '" - ' + e.toString());
407 //Roo.log(t.compiled);
414 Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on roo-for="' + t.value + '" - ' + e.toString());
419 return t.compiled.call(this, vs, parent);
421 Roo.log('Xtemplate.applySubTemplate('+ id+ '): Exception thrown on body="' + t.value + '" - ' + e.toString());
423 //Roo.log(t.compiled);
431 applyTemplate : function(values){
432 return this.master.compiled.call(this, values, {});
437 return this.applyTemplate.apply(this, arguments);
442 Roo.DomTemplate.from = function(el){
444 return new Roo.Domtemplate(el.value || el.innerHTML);