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