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.."></tpl>
31 <tpl roo-if="a_variable or condition"></tpl>
32 <tpl roo-exec="some javascript"></tpl>
33 <tpl roo-name="named_template"></tpl>
38 Roo.DomTemplate = function()
40 Roo.DomTemplate.superclass.constructor.apply(this, arguments);
47 Roo.extend(Roo.DomTemplate, Roo.Template, {
50 * The various sub templates
55 * basic tag replacing syntax
58 * // you can fake an object call by doing this
62 re : /\{([\w-\.]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
65 iterChild : function (node, method) {
66 for( var i = 0; i < node.childNodes.length; i++) {
67 method.call(this, node.childNodes[i]);
72 * compile the template
74 * This is not recursive, so I'm not sure how nested templates are really going to be handled..
81 // covert the html into DOM...
83 var div = document.createElement('div');
84 div.innerHTML = this.html;
86 this.iterChild(div, this.compileNode)
91 compileNode : function(node) {
95 // skip anything not a tag..
96 if (node.nodeType != 1) {
102 case (node.hasAttribute('roo-for')): attr = 'for'; break;
103 case (node.hasAttribute('roo-if')): attr = 'if'; break;
104 case (node.hasAttribute('roo-if')): attr = 'name'; break;
105 case (node.hasAttribute('roo-exec')): attr = 'exec'; break;
109 // just itterate children..
110 this.iterChild(node);
114 var value = node.getAttribute('roo-' + attr);
115 node.removeAttribute('roo-'+ attr);
116 if (attr != 'name') {
117 var placeholder = document.createTextNode('{domtpl' + id + '}');
118 node.parentNode.replaceChild(placeholder, node);
120 node.parentNode.removeChild(node);
123 // parent now sees '{domtplXXXX}
124 this.iterChild(node);
126 // we should now have node body...
127 var div = document.createElement('div');
128 div.appendChild(node);
129 var html = div.innerHTML;
130 Roo.log("TEMPLATE : " + id);
139 oldwrapper : function ()
141 s = ['<tpl>', s, '</tpl>'].join('');
143 var re = /<tpl\b[^>]*>((?:(?=([^<]+))\2|<(?!tpl\b[^>]*>))*?)<\/tpl>/,
144 nameRe = /^<tpl\b[^>]*?for="(.*?)"/,
145 ifRe = /^<tpl\b[^>]*?if="(.*?)"/,
146 execRe = /^<tpl\b[^>]*?exec="(.*?)"/,
147 namedRe = /^<tpl\b[^>]*?name="(\w+)"/, // named templates..
152 while(true == !!(m = s.match(re))){
153 var forMatch = m[0].match(nameRe),
154 ifMatch = m[0].match(ifRe),
155 execMatch = m[0].match(execRe),
156 namedMatch = m[0].match(namedRe),
161 name = forMatch && forMatch[1] ? forMatch[1] : '';
164 // if - puts fn into test..
165 exp = ifMatch && ifMatch[1] ? ifMatch[1] : null;
167 fn = new Function('values', 'parent', 'with(values){ return '+(Roo.util.Format.htmlDecode(exp))+'; }');
172 // exec - calls a function... returns empty if true is returned.
173 exp = execMatch && execMatch[1] ? execMatch[1] : null;
175 exec = new Function('values', 'parent', 'with(values){ '+(Roo.util.Format.htmlDecode(exp))+'; }');
183 case '.': name = new Function('values', 'parent', 'with(values){ return values; }'); break;
184 case '..': name = new Function('values', 'parent', 'with(values){ return parent; }'); break;
185 default: name = new Function('values', 'parent', 'with(values){ return '+name+'; }');
188 var uid = namedMatch ? namedMatch[1] : id;
192 id: namedMatch ? namedMatch[1] : id,
199 s = s.replace(m[0], '');
201 s = s.replace(m[0], '{xtpl'+ id + '}');
206 for(var i = tpls.length-1; i >= 0; --i){
207 this.compileTpl(tpls[i]);
208 this.tpls[tpls[i].id] = tpls[i];
210 this.master = tpls[tpls.length-1];
214 * same as applyTemplate, except it's done to one of the subTemplates
215 * when using named templates, you can do:
217 * var str = pl.applySubTemplate('your-name', values);
220 * @param {Number} id of the template
221 * @param {Object} values to apply to template
222 * @param {Object} parent (normaly the instance of this object)
224 applySubTemplate : function(id, values, parent)
228 var t = this.tpls[id];
232 if(t.test && !t.test.call(this, values, parent)){
236 Roo.log("Xtemplate.applySubTemplate 'test': Exception thrown");
237 Roo.log(e.toString());
243 if(t.exec && t.exec.call(this, values, parent)){
247 Roo.log("Xtemplate.applySubTemplate 'exec': Exception thrown");
248 Roo.log(e.toString());
253 var vs = t.target ? t.target.call(this, values, parent) : values;
254 parent = t.target ? values : parent;
255 if(t.target && vs instanceof Array){
257 for(var i = 0, len = vs.length; i < len; i++){
258 buf[buf.length] = t.compiled.call(this, vs[i], parent);
262 return t.compiled.call(this, vs, parent);
264 Roo.log("Xtemplate.applySubTemplate : Exception thrown");
265 Roo.log(e.toString());
271 compileTpl : function(tpl)
273 var fm = Roo.util.Format;
274 var useF = this.disableFormats !== true;
275 var sep = Roo.isGecko ? "+" : ",";
276 var undef = function(str) {
277 Roo.log("Property not found :" + str);
281 var fn = function(m, name, format, args)
283 //Roo.log(arguments);
284 args = args ? args.replace(/\\'/g,"'") : args;
285 //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"]
286 if (typeof(format) == 'undefined') {
287 format= 'htmlEncode';
289 if (format == 'raw' ) {
293 if(name.substr(0, 4) == 'xtpl'){
294 return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent)'+sep+"'";
297 // build an array of options to determine if value is undefined..
299 // basically get 'xxxx.yyyy' then do
300 // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ?
301 // (function () { Roo.log("Property not found"); return ''; })() :
306 Roo.each(name.split('.'), function(st) {
307 lookfor += (lookfor.length ? '.': '') + st;
308 udef_ar.push( "(typeof(" + lookfor + ") == 'undefined')" );
311 var udef_st = '((' + udef_ar.join(" || ") +") ? undef('" + name + "') : "; // .. needs )
316 args = args ? ',' + args : "";
318 if(format.substr(0, 5) != "this."){
319 format = "fm." + format + '(';
321 format = 'this.call("'+ format.substr(5) + '", ';
325 return "'"+ sep + udef_st + format + name + args + "))"+sep+"'";
329 // called with xxyx.yuu:(test,test)
331 return "'"+ sep + udef_st + name + '(' + args + "))"+sep+"'";
333 // raw.. - :raw modifier..
334 return "'"+ sep + udef_st + name + ")"+sep+"'";
338 // branched to use + in gecko and [].join() in others
340 body = "tpl.compiled = function(values, parent){ with(values) { return '" +
341 tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
344 body = ["tpl.compiled = function(values, parent){ with (values) { return ['"];
345 body.push(tpl.body.replace(/(\r\n|\n)/g,
346 '\\n').replace(/'/g, "\\'").replace(this.re, fn));
347 body.push("'].join('');};};");
348 body = body.join('');
351 Roo.debug && Roo.log(body.replace(/\\n/,'\n'));
353 /** eval:var:tpl eval:var:fm eval:var:useF eval:var:undef */
359 applyTemplate : function(values){
360 return this.master.compiled.call(this, values, {});
365 return this.applyTemplate.apply(this, arguments);
370 Roo.XTemplate.from = function(el){
372 return new Roo.XTemplate(el.value || el.innerHTML);