git.roojs.org Git - roojs1/blob - Roo/Template.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 * @class Roo.Template
  14 * Represents an HTML fragment template. Templates can be precompiled for greater performance.
  15 * For a list of available format functions, see {@link Roo.util.Format}.<br />
  16 * Usage:
  17 <pre><code>
  18 var t = new Roo.Template({
  19     html :  '&lt;div name="{id}"&gt;' +
  20         '&lt;span class="{cls}"&gt;{name:trim} {someval:this.myformat}{value:ellipsis(10)}&lt;/span&gt;' +
  21         '&lt;/div&gt;',
  22     myformat: function (value, allValues) {
  23         return 'XX' + value;
  24     }
  25 });
  26 t.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});
  27 </code></pre>
  28 * For more information see this blog post with examples: <a href="http://www.jackslocum.com/yui/2006/10/06/domhelper-create-elements-using-dom-html-fragments-or-templates/">DomHelper - Create Elements using DOM, HTML fragments and Templates</a>.
  29 * @constructor
  30 * @param {Object} cfg - Configuration object.
  31 */
  32 Roo.Template = function(cfg){
  33     // BC!
  34     if(cfg instanceof Array){
  35         cfg = cfg.join("");
  36     }else if(arguments.length > 1){
  37         cfg = Array.prototype.join.call(arguments, "");
  38     }
  39
  40
  41     if (typeof(cfg) == 'object') {
  42         Roo.apply(this,cfg)
  43     } else {
  44         // bc
  45         this.html = cfg;
  46     }
  47
  48
  49 };
  50 Roo.Template.prototype = {
  51
  52     /**
  53      * @cfg {String} html  The HTML fragment or an array of fragments to join("") or multiple arguments to join("")
  54      */
  55     html : '',
  56     /**
  57      * Returns an HTML fragment of this template with the specified values applied.
  58      * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
  59      * @return {String} The HTML fragment
  60      */
  61     applyTemplate : function(values){
  62         try {
  63
  64             if(this.compiled){
  65                 return this.compiled(values);
  66             }
  67             var useF = this.disableFormats !== true;
  68             var fm = Roo.util.Format, tpl = this;
  69             var fn = function(m, name, format, args){
  70                 if(format && useF){
  71                     if(format.substr(0, 5) == "this."){
  72                         return tpl.call(format.substr(5), values[name], values);
  73                     }else{
  74                         if(args){
  75                             // quoted values are required for strings in compiled templates,
  76                             // but for non compiled we need to strip them
  77                             // quoted reversed for jsmin
  78                             var re = /^\s*['"](.*)["']\s*$/;
  79                             args = args.split(',');
  80                             for(var i = 0, len = args.length; i < len; i++){
  81                                 args[i] = args[i].replace(re, "$1");
  82                             }
  83                             args = [values[name]].concat(args);
  84                         }else{
  85                             args = [values[name]];
  86                         }
  87                         return fm[format].apply(fm, args);
  88                     }
  89                 }else{
  90                     return values[name] !== undefined ? values[name] : "";
  91                 }
  92             };
  93             return this.html.replace(this.re, fn);
  94         } catch (e) {
  95             Roo.log(e);
  96             throw e;
  97         }
  98
  99     },
 100
 101     /**
 102      * Sets the HTML used as the template and optionally compiles it.
 103      * @param {String} html
 104      * @param {Boolean} compile (optional) True to compile the template (defaults to undefined)
 105      * @return {Roo.Template} this
 106      */
 107     set : function(html, compile){
 108         this.html = html;
 109         this.compiled = null;
 110         if(compile){
 111             this.compile();
 112         }
 113         return this;
 114     },
 115
 116     /**
 117      * True to disable format functions (defaults to false)
 118      * @type Boolean
 119      */
 120     disableFormats : false,
 121
 122     /**
 123     * The regular expression used to match template variables
 124     * @type RegExp
 125     * @property
 126     */
 127     re : /\{([\w-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
 128
 129     /**
 130      * Compiles the template into an internal function, eliminating the RegEx overhead.
 131      * @return {Roo.Template} this
 132      */
 133     compile : function(){
 134         var fm = Roo.util.Format;
 135         var useF = this.disableFormats !== true;
 136         var sep = Roo.isGecko ? "+" : ",";
 137         var fn = function(m, name, format, args){
 138             if(format && useF){
 139                 args = args ? ',' + args : "";
 140                 if(format.substr(0, 5) != "this."){
 141                     format = "fm." + format + '(';
 142                 }else{
 143                     format = 'this.call("'+ format.substr(5) + '", ';
 144                     args = ", values";
 145                 }
 146             }else{
 147                 args= ''; format = "(values['" + name + "'] == undefined ? '' : ";
 148             }
 149             return "'"+ sep + format + "values['" + name + "']" + args + ")"+sep+"'";
 150         };
 151         var body;
 152         // branched to use + in gecko and [].join() in others
 153         if(Roo.isGecko){
 154             body = "this.compiled = function(values){ return '" +
 155                    this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
 156                     "';};";
 157         }else{
 158             body = ["this.compiled = function(values){ return ['"];
 159             body.push(this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn));
 160             body.push("'].join('');};");
 161             body = body.join('');
 162         }
 163         /**
 164          * eval:var:values
 165          * eval:var:fm
 166          */
 167         eval(body);
 168         return this;
 169     },
 170
 171     // private function used to call members
 172     call : function(fnName, value, allValues){
 173         return this[fnName](value, allValues);
 174     },
 175
 176     /**
 177      * Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 178      * @param {String/HTMLElement/Roo.Element} el The context element
 179      * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
 180      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 181      * @return {HTMLElement/Roo.Element} The new node or Element
 182      */
 183     insertFirst: function(el, values, returnElement){
 184         return this.doInsert('afterBegin', el, values, returnElement);
 185     },
 186
 187     /**
 188      * Applies the supplied values to the template and inserts the new node(s) before el.
 189      * @param {String/HTMLElement/Roo.Element} el The context element
 190      * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
 191      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 192      * @return {HTMLElement/Roo.Element} The new node or Element
 193      */
 194     insertBefore: function(el, values, returnElement){
 195         return this.doInsert('beforeBegin', el, values, returnElement);
 196     },
 197
 198     /**
 199      * Applies the supplied values to the template and inserts the new node(s) after el.
 200      * @param {String/HTMLElement/Roo.Element} el The context element
 201      * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
 202      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 203      * @return {HTMLElement/Roo.Element} The new node or Element
 204      */
 205     insertAfter : function(el, values, returnElement){
 206         return this.doInsert('afterEnd', el, values, returnElement);
 207     },
 208
 209     /**
 210      * Applies the supplied values to the template and appends the new node(s) to el.
 211      * @param {String/HTMLElement/Roo.Element} el The context element
 212      * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
 213      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 214      * @return {HTMLElement/Roo.Element} The new node or Element
 215      */
 216     append : function(el, values, returnElement){
 217         return this.doInsert('beforeEnd', el, values, returnElement);
 218     },
 219
 220     doInsert : function(where, el, values, returnEl){
 221         el = Roo.getDom(el);
 222         var newNode = Roo.DomHelper.insertHtml(where, el, this.applyTemplate(values));
 223         return returnEl ? Roo.get(newNode, true) : newNode;
 224     },
 225
 226     /**
 227      * Applies the supplied values to the template and overwrites the content of el with the new node(s).
 228      * @param {String/HTMLElement/Roo.Element} el The context element
 229      * @param {Object} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
 230      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 231      * @return {HTMLElement/Roo.Element} The new node or Element
 232      */
 233     overwrite : function(el, values, returnElement){
 234         el = Roo.getDom(el);
 235         el.innerHTML = this.applyTemplate(values);
 236         return returnElement ? Roo.get(el.firstChild, true) : el.firstChild;
 237     }
 238 };
 239 /**
 240  * Alias for {@link #applyTemplate}
 241  * @method
 242  */
 243 Roo.Template.prototype.apply = Roo.Template.prototype.applyTemplate;
 244
 245 // backwards compat
 246 Roo.DomHelper.Template = Roo.Template;
 247
 248 /**
 249  * Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.
 250  * @param {String/HTMLElement} el A DOM element or its id
 251  * @returns {Roo.Template} The created template
 252  * @static
 253  */
 254 Roo.Template.from = function(el){
 255     el = Roo.getDom(el);
 256     return new Roo.Template(el.value || el.innerHTML);
 257 };