git.roojs.org Git - roojs1/blob - Roo/XTemplate.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12
  13 /**
  14  * @class Roo.XTemplate
  15  * @extends Roo.Template
  16  * Provides a template that can have nested templates for loops or conditionals. The syntax is:
  17 <pre><code>
  18 var t = new Roo.XTemplate(
  19         '&lt;select name="{name}"&gt;',
  20                 '&lt;tpl for="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;',
  21         '&lt;/select&gt;'
  22 );
  23
  24 // then append, applying the master template values
  25  </code></pre>
  26  *
  27  * Supported features:
  28  *
  29  *  Tags:
  30  *    {a_variable} - output encoded.
  31  *    {a_variable.format:("Y-m-d")} - call a method on the variable
  32  *    {a_variable:raw} - unencoded output
  33  *    {a_variable:toFixed(1,2)} - Roo.util.Format."toFixed"
  34  *    {a_variable:this.method_on_template(...)} - call a method on the template object.
  35  *
  36  *  Tpl:
  37  *      &lt;tpl for="a_variable or condition.."&gt;&lt;/tpl&gt;
  38  *      &lt;tpl if="a_variable or condition"&gt;&lt;/tpl&gt;
  39  *      &lt;tpl exec="some javascript"&gt;&lt;/tpl&gt;
  40  *
  41  *      &lt;tpl for="."&gt;&lt;/tpl&gt; - just iterate the property..
  42  *      &lt;tpl for=".."&gt;&lt;/tpl&gt; - iterates with the parent (probably the template)
  43  *
  44  *
  45  */
  46 Roo.XTemplate = function()
  47 {
  48     Roo.XTemplate.superclass.constructor.apply(this, arguments);
  49     if (this.html) {
  50         this.compile();
  51     }
  52 };
  53
  54
  55 Roo.extend(Roo.XTemplate, Roo.Template, {
  56
  57     /**
  58      *
  59      * basic tag replacing syntax
  60      * WORD:WORD()
  61      *
  62      * // you can fake an object call by doing this
  63      *  x.t:(test,tesT)
  64      *
  65      */
  66     re : /\{([\w-\.]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
  67
  68
  69     compile: function()
  70     {
  71         var s = this.html;
  72
  73         s = ['<tpl>', s, '</tpl>'].join('');
  74
  75         var re     = /<tpl\b[^>]*>((?:(?=([^<]+))\2|<(?!tpl\b[^>]*>))*?)<\/tpl>/,
  76             nameRe = /^<tpl\b[^>]*?for="(.*?)"/,
  77             ifRe   = /^<tpl\b[^>]*?if="(.*?)"/,
  78             execRe = /^<tpl\b[^>]*?exec="(.*?)"/,
  79             namedRe = /^<tpl\b[^>]*?name="(\w+)"/,  // named templates..
  80             m,
  81             id     = 0,
  82             tpls   = [];
  83
  84         while(true == !!(m = s.match(re))){
  85             var forMatch   = m[0].match(nameRe),
  86                 ifMatch   = m[0].match(ifRe),
  87                 execMatch   = m[0].match(execRe),
  88                 namedMatch   = m[0].match(namedRe),
  89
  90                 exp  = null,
  91                 fn   = null,
  92                 exec = null,
  93                 name = forMatch && forMatch[1] ? forMatch[1] : '';
  94
  95             if (ifMatch) {
  96                 // if - puts fn into test..
  97                 exp = ifMatch && ifMatch[1] ? ifMatch[1] : null;
  98                 if(exp){
  99                    fn = new Function('values', 'parent', 'with(values){ return '+(Roo.util.Format.htmlDecode(exp))+'; }');
 100                 }
 101             }
 102
 103             if (execMatch) {
 104                 // exec - calls a function... returns empty if true is  returned.
 105                 exp = execMatch && execMatch[1] ? execMatch[1] : null;
 106                 if(exp){
 107                    exec = new Function('values', 'parent', 'with(values){ '+(Roo.util.Format.htmlDecode(exp))+'; }');
 108                 }
 109             }
 110             if (name) {
 111                 // for =
 112                 switch(name){
 113                     case '.':  name = new Function('values', 'parent', 'with(values){ return values; }'); break;
 114                     case '..': name = new Function('values', 'parent', 'with(values){ return parent; }'); break;
 115                     default:   name = new Function('values', 'parent', 'with(values){ return '+name+'; }');
 116                 }
 117             }
 118             tpls.push({
 119                 id:     id,
 120                 target: name,
 121                 exec:   exec,
 122                 test:   fn,
 123                 body:   m[1] || ''
 124             });
 125             s = s.replace(m[0], '{xtpl'+ id + '}');
 126             ++id;
 127         }
 128         for(var i = tpls.length-1; i >= 0; --i){
 129             this.compileTpl(tpls[i]);
 130         }
 131         this.master = tpls[tpls.length-1];
 132         this.tpls = tpls;
 133         return this;
 134     },
 135     /**
 136      * same as applyTemplate, except it's done to one of the subTemplates
 137      * @param {Number} id of the template
 138      * @param {Object} values to apply to template
 139      * @param {Object} parent (normaly the instance of this object)
 140      */
 141     applySubTemplate : function(id, values, parent)
 142     {
 143         var t = this.tpls[id];
 144         try {
 145             if(t.test && !t.test.call(this, values, parent)){
 146                 return '';
 147             }
 148         } catch(e) {
 149             Roo.log("Xtemplate.applySubTemplate 'test': Exception thrown");
 150             Roo.log(e.toString());
 151             Roo.log(t.test);
 152             return ''
 153         }
 154         try {
 155
 156             if(t.exec && t.exec.call(this, values, parent)){
 157                 return '';
 158             }
 159         } catch(e) {
 160             Roo.log("Xtemplate.applySubTemplate 'exec': Exception thrown");
 161             Roo.log(e.toString());
 162             Roo.log(t.exec);
 163             return ''
 164         }
 165         try {
 166             var vs = t.target ? t.target.call(this, values, parent) : values;
 167             parent = t.target ? values : parent;
 168             if(t.target && vs instanceof Array){
 169                 var buf = [];
 170                 for(var i = 0, len = vs.length; i < len; i++){
 171                     buf[buf.length] = t.compiled.call(this, vs[i], parent);
 172                 }
 173                 return buf.join('');
 174             }
 175             return t.compiled.call(this, vs, parent);
 176         } catch (e) {
 177             Roo.log("Xtemplate.applySubTemplate : Exception thrown");
 178             Roo.log(e.toString());
 179             Roo.log(t.compiled);
 180             return '';
 181         }
 182     },
 183
 184     compileTpl : function(tpl)
 185     {
 186         var fm = Roo.util.Format;
 187         var useF = this.disableFormats !== true;
 188         var sep = Roo.isGecko ? "+" : ",";
 189         var undef = function(str) {
 190             Roo.log("Property not found :"  + str);
 191             return '';
 192         };
 193
 194         var fn = function(m, name, format, args)
 195         {
 196             //Roo.log(arguments);
 197             args = args ? args.replace(/\\'/g,"'") : args;
 198             //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"]
 199             if (typeof(format) == 'undefined') {
 200                 format= 'htmlEncode';
 201             }
 202             if (format == 'raw' ) {
 203                 format = false;
 204             }
 205
 206             if(name.substr(0, 4) == 'xtpl'){
 207                 return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent)'+sep+"'";
 208             }
 209
 210             // build an array of options to determine if value is undefined..
 211
 212             // basically get 'xxxx.yyyy' then do
 213             // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ?
 214             //    (function () { Roo.log("Property not found"); return ''; })() :
 215             //    ......
 216
 217             var udef_ar = [];
 218             var lookfor = '';
 219             Roo.each(name.split('.'), function(st) {
 220                 lookfor += (lookfor.length ? '.': '') + st;
 221                 udef_ar.push(  "(typeof(" + lookfor + ") == 'undefined')"  );
 222             });
 223
 224             var udef_st = '((' + udef_ar.join(" || ") +") ? undef('" + name + "') : "; // .. needs )
 225
 226
 227             if(format && useF){
 228
 229                 args = args ? ',' + args : "";
 230
 231                 if(format.substr(0, 5) != "this."){
 232                     format = "fm." + format + '(';
 233                 }else{
 234                     format = 'this.call("'+ format.substr(5) + '", ';
 235                     args = ", values";
 236                 }
 237
 238                 return "'"+ sep +   udef_st   +    format + name + args + "))"+sep+"'";
 239             }
 240
 241             if (args.length) {
 242                 // called with xxyx.yuu:(test,test)
 243                 // change to ()
 244                 return "'"+ sep + udef_st  + name + '(' +  args + "))"+sep+"'";
 245             }
 246             // raw.. - :raw modifier..
 247             return "'"+ sep + udef_st  + name + ")"+sep+"'";
 248
 249         };
 250         var body;
 251         // branched to use + in gecko and [].join() in others
 252         if(Roo.isGecko){
 253             body = "tpl.compiled = function(values, parent){  with(values) { return '" +
 254                    tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
 255                     "';};};";
 256         }else{
 257             body = ["tpl.compiled = function(values, parent){  with (values) { return ['"];
 258             body.push(tpl.body.replace(/(\r\n|\n)/g,
 259                             '\\n').replace(/'/g, "\\'").replace(this.re, fn));
 260             body.push("'].join('');};};");
 261             body = body.join('');
 262         }
 263
 264         Roo.debug && Roo.log(body.replace(/\\n/,'\n'));
 265
 266         /** eval:var:zzzzzzz */
 267         eval(body);
 268
 269         return this;
 270     },
 271
 272     applyTemplate : function(values){
 273         return this.master.compiled.call(this, values, {});
 274         //var s = this.subs;
 275     },
 276
 277     apply : function(){
 278         return this.applyTemplate.apply(this, arguments);
 279     }
 280
 281  });
 282
 283 Roo.XTemplate.from = function(el){
 284     el = Roo.getDom(el);
 285     return new Roo.XTemplate(el.value || el.innerHTML);
 286 };