Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / Template2.html
diff --git a/docs/source/Template2.html b/docs/source/Template2.html
new file mode 100644 (file)
index 0000000..e3d8a87
--- /dev/null
@@ -0,0 +1,284 @@
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-Template'>/**
+</span> * @class Ext.Template
+ * &lt;p&gt;Represents an HTML fragment template. Templates may be {@link #compile precompiled}
+ * for greater performance.&lt;/p&gt;
+ * An instance of this class may be created by passing to the constructor either
+ * a single argument, or multiple arguments:
+ * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
+ * &lt;li&gt;&lt;b&gt;single argument&lt;/b&gt; : String/Array
+ * &lt;div class=&quot;sub-desc&quot;&gt;
+ * The single argument may be either a String or an Array:&lt;ul&gt;
+ * &lt;li&gt;&lt;tt&gt;String&lt;/tt&gt; : &lt;/li&gt;&lt;pre&gt;&lt;code&gt;
+var t = new Ext.Template(&quot;&amp;lt;div&gt;Hello {0}.&amp;lt;/div&gt;&quot;);
+t.{@link #append}('some-element', ['foo']);
+   &lt;/code&gt;&lt;/pre&gt;
+ * &lt;li&gt;&lt;tt&gt;Array&lt;/tt&gt; : &lt;/li&gt;
+ * An Array will be combined with &lt;code&gt;join('')&lt;/code&gt;.
+&lt;pre&gt;&lt;code&gt;
+var t = new Ext.Template([
+    '&amp;lt;div name=&quot;{id}&quot;&amp;gt;',
+        '&amp;lt;span class=&quot;{cls}&quot;&amp;gt;{name:trim} {value:ellipsis(10)}&amp;lt;/span&amp;gt;',
+    '&amp;lt;/div&amp;gt;',
+]);
+t.{@link #compile}();
+t.{@link #append}('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});
+   &lt;/code&gt;&lt;/pre&gt;
+ * &lt;/ul&gt;&lt;/div&gt;&lt;/li&gt;
+ * &lt;li&gt;&lt;b&gt;multiple arguments&lt;/b&gt; : String, Object, Array, ...
+ * &lt;div class=&quot;sub-desc&quot;&gt;
+ * Multiple arguments will be combined with &lt;code&gt;join('')&lt;/code&gt;.
+ * &lt;pre&gt;&lt;code&gt;
+var t = new Ext.Template(
+    '&amp;lt;div name=&quot;{id}&quot;&amp;gt;',
+        '&amp;lt;span class=&quot;{cls}&quot;&amp;gt;{name} {value}&amp;lt;/span&amp;gt;',
+    '&amp;lt;/div&amp;gt;',
+    // a configuration object:
+    {
+        compiled: true,      // {@link #compile} immediately
+    }
+);
+   &lt;/code&gt;&lt;/pre&gt;
+ * &lt;p&gt;&lt;b&gt;Notes&lt;/b&gt;:&lt;/p&gt;
+ * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
+ * &lt;li&gt;For a list of available format functions, see {@link Ext.util.Format}.&lt;/li&gt;
+ * &lt;li&gt;&lt;code&gt;disableFormats&lt;/code&gt; reduces &lt;code&gt;{@link #apply}&lt;/code&gt; time
+ * when no formatting is required.&lt;/li&gt;
+ * &lt;/ul&gt;&lt;/div&gt;
+ * &lt;/div&gt;&lt;/li&gt;
+ * &lt;/ul&gt;&lt;/div&gt;
+ * @param {Mixed} config
+ */
+
+Ext.define('Ext.Template', {
+
+    /* Begin Definitions */
+
+    requires: ['Ext.core.DomHelper', 'Ext.util.Format'],
+
+    statics: {
+<span id='Ext-Template-method-from'>        /**
+</span>         * Creates a template from the passed element's value (&lt;i&gt;display:none&lt;/i&gt; textarea, preferred) or innerHTML.
+         * @param {String/HTMLElement} el A DOM element or its id
+         * @param {Object} config A configuration object
+         * @return {Ext.Template} The created template
+         * @static
+         */
+        from: function(el, config) {
+            el = Ext.getDom(el);
+            return new this(el.value || el.innerHTML, config || '');
+        }
+    },
+
+    /* End Definitions */
+
+    constructor: function(html) {
+        var me = this,
+            args = arguments,
+            buffer = [],
+            i = 0,
+            length = args.length,
+            value;
+
+        me.initialConfig = {};
+
+        if (length &gt; 1) {
+            for (; i &lt; length; i++) {
+                value = args[i];
+                if (typeof value == 'object') {
+                    Ext.apply(me.initialConfig, value);
+                    Ext.apply(me, value);
+                } else {
+                    buffer.push(value);
+                }
+            }
+            html = buffer.join('');
+        } else {
+            if (Ext.isArray(html)) {
+                buffer.push(html.join(''));
+            } else {
+                buffer.push(html);
+            }
+        }
+
+        // @private
+        me.html = buffer.join('');
+
+        if (me.compiled) {
+            me.compile();
+        }
+    },
+    isTemplate: true,
+<span id='Ext-Template-cfg-disableFormats'>    /**
+</span>     * @cfg {Boolean} disableFormats true to disable format functions in the template. If the template doesn't contain format functions, setting
+     * disableFormats to true will reduce apply time (defaults to false)
+     */
+    disableFormats: false,
+
+    re: /\{([\w\-]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
+<span id='Ext-Template-method-applyTemplate'>    /**
+</span>     * Returns an HTML fragment of this template with the specified values applied.
+     * @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'})
+     * @return {String} The HTML fragment
+     * @hide repeat doc
+     */
+    applyTemplate: function(values) {
+        var me = this,
+            useFormat = me.disableFormats !== true,
+            fm = Ext.util.Format,
+            tpl = me;
+
+        if (me.compiled) {
+            return me.compiled(values);
+        }
+        function fn(m, name, format, args) {
+            if (format &amp;&amp; useFormat) {
+                if (args) {
+                    args = [values[name]].concat(Ext.functionFactory('return ['+ args +'];')());
+                } else {
+                    args = [values[name]];
+                }
+                if (format.substr(0, 5) == &quot;this.&quot;) {
+                    return tpl[format.substr(5)].apply(tpl, args);
+                }
+                else {
+                    return fm[format].apply(fm, args);
+                }
+            }
+            else {
+                return values[name] !== undefined ? values[name] : &quot;&quot;;
+            }
+        }
+        return me.html.replace(me.re, fn);
+    },
+
+<span id='Ext-Template-method-set'>    /**
+</span>     * Sets the HTML used as the template and optionally compiles it.
+     * @param {String} html
+     * @param {Boolean} compile (optional) True to compile the template (defaults to undefined)
+     * @return {Ext.Template} this
+     */
+    set: function(html, compile) {
+        var me = this;
+        me.html = html;
+        me.compiled = null;
+        return compile ? me.compile() : me;
+    },
+
+    compileARe: /\\/g,
+    compileBRe: /(\r\n|\n)/g,
+    compileCRe: /'/g,
+<span id='Ext-Template-method-compile'>    /**
+</span>     * Compiles the template into an internal function, eliminating the RegEx overhead.
+     * @return {Ext.Template} this
+     * @hide repeat doc
+     */
+    compile: function() {
+        var me = this,
+            fm = Ext.util.Format,
+            useFormat = me.disableFormats !== true,
+            body, bodyReturn;
+
+        function fn(m, name, format, args) {
+            if (format &amp;&amp; useFormat) {
+                args = args ? ',' + args: &quot;&quot;;
+                if (format.substr(0, 5) != &quot;this.&quot;) {
+                    format = &quot;fm.&quot; + format + '(';
+                }
+                else {
+                    format = 'this.' + format.substr(5) + '(';
+                }
+            }
+            else {
+                args = '';
+                format = &quot;(values['&quot; + name + &quot;'] == undefined ? '' : &quot;;
+            }
+            return &quot;',&quot; + format + &quot;values['&quot; + name + &quot;']&quot; + args + &quot;) ,'&quot;;
+        }
+
+        bodyReturn = me.html.replace(me.compileARe, '\\\\').replace(me.compileBRe, '\\n').replace(me.compileCRe, &quot;\\'&quot;).replace(me.re, fn);
+        body = &quot;this.compiled = function(values){ return ['&quot; + bodyReturn + &quot;'].join('');};&quot;;
+        eval(body);
+        return me;
+    },
+
+<span id='Ext-Template-method-insertFirst'>    /**
+</span>     * Applies the supplied values to the template and inserts the new node(s) as the first child of el.
+     * @param {Mixed} el The context element
+     * @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'})
+     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
+     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     */
+    insertFirst: function(el, values, returnElement) {
+        return this.doInsert('afterBegin', el, values, returnElement);
+    },
+
+<span id='Ext-Template-method-insertBefore'>    /**
+</span>     * Applies the supplied values to the template and inserts the new node(s) before el.
+     * @param {Mixed} el The context element
+     * @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'})
+     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
+     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     */
+    insertBefore: function(el, values, returnElement) {
+        return this.doInsert('beforeBegin', el, values, returnElement);
+    },
+
+<span id='Ext-Template-method-insertAfter'>    /**
+</span>     * Applies the supplied values to the template and inserts the new node(s) after el.
+     * @param {Mixed} el The context element
+     * @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'})
+     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
+     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     */
+    insertAfter: function(el, values, returnElement) {
+        return this.doInsert('afterEnd', el, values, returnElement);
+    },
+
+<span id='Ext-Template-method-append'>    /**
+</span>     * Applies the supplied &lt;code&gt;values&lt;/code&gt; to the template and appends
+     * the new node(s) to the specified &lt;code&gt;el&lt;/code&gt;.
+     * &lt;p&gt;For example usage {@link #Template see the constructor}.&lt;/p&gt;
+     * @param {Mixed} el The context element
+     * @param {Object/Array} values
+     * The template values. Can be an array if the params are numeric (i.e. &lt;code&gt;{0}&lt;/code&gt;)
+     * or an object (i.e. &lt;code&gt;{foo: 'bar'}&lt;/code&gt;).
+     * @param {Boolean} returnElement (optional) true to return an Ext.core.Element (defaults to undefined)
+     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     */
+    append: function(el, values, returnElement) {
+        return this.doInsert('beforeEnd', el, values, returnElement);
+    },
+
+    doInsert: function(where, el, values, returnEl) {
+        el = Ext.getDom(el);
+        var newNode = Ext.core.DomHelper.insertHtml(where, el, this.applyTemplate(values));
+        return returnEl ? Ext.get(newNode, true) : newNode;
+    },
+
+<span id='Ext-Template-method-overwrite'>    /**
+</span>     * Applies the supplied values to the template and overwrites the content of el with the new node(s).
+     * @param {Mixed} el The context element
+     * @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'})
+     * @param {Boolean} returnElement (optional) true to return a Ext.core.Element (defaults to undefined)
+     * @return {HTMLElement/Ext.core.Element} The new node or Element
+     */
+    overwrite: function(el, values, returnElement) {
+        el = Ext.getDom(el);
+        el.innerHTML = this.applyTemplate(values);
+        return returnElement ? Ext.get(el.firstChild, true) : el.firstChild;
+    }
+}, function() {
+
+<span id='Ext-Template-method-apply'>    /**
+</span>     * Alias for {@link #applyTemplate}
+     * Returns an HTML fragment of this template with the specified &lt;code&gt;values&lt;/code&gt; applied.
+     * @param {Object/Array} values
+     * The template values. Can be an array if the params are numeric (i.e. &lt;code&gt;{0}&lt;/code&gt;)
+     * or an object (i.e. &lt;code&gt;{foo: 'bar'}&lt;/code&gt;).
+     * @return {String} The HTML fragment
+     * @member Ext.Template
+     * @method apply
+     */
+    this.createAlias('apply', 'applyTemplate');
+});
+</pre></pre></body></html>
\ No newline at end of file