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:
  29 *  <a href="http://www.cnitblog.com/seeyeah/archive/2011/12/30/38728.html/">DomHelper
  30      - Create Elements using DOM, HTML fragments and Templates</a>.
  31 * @constructor
  32 * @param {Object} cfg - Configuration object.
  33 */
  34 Roo.Template = function(cfg){
  35     // BC!
  36     if(cfg instanceof Array){
  37         cfg = cfg.join("");
  38     }else if(arguments.length > 1){
  39         cfg = Array.prototype.join.call(arguments, "");
  40     }
  41
  42
  43     if (typeof(cfg) == 'object') {
  44         Roo.apply(this,cfg)
  45     } else {
  46         // bc
  47         this.html = cfg;
  48     }
  49     if (this.url) {
  50         this.load();
  51     }
  52
  53 };
  54 Roo.Template.prototype = {
  55
  56     /**
  57      * @cfg {Function} onLoad Called after the template has been loaded and complied (usually from a remove source)
  58      */
  59     onLoad : false,
  60
  61
  62     /**
  63      * @cfg {String} url  The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..
  64      *                    it should be fixed so that template is observable...
  65      */
  66     url : false,
  67     /**
  68      * @cfg {String} html  The HTML fragment or an array of fragments to join("") or multiple arguments to join("")
  69      */
  70     html : '',
  71     /**
  72      * Returns an HTML fragment of this template with the specified values applied.
  73      * @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'})
  74      * @return {String} The HTML fragment
  75      */
  76     applyTemplate : function(values){
  77         //Roo.log(["applyTemplate", values]);
  78         try {
  79
  80             if(this.compiled){
  81                 return this.compiled(values);
  82             }
  83             var useF = this.disableFormats !== true;
  84             var fm = Roo.util.Format, tpl = this;
  85             var fn = function(m, name, format, args){
  86                 if(format && useF){
  87                     if(format.substr(0, 5) == "this."){
  88                         return tpl.call(format.substr(5), values[name], values);
  89                     }else{
  90                         if(args){
  91                             // quoted values are required for strings in compiled templates,
  92                             // but for non compiled we need to strip them
  93                             // quoted reversed for jsmin
  94                             var re = /^\s*['"](.*)["']\s*$/;
  95                             args = args.split(',');
  96                             for(var i = 0, len = args.length; i < len; i++){
  97                                 args[i] = args[i].replace(re, "$1");
  98                             }
  99                             args = [values[name]].concat(args);
 100                         }else{
 101                             args = [values[name]];
 102                         }
 103                         return fm[format].apply(fm, args);
 104                     }
 105                 }else{
 106                     return values[name] !== undefined ? values[name] : "";
 107                 }
 108             };
 109             return this.html.replace(this.re, fn);
 110         } catch (e) {
 111             Roo.log(e);
 112             throw e;
 113         }
 114
 115     },
 116
 117     loading : false,
 118
 119     load : function ()
 120     {
 121
 122         if (this.loading) {
 123             return;
 124         }
 125         var _t = this;
 126
 127         this.loading = true;
 128         this.compiled = false;
 129
 130         var cx = new Roo.data.Connection();
 131         cx.request({
 132             url : this.url,
 133             method : 'GET',
 134             success : function (response) {
 135                 _t.loading = false;
 136                 _t.html = response.responseText;
 137                 _t.url = false;
 138                 _t.compile();
 139                 if (_t.onLoad) {
 140                     _t.onLoad();
 141                 }
 142              },
 143             failure : function(response) {
 144                 Roo.log("Template failed to load from " + _t.url);
 145                 _t.loading = false;
 146             }
 147         });
 148     },
 149
 150     /**
 151      * Sets the HTML used as the template and optionally compiles it.
 152      * @param {String} html
 153      * @param {Boolean} compile (optional) True to compile the template (defaults to undefined)
 154      * @return {Roo.Template} this
 155      */
 156     set : function(html, compile){
 157         this.html = html;
 158         this.compiled = null;
 159         if(compile){
 160             this.compile();
 161         }
 162         return this;
 163     },
 164
 165     /**
 166      * True to disable format functions (defaults to false)
 167      * @type Boolean
 168      */
 169     disableFormats : false,
 170
 171     /**
 172     * The regular expression used to match template variables
 173     * @type RegExp
 174     * @property
 175     */
 176     re : /\{([\w-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
 177
 178     /**
 179      * Compiles the template into an internal function, eliminating the RegEx overhead.
 180      * @return {Roo.Template} this
 181      */
 182     compile : function(){
 183         var fm = Roo.util.Format;
 184         var useF = this.disableFormats !== true;
 185         var sep = Roo.isGecko ? "+" : ",";
 186         var fn = function(m, name, format, args){
 187             if(format && useF){
 188                 args = args ? ',' + args : "";
 189                 if(format.substr(0, 5) != "this."){
 190                     format = "fm." + format + '(';
 191                 }else{
 192                     format = 'this.call("'+ format.substr(5) + '", ';
 193                     args = ", values";
 194                 }
 195             }else{
 196                 args= ''; format = "(values['" + name + "'] == undefined ? '' : ";
 197             }
 198             return "'"+ sep + format + "values['" + name + "']" + args + ")"+sep+"'";
 199         };
 200         var body;
 201         // branched to use + in gecko and [].join() in others
 202         if(Roo.isGecko){
 203             body = "this.compiled = function(values){ return '" +
 204                    this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
 205                     "';};";
 206         }else{
 207             body = ["this.compiled = function(values){ return ['"];
 208             body.push(this.html.replace(/\\/g, '\\\\').replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn));
 209             body.push("'].join('');};");
 210             body = body.join('');
 211         }
 212         /**
 213          * eval:var:values
 214          * eval:var:fm
 215          */
 216         eval(body);
 217         return this;
 218     },
 219
 220     // private function used to call members
 221     call : function(fnName, value, allValues){
 222         return this[fnName](value, allValues);
 223     },
 224
 225     /**
 226      * Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 227      * @param {String/HTMLElement/Roo.Element} el The context element
 228      * @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'})
 229      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 230      * @return {HTMLElement/Roo.Element} The new node or Element
 231      */
 232     insertFirst: function(el, values, returnElement){
 233         return this.doInsert('afterBegin', el, values, returnElement);
 234     },
 235
 236     /**
 237      * Applies the supplied values to the template and inserts the new node(s) before el.
 238      * @param {String/HTMLElement/Roo.Element} el The context element
 239      * @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'})
 240      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 241      * @return {HTMLElement/Roo.Element} The new node or Element
 242      */
 243     insertBefore: function(el, values, returnElement){
 244         return this.doInsert('beforeBegin', el, values, returnElement);
 245     },
 246
 247     /**
 248      * Applies the supplied values to the template and inserts the new node(s) after el.
 249      * @param {String/HTMLElement/Roo.Element} el The context element
 250      * @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'})
 251      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 252      * @return {HTMLElement/Roo.Element} The new node or Element
 253      */
 254     insertAfter : function(el, values, returnElement){
 255         return this.doInsert('afterEnd', el, values, returnElement);
 256     },
 257
 258     /**
 259      * Applies the supplied values to the template and appends the new node(s) to el.
 260      * @param {String/HTMLElement/Roo.Element} el The context element
 261      * @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'})
 262      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 263      * @return {HTMLElement/Roo.Element} The new node or Element
 264      */
 265     append : function(el, values, returnElement){
 266         return this.doInsert('beforeEnd', el, values, returnElement);
 267     },
 268
 269     doInsert : function(where, el, values, returnEl){
 270         el = Roo.getDom(el);
 271         var newNode = Roo.DomHelper.insertHtml(where, el, this.applyTemplate(values));
 272         return returnEl ? Roo.get(newNode, true) : newNode;
 273     },
 274
 275     /**
 276      * Applies the supplied values to the template and overwrites the content of el with the new node(s).
 277      * @param {String/HTMLElement/Roo.Element} el The context element
 278      * @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'})
 279      * @param {Boolean} returnElement (optional) true to return a Roo.Element (defaults to undefined)
 280      * @return {HTMLElement/Roo.Element} The new node or Element
 281      */
 282     overwrite : function(el, values, returnElement){
 283         el = Roo.getDom(el);
 284         el.innerHTML = this.applyTemplate(values);
 285         return returnElement ? Roo.get(el.firstChild, true) : el.firstChild;
 286     }
 287 };
 288 /**
 289  * Alias for {@link #applyTemplate}
 290  * @method
 291  */
 292 Roo.Template.prototype.apply = Roo.Template.prototype.applyTemplate;
 293
 294 // backwards compat
 295 Roo.DomHelper.Template = Roo.Template;
 296
 297 /**
 298  * Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.
 299  * @param {String/HTMLElement} el A DOM element or its id
 300  * @returns {Roo.Template} The created template
 301  * @static
 302  */
 303 Roo.Template.from = function(el){
 304     el = Roo.getDom(el);
 305     return new Roo.Template(el.value || el.innerHTML);
 306 };