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     loading : false,
 102
 103     load : function (url, success)
 104     {
 105         if (this.loading) {
 106             return;
 107         }
 108         this.loading = true;
 109         this.compiled = false;
 110         var _t = this;
 111         var cx = new Roo.data.Connection();
 112         cx.request({
 113             url : url,
 114             method : 'GET',
 115             success : function (response) {
 116                 _t.loading = false;
 117                 _t.html = response.responseText;
 118                 success && success();
 119             },
 120             failure : function(response) {
 121                 Roo.log("Template failed to load from " + url);
 122                 _t.loading = false;
 123             }
 124         });
 125     },
 126
 127     /**
 128      * Sets the HTML used as the template and optionally compiles it.
 129      * @param {String} html
 130      * @param {Boolean} compile (optional) True to compile the template (defaults to undefined)
 131      * @return {Roo.Template} this
 132      */
 133     set : function(html, compile){
 134         this.html = html;
 135         this.compiled = null;
 136         if(compile){
 137             this.compile();
 138         }
 139         return this;
 140     },
 141
 142     /**
 143      * True to disable format functions (defaults to false)
 144      * @type Boolean
 145      */
 146     disableFormats : false,
 147
 148     /**
 149     * The regular expression used to match template variables
 150     * @type RegExp
 151     * @property
 152     */
 153     re : /\{([\w-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
 154
 155     /**
 156      * Compiles the template into an internal function, eliminating the RegEx overhead.
 157      * @return {Roo.Template} this
 158      */
 159     compile : function(){
 160         var fm = Roo.util.Format;
 161         var useF = this.disableFormats !== true;
 162         var sep = Roo.isGecko ? "+" : ",";
 163         var fn = function(m, name, format, args){
 164             if(format && useF){
 165                 args = args ? ',' + args : "";
 166                 if(format.substr(0, 5) != "this."){
 167                     format = "fm." + format + '(';
 168                 }else{
 169                     format = 'this.call("'+ format.substr(5) + '", ';
 170                     args = ", values";
 171                 }
 172             }else{
 173                 args= ''; format = "(values['" + name + "'] == undefined ? '' : ";
 174             }
 175             return "'"+ sep + format + "values['" + name + "']" + args + ")"+sep+"'";
 176         };
 177         var body;
 178         // branched to use + in gecko and [].join() in others
 179         if(Roo.isGecko){
 180             body = "this.compiled = function(values){ return '" +
 181                    this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
 182                     "';};";
 183         }else{
 184             body = ["this.compiled = function(values){ return ['"];
 185             body.push(this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn));
 186             body.push("'].join('');};");
 187             body = body.join('');
 188         }
 189         /**
 190          * eval:var:values
 191          * eval:var:fm
 192          */
 193         eval(body);
 194         return this;
 195     },
 196
 197     // private function used to call members
 198     call : function(fnName, value, allValues){
 199         return this[fnName](value, allValues);
 200     },
 201
 202     /**
 203      * Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 204      * @param {String/HTMLElement/Roo.Element} el The context element
 205      * @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'})
 206      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 207      * @return {HTMLElement/Roo.Element} The new node or Element
 208      */
 209     insertFirst: function(el, values, returnElement){
 210         return this.doInsert('afterBegin', el, values, returnElement);
 211     },
 212
 213     /**
 214      * Applies the supplied values to the template and inserts the new node(s) before el.
 215      * @param {String/HTMLElement/Roo.Element} el The context element
 216      * @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'})
 217      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 218      * @return {HTMLElement/Roo.Element} The new node or Element
 219      */
 220     insertBefore: function(el, values, returnElement){
 221         return this.doInsert('beforeBegin', el, values, returnElement);
 222     },
 223
 224     /**
 225      * Applies the supplied values to the template and inserts the new node(s) after el.
 226      * @param {String/HTMLElement/Roo.Element} el The context element
 227      * @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'})
 228      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 229      * @return {HTMLElement/Roo.Element} The new node or Element
 230      */
 231     insertAfter : function(el, values, returnElement){
 232         return this.doInsert('afterEnd', el, values, returnElement);
 233     },
 234
 235     /**
 236      * Applies the supplied values to the template and appends the new node(s) to el.
 237      * @param {String/HTMLElement/Roo.Element} el The context element
 238      * @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'})
 239      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 240      * @return {HTMLElement/Roo.Element} The new node or Element
 241      */
 242     append : function(el, values, returnElement){
 243         return this.doInsert('beforeEnd', el, values, returnElement);
 244     },
 245
 246     doInsert : function(where, el, values, returnEl){
 247         el = Roo.getDom(el);
 248         var newNode = Roo.DomHelper.insertHtml(where, el, this.applyTemplate(values));
 249         return returnEl ? Roo.get(newNode, true) : newNode;
 250     },
 251
 252     /**
 253      * Applies the supplied values to the template and overwrites the content of el with the new node(s).
 254      * @param {String/HTMLElement/Roo.Element} el The context element
 255      * @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'})
 256      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 257      * @return {HTMLElement/Roo.Element} The new node or Element
 258      */
 259     overwrite : function(el, values, returnElement){
 260         el = Roo.getDom(el);
 261         el.innerHTML = this.applyTemplate(values);
 262         return returnElement ? Roo.get(el.firstChild, true) : el.firstChild;
 263     }
 264 };
 265 /**
 266  * Alias for {@link #applyTemplate}
 267  * @method
 268  */
 269 Roo.Template.prototype.apply = Roo.Template.prototype.applyTemplate;
 270
 271 // backwards compat
 272 Roo.DomHelper.Template = Roo.Template;
 273
 274 /**
 275  * Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.
 276  * @param {String/HTMLElement} el A DOM element or its id
 277  * @returns {Roo.Template} The created template
 278  * @static
 279  */
 280 Roo.Template.from = function(el){
 281     el = Roo.getDom(el);
 282     return new Roo.Template(el.value || el.innerHTML);
 283 };