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
 111
 112             if (name) {
 113                 // for =
 114                 switch(name){
 115                     case '.':  name = new Function('values', 'parent', 'with(values){ return values; }'); break;
 116                     case '..': name = new Function('values', 'parent', 'with(values){ return parent; }'); break;
 117                     default:   name = new Function('values', 'parent', 'with(values){ return '+name+'; }');
 118                 }
 119             }
 120
 121
 122             tpls.push({
 123                 id:     namedMatch ? namedMatch[1] : id,
 124                 target: name,
 125                 exec:   exec,
 126                 test:   fn,
 127                 body:   m[1] || ''
 128             });
 129             if (namedMatch) {
 130                 s = s.replace(m[0], '');
 131             } else {
 132                 s = s.replace(m[0], '{xtpl'+ id + '}');
 133             }
 134             ++id;
 135         }
 136         for(var i = tpls.length-1; i >= 0; --i){
 137             this.compileTpl(tpls[i]);
 138         }
 139         this.master = tpls[tpls.length-1];
 140         this.tpls = tpls;
 141         return this;
 142     },
 143     /**
 144      * same as applyTemplate, except it's done to one of the subTemplates
 145      * @param {Number} id of the template
 146      * @param {Object} values to apply to template
 147      * @param {Object} parent (normaly the instance of this object)
 148      */
 149     applySubTemplate : function(id, values, parent)
 150     {
 151         var t = this.tpls[id];
 152         try {
 153             if(t.test && !t.test.call(this, values, parent)){
 154                 return '';
 155             }
 156         } catch(e) {
 157             Roo.log("Xtemplate.applySubTemplate 'test': Exception thrown");
 158             Roo.log(e.toString());
 159             Roo.log(t.test);
 160             return ''
 161         }
 162         try {
 163
 164             if(t.exec && t.exec.call(this, values, parent)){
 165                 return '';
 166             }
 167         } catch(e) {
 168             Roo.log("Xtemplate.applySubTemplate 'exec': Exception thrown");
 169             Roo.log(e.toString());
 170             Roo.log(t.exec);
 171             return ''
 172         }
 173         try {
 174             var vs = t.target ? t.target.call(this, values, parent) : values;
 175             parent = t.target ? values : parent;
 176             if(t.target && vs instanceof Array){
 177                 var buf = [];
 178                 for(var i = 0, len = vs.length; i < len; i++){
 179                     buf[buf.length] = t.compiled.call(this, vs[i], parent);
 180                 }
 181                 return buf.join('');
 182             }
 183             return t.compiled.call(this, vs, parent);
 184         } catch (e) {
 185             Roo.log("Xtemplate.applySubTemplate : Exception thrown");
 186             Roo.log(e.toString());
 187             Roo.log(t.compiled);
 188             return '';
 189         }
 190     },
 191
 192     compileTpl : function(tpl)
 193     {
 194         var fm = Roo.util.Format;
 195         var useF = this.disableFormats !== true;
 196         var sep = Roo.isGecko ? "+" : ",";
 197         var undef = function(str) {
 198             Roo.log("Property not found :"  + str);
 199             return '';
 200         };
 201
 202         var fn = function(m, name, format, args)
 203         {
 204             //Roo.log(arguments);
 205             args = args ? args.replace(/\\'/g,"'") : args;
 206             //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"]
 207             if (typeof(format) == 'undefined') {
 208                 format= 'htmlEncode';
 209             }
 210             if (format == 'raw' ) {
 211                 format = false;
 212             }
 213
 214             if(name.substr(0, 4) == 'xtpl'){
 215                 return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent)'+sep+"'";
 216             }
 217
 218             // build an array of options to determine if value is undefined..
 219
 220             // basically get 'xxxx.yyyy' then do
 221             // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ?
 222             //    (function () { Roo.log("Property not found"); return ''; })() :
 223             //    ......
 224
 225             var udef_ar = [];
 226             var lookfor = '';
 227             Roo.each(name.split('.'), function(st) {
 228                 lookfor += (lookfor.length ? '.': '') + st;
 229                 udef_ar.push(  "(typeof(" + lookfor + ") == 'undefined')"  );
 230             });
 231
 232             var udef_st = '((' + udef_ar.join(" || ") +") ? undef('" + name + "') : "; // .. needs )
 233
 234
 235             if(format && useF){
 236
 237                 args = args ? ',' + args : "";
 238
 239                 if(format.substr(0, 5) != "this."){
 240                     format = "fm." + format + '(';
 241                 }else{
 242                     format = 'this.call("'+ format.substr(5) + '", ';
 243                     args = ", values";
 244                 }
 245
 246                 return "'"+ sep +   udef_st   +    format + name + args + "))"+sep+"'";
 247             }
 248
 249             if (args.length) {
 250                 // called with xxyx.yuu:(test,test)
 251                 // change to ()
 252                 return "'"+ sep + udef_st  + name + '(' +  args + "))"+sep+"'";
 253             }
 254             // raw.. - :raw modifier..
 255             return "'"+ sep + udef_st  + name + ")"+sep+"'";
 256
 257         };
 258         var body;
 259         // branched to use + in gecko and [].join() in others
 260         if(Roo.isGecko){
 261             body = "tpl.compiled = function(values, parent){  with(values) { return '" +
 262                    tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
 263                     "';};};";
 264         }else{
 265             body = ["tpl.compiled = function(values, parent){  with (values) { return ['"];
 266             body.push(tpl.body.replace(/(\r\n|\n)/g,
 267                             '\\n').replace(/'/g, "\\'").replace(this.re, fn));
 268             body.push("'].join('');};};");
 269             body = body.join('');
 270         }
 271
 272         Roo.debug && Roo.log(body.replace(/\\n/,'\n'));
 273
 274         /** eval:var:zzzzzzz */
 275         eval(body);
 276
 277         return this;
 278     },
 279
 280     applyTemplate : function(values){
 281         return this.master.compiled.call(this, values, {});
 282         //var s = this.subs;
 283     },
 284
 285     apply : function(){
 286         return this.applyTemplate.apply(this, arguments);
 287     }
 288
 289  });
 290
 291 Roo.XTemplate.from = function(el){
 292     el = Roo.getDom(el);
 293     return new Roo.XTemplate(el.value || el.innerHTML);
 294 };