XTemplate.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:14k
源码类别:

中间件编程

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.0.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.XTemplate
  9.  * @extends Ext.Template
  10.  * <p>A template class that supports advanced functionality like autofilling arrays, conditional processing with
  11.  * basic comparison operators, sub-templates, basic math function support, special built-in template variables,
  12.  * inline code execution and more.  XTemplate also provides the templating mechanism built into {@link Ext.DataView}.</p>
  13.  * <p>XTemplate supports many special tags and built-in operators that aren't defined as part of the API, but are
  14.  * supported in the templates that can be created.  The following examples demonstrate all of the supported features.
  15.  * This is the data object used for reference in each code example:</p>
  16.  * <pre><code>
  17. var data = {
  18.     name: 'Jack Slocum',
  19.     title: 'Lead Developer',
  20.     company: 'Ext JS, LLC',
  21.     email: 'jack@extjs.com',
  22.     address: '4 Red Bulls Drive',
  23.     city: 'Cleveland',
  24.     state: 'Ohio',
  25.     zip: '44102',
  26.     drinks: ['Red Bull', 'Coffee', 'Water'],
  27.     kids: [{
  28.         name: 'Sara Grace',
  29.         age:3
  30.     },{
  31.         name: 'Zachary',
  32.         age:2
  33.     },{
  34.         name: 'John James',
  35.         age:0
  36.     }]
  37. };
  38.  * </code></pre>
  39.  * <p><b>Auto filling of arrays</b><br/>The <tt>tpl</tt> tag and the <tt>for</tt> operator are used
  40.  * to process the provided data object. If <tt>for="."</tt> is specified, the data object provided
  41.  * is examined. If the variable in <tt>for</tt> is an array, it will auto-fill, repeating the template
  42.  * block inside the <tt>tpl</tt> tag for each item in the array:</p>
  43.  * <pre><code>
  44. var tpl = new Ext.XTemplate(
  45.     '&lt;p>Kids: ',
  46.     '&lt;tpl for=".">',
  47.         '&lt;p>{name}&lt;/p>',
  48.     '&lt;/tpl>&lt;/p>'
  49. );
  50. tpl.overwrite(panel.body, data.kids); // pass the kids property of the data object
  51.  * </code></pre>
  52.  * <p><b>Scope switching</b><br/>The <tt>for</tt> property can be leveraged to access specified members
  53.  * of the provided data object to populate the template:</p>
  54.  * <pre><code>
  55. var tpl = new Ext.XTemplate(
  56.     '&lt;p>Name: {name}&lt;/p>',
  57.     '&lt;p>Title: {title}&lt;/p>',
  58.     '&lt;p>Company: {company}&lt;/p>',
  59.     '&lt;p>Kids: ',
  60.     '&lt;tpl <b>for="kids"</b>>', // interrogate the kids property within the data
  61.         '&lt;p>{name}&lt;/p>',
  62.     '&lt;/tpl>&lt;/p>'
  63. );
  64. tpl.overwrite(panel.body, data);
  65.  * </code></pre>
  66.  * <p><b>Access to parent object from within sub-template scope</b><br/>When processing a sub-template, for example while
  67.  * looping through a child array, you can access the parent object's members via the <tt>parent</tt> object:</p>
  68.  * <pre><code>
  69. var tpl = new Ext.XTemplate(
  70.     '&lt;p>Name: {name}&lt;/p>',
  71.     '&lt;p>Kids: ',
  72.     '&lt;tpl for="kids">',
  73.         '&lt;tpl if="age &amp;gt; 1">',  // <-- Note that the &gt; is encoded
  74.             '&lt;p>{name}&lt;/p>',
  75.             '&lt;p>Dad: {parent.name}&lt;/p>',
  76.         '&lt;/tpl>',
  77.     '&lt;/tpl>&lt;/p>'
  78. );
  79. tpl.overwrite(panel.body, data);
  80. </code></pre>
  81.  * <p><b>Array item index and basic math support</b> <br/>While processing an array, the special variable <tt>{#}</tt>
  82.  * will provide the current array index + 1 (starts at 1, not 0). Templates also support the basic math operators
  83.  * + - * and / that can be applied directly on numeric data values:</p>
  84.  * <pre><code>
  85. var tpl = new Ext.XTemplate(
  86.     '&lt;p>Name: {name}&lt;/p>',
  87.     '&lt;p>Kids: ',
  88.     '&lt;tpl for="kids">',
  89.         '&lt;tpl if="age &amp;gt; 1">',  // <-- Note that the &gt; is encoded
  90.             '&lt;p>{#}: {name}&lt;/p>',  // <-- Auto-number each item
  91.             '&lt;p>In 5 Years: {age+5}&lt;/p>',  // <-- Basic math
  92.             '&lt;p>Dad: {parent.name}&lt;/p>',
  93.         '&lt;/tpl>',
  94.     '&lt;/tpl>&lt;/p>'
  95. );
  96. tpl.overwrite(panel.body, data);
  97. </code></pre>
  98.  * <p><b>Auto-rendering of flat arrays</b> <br/>Flat arrays that contain values (and not objects) can be auto-rendered
  99.  * using the special <tt>{.}</tt> variable inside a loop.  This variable will represent the value of
  100.  * the array at the current index:</p>
  101.  * <pre><code>
  102. var tpl = new Ext.XTemplate(
  103.     '&lt;p>{name}'s favorite beverages:&lt;/p>',
  104.     '&lt;tpl for="drinks">',
  105.        '&lt;div> - {.}&lt;/div>',
  106.     '&lt;/tpl>'
  107. );
  108. tpl.overwrite(panel.body, data);
  109. </code></pre>
  110.  * <p><b>Basic conditional logic</b> <br/>Using the <tt>tpl</tt> tag and the <tt>if</tt>
  111.  * operator you can provide conditional checks for deciding whether or not to render specific parts of the template.
  112.  * Note that there is no <tt>else</tt> operator &mdash; if needed, you should use two opposite <tt>if</tt> statements.
  113.  * Properly-encoded attributes are required as seen in the following example:</p>
  114.  * <pre><code>
  115. var tpl = new Ext.XTemplate(
  116.     '&lt;p>Name: {name}&lt;/p>',
  117.     '&lt;p>Kids: ',
  118.     '&lt;tpl for="kids">',
  119.         '&lt;tpl if="age &amp;gt; 1">',  // <-- Note that the &gt; is encoded
  120.             '&lt;p>{name}&lt;/p>',
  121.         '&lt;/tpl>',
  122.     '&lt;/tpl>&lt;/p>'
  123. );
  124. tpl.overwrite(panel.body, data);
  125. </code></pre>
  126.  * <p><b>Ability to execute arbitrary inline code</b> <br/>In an XTemplate, anything between {[ ... ]}  is considered
  127.  * code to be executed in the scope of the template. There are some special variables available in that code:
  128.  * <ul>
  129.  * <li><b><tt>values</tt></b>: The values in the current scope. If you are using scope changing sub-templates, you
  130.  * can change what <tt>values</tt> is.</li>
  131.  * <li><b><tt>parent</tt></b>: The scope (values) of the ancestor template.</li>
  132.  * <li><b><tt>xindex</tt></b>: If you are in a looping template, the index of the loop you are in (1-based).</li>
  133.  * <li><b><tt>xcount</tt></b>: If you are in a looping template, the total length of the array you are looping.</li>
  134.  * <li><b><tt>fm</tt></b>: An alias for <tt>Ext.util.Format</tt>.</li>
  135.  * </ul>
  136.  * This example demonstrates basic row striping using an inline code block and the <tt>xindex</tt> variable:</p>
  137.  * <pre><code>
  138. var tpl = new Ext.XTemplate(
  139.     '&lt;p>Name: {name}&lt;/p>',
  140.     '&lt;p>Company: {[values.company.toUpperCase() + ", " + values.title]}&lt;/p>',
  141.     '&lt;p>Kids: ',
  142.     '&lt;tpl for="kids">',
  143.        '&lt;div class="{[xindex % 2 === 0 ? "even" : "odd"]}">',
  144.         '{name}',
  145.         '&lt;/div>',
  146.     '&lt;/tpl>&lt;/p>'
  147. );
  148. tpl.overwrite(panel.body, data);
  149. </code></pre>
  150.  * <p><b>Template member functions</b> <br/>One or more member functions can be defined directly on the config
  151.  * object passed into the XTemplate constructor for more complex processing:</p>
  152.  * <pre><code>
  153. var tpl = new Ext.XTemplate(
  154.     '&lt;p>Name: {name}&lt;/p>',
  155.     '&lt;p>Kids: ',
  156.     '&lt;tpl for="kids">',
  157.         '&lt;tpl if="this.isGirl(name)">',
  158.             '&lt;p>Girl: {name} - {age}&lt;/p>',
  159.         '&lt;/tpl>',
  160.         '&lt;tpl if="this.isGirl(name) == false">',
  161.             '&lt;p>Boy: {name} - {age}&lt;/p>',
  162.         '&lt;/tpl>',
  163.         '&lt;tpl if="this.isBaby(age)">',
  164.             '&lt;p>{name} is a baby!&lt;/p>',
  165.         '&lt;/tpl>',
  166.     '&lt;/tpl>&lt;/p>', {
  167.      isGirl: function(name){
  168.          return name == 'Sara Grace';
  169.      },
  170.      isBaby: function(age){
  171.         return age < 1;
  172.      }
  173. });
  174. tpl.overwrite(panel.body, data);
  175. </code></pre>
  176.  * @constructor
  177.  * @param {String/Array/Object} parts The HTML fragment or an array of fragments to join(""), or multiple arguments
  178.  * to join("") that can also include a config object
  179.  */
  180. Ext.XTemplate = function(){
  181.     Ext.XTemplate.superclass.constructor.apply(this, arguments);
  182.     var me = this,
  183.      s = me.html,
  184.      re = /<tplb[^>]*>((?:(?=([^<]+))2|<(?!tplb[^>]*>))*?)</tpl>/,
  185.      nameRe = /^<tplb[^>]*?for="(.*?)"/,
  186.      ifRe = /^<tplb[^>]*?if="(.*?)"/,
  187.      execRe = /^<tplb[^>]*?exec="(.*?)"/,
  188.      m,
  189.      id = 0,
  190.      tpls = [],
  191.      VALUES = 'values',
  192.      PARENT = 'parent',
  193.      XINDEX = 'xindex',
  194.      XCOUNT = 'xcount',
  195.      RETURN = 'return ',
  196.      WITHVALUES = 'with(values){ ';
  197.     s = ['<tpl>', s, '</tpl>'].join('');
  198.     while((m = s.match(re))){
  199.         var m2 = m[0].match(nameRe),
  200. m3 = m[0].match(ifRe),
  201.         m4 = m[0].match(execRe),
  202.         exp = null,
  203.         fn = null,
  204.         exec = null,
  205.         name = m2 && m2[1] ? m2[1] : '';
  206.        if (m3) {
  207.            exp = m3 && m3[1] ? m3[1] : null;
  208.            if(exp){
  209.                fn = new Function(VALUES, PARENT, XINDEX, XCOUNT, WITHVALUES + RETURN +(Ext.util.Format.htmlDecode(exp))+'; }');
  210.            }
  211.        }
  212.        if (m4) {
  213.            exp = m4 && m4[1] ? m4[1] : null;
  214.            if(exp){
  215.                exec = new Function(VALUES, PARENT, XINDEX, XCOUNT, WITHVALUES +(Ext.util.Format.htmlDecode(exp))+'; }');
  216.            }
  217.        }
  218.        if(name){
  219.            switch(name){
  220.                case '.': name = new Function(VALUES, PARENT, WITHVALUES + RETURN + VALUES + '; }'); break;
  221.                case '..': name = new Function(VALUES, PARENT, WITHVALUES + RETURN + PARENT + '; }'); break;
  222.                default: name = new Function(VALUES, PARENT, WITHVALUES + RETURN + name + '; }');
  223.            }
  224.        }
  225.        tpls.push({
  226.             id: id,
  227.             target: name,
  228.             exec: exec,
  229.             test: fn,
  230.             body: m[1]||''
  231.         });
  232.        s = s.replace(m[0], '{xtpl'+ id + '}');
  233.        ++id;
  234.     }
  235. Ext.each(tpls, function(t) {
  236.         me.compileTpl(t);
  237.     });
  238.     me.master = tpls[tpls.length-1];
  239.     me.tpls = tpls;
  240. };
  241. Ext.extend(Ext.XTemplate, Ext.Template, {
  242.     // private
  243.     re : /{([w-.#]+)(?::([w.]*)(?:((.*?)?))?)?(s?[+-*\]s?[d.+-*\()]+)?}/g,
  244.     // private
  245.     codeRe : /{[((?:\]|.|n)*?)]}/g,
  246.     // private
  247.     applySubTemplate : function(id, values, parent, xindex, xcount){
  248.         var me = this,
  249.          len,
  250.          t = me.tpls[id],
  251.          vs,
  252.          buf = [];
  253.         if ((t.test && !t.test.call(me, values, parent, xindex, xcount)) ||
  254.             (t.exec && t.exec.call(me, values, parent, xindex, xcount))) {
  255.             return '';
  256.         }
  257.         vs = t.target ? t.target.call(me, values, parent) : values;
  258.         len = vs.length;
  259.         parent = t.target ? values : parent;
  260.         if(t.target && Ext.isArray(vs)){
  261.         Ext.each(vs, function(v, i) {
  262.                 buf[buf.length] = t.compiled.call(me, v, parent, i+1, len);
  263.             });
  264.             return buf.join('');
  265.         }
  266.         return t.compiled.call(me, vs, parent, xindex, xcount);
  267.     },
  268.     // private
  269.     compileTpl : function(tpl){
  270.         var fm = Ext.util.Format,
  271.         useF = this.disableFormats !== true,
  272.             sep = Ext.isGecko ? "+" : ",",
  273.             body;
  274.         function fn(m, name, format, args, math){
  275.             if(name.substr(0, 4) == 'xtpl'){
  276.                 return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent, xindex, xcount)'+sep+"'";
  277.             }
  278.             var v;
  279.             if(name === '.'){
  280.                 v = 'values';
  281.             }else if(name === '#'){
  282.                 v = 'xindex';
  283.             }else if(name.indexOf('.') != -1){
  284.                 v = name;
  285.             }else{
  286.                 v = "values['" + name + "']";
  287.             }
  288.             if(math){
  289.                 v = '(' + v + math + ')';
  290.             }
  291.             if (format && useF) {
  292.                 args = args ? ',' + args : "";
  293.                 if(format.substr(0, 5) != "this."){
  294.                     format = "fm." + format + '(';
  295.                 }else{
  296.                     format = 'this.call("'+ format.substr(5) + '", ';
  297.                     args = ", values";
  298.                 }
  299.             } else {
  300.                 args= ''; format = "("+v+" === undefined ? '' : ";
  301.             }
  302.             return "'"+ sep + format + v + args + ")"+sep+"'";
  303.         }
  304.         function codeFn(m, code){
  305.             return "'"+ sep +'('+code+')'+sep+"'";
  306.         }
  307.         // branched to use + in gecko and [].join() in others
  308.         if(Ext.isGecko){
  309.             body = "tpl.compiled = function(values, parent, xindex, xcount){ return '" +
  310.                    tpl.body.replace(/(rn|n)/g, '\n').replace(/'/g, "\'").replace(this.re, fn).replace(this.codeRe, codeFn) +
  311.                     "';};";
  312.         }else{
  313.             body = ["tpl.compiled = function(values, parent, xindex, xcount){ return ['"];
  314.             body.push(tpl.body.replace(/(rn|n)/g, '\n').replace(/'/g, "\'").replace(this.re, fn).replace(this.codeRe, codeFn));
  315.             body.push("'].join('');};");
  316.             body = body.join('');
  317.         }
  318.         eval(body);
  319.         return this;
  320.     },
  321.     /**
  322.      * Returns an HTML fragment of this template with the specified values applied.
  323.      * @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'})
  324.      * @return {String} The HTML fragment
  325.      */
  326.     applyTemplate : function(values){
  327.         return this.master.compiled.call(this, values, {}, 1, 1);
  328.     },
  329.     /**
  330.      * Compile the template to a function for optimized performance.  Recommended if the template will be used frequently.
  331.      * @return {Function} The compiled function
  332.      */
  333.     compile : function(){return this;}
  334.     /**
  335.      * @property re
  336.      * @hide
  337.      */
  338.     /**
  339.      * @property disableFormats
  340.      * @hide
  341.      */
  342.     /**
  343.      * @method set
  344.      * @hide
  345.      */
  346. });
  347. /**
  348.  * Alias for {@link #applyTemplate}
  349.  * Returns an HTML fragment of this template with the specified values applied.
  350.  * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
  351.  * @return {String} The HTML fragment
  352.  * @member Ext.XTemplate
  353.  * @method apply
  354.  */
  355. Ext.XTemplate.prototype.apply = Ext.XTemplate.prototype.applyTemplate;
  356. /**
  357.  * Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.
  358.  * @param {String/HTMLElement} el A DOM element or its id
  359.  * @return {Ext.Template} The created template
  360.  * @static
  361.  */
  362. Ext.XTemplate.from = function(el){
  363.     el = Ext.getDom(el);
  364.     return new Ext.XTemplate(el.value || el.innerHTML);
  365. };