Upgrade to ExtJS 3.2.1 - Released 04/27/2010

[extjs.git] / docs / output / Ext.XTemplate.html

diff --git a/docs/output/Ext.XTemplate.html b/docs/output/Ext.XTemplate.html
index 5903e7e..8118972 100644 (file)
--- a/docs/output/Ext.XTemplate.html
+++ b/docs/output/Ext.XTemplate.html
@@ -1,4 +1,4 @@
-<div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.Template.html" ext:member="" ext:cls="Ext.Template">Template</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">XTemplate</pre></div><h1>Class <a href="source/XTemplate.html#cls-Ext.XTemplate">Ext.XTemplate</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">XTemplate.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/XTemplate.html#cls-Ext.XTemplate">XTemplate</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.Template.html" ext:cls="Ext.Template" ext:member="">Template</a></td></tr></table><div class="description"><p>A template class that supports advanced functionality like:<div class="mdetail-params"><ul>
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.XTemplate-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.XTemplate-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.XTemplate-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.XTemplate-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.XTemplate"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.Template.html" ext:member="" ext:cls="Ext.Template">Template</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">XTemplate</pre></div><h1>Class <a href="source/XTemplate.html#cls-Ext.XTemplate">Ext.XTemplate</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/XTemplate.html#cls-Ext.XTemplate">XTemplate.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/XTemplate.html#cls-Ext.XTemplate">XTemplate</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.Template.html" ext:cls="Ext.Template" ext:member="">Template</a></td></tr></table><div class="description"><p>A template class that supports advanced functionality like:<div class="mdetail-params"><ul>

 <li>Autofilling arrays using templates and sub-templates</li>
 <li>Conditional processing with basic comparison operators</li>
 <li>Basic math function support</li>
 <li>Autofilling arrays using templates and sub-templates</li>
 <li>Conditional processing with basic comparison operators</li>
 <li>Basic math function support</li>


@@ -19,22 +19,22 @@ the API, but are supported in the templates that can be created</li>
 </ul></div></p>
 <p>For example usage <a href="output/Ext.XTemplate.html#Ext.XTemplate-XTemplate" ext:member="XTemplate" ext:cls="Ext.XTemplate">see the constructor</a>.</p></div><div class="hr"></div><a id="Ext.XTemplate-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Template-compiled"></a><b><a href="source/Template.html#cfg-Ext.Template-compiled">compiled</a></b> : Boolean<div class="mdesc">Specify <tt>true</tt> to compile the template
 immediately (see <code><a href="output/Ext.Template.html#Ext.Template-compile" ext:member="compile" ext:cls="Ext.Template">compile</a></code>).
 </ul></div></p>
 <p>For example usage <a href="output/Ext.XTemplate.html#Ext.XTemplate-XTemplate" ext:member="XTemplate" ext:cls="Ext.XTemplate">see the constructor</a>.</p></div><div class="hr"></div><a id="Ext.XTemplate-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Template-compiled"></a><b><a href="source/Template.html#cfg-Ext.Template-compiled">compiled</a></b> : Boolean<div class="mdesc">Specify <tt>true</tt> to compile the template
 immediately (see <code><a href="output/Ext.Template.html#Ext.Template-compile" ext:member="compile" ext:cls="Ext.Template">compile</a></code>).

-Defaults to <tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.Template.html#compiled" ext:member="#compiled" ext:cls="Ext.Template">Template</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Template-disableFormats"></a><b><a href="source/Template-more.html#cfg-Ext.Template-disableFormats">disableFormats</a></b> : Boolean<div class="mdesc"><div class="short">Specify true to disable format&#13;
-functions in the template. If the template does not contain&#13;
-format functions, settin...</div><div class="long">Specify <tt>true</tt> to disable format\r
-functions in the template. If the template does not contain\r
-<a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">format functions</a>, setting <code>disableFormats</code>\r
-to true will reduce <code><a href="output/Ext.Template.html#Ext.Template-apply" ext:member="apply" ext:cls="Ext.Template">apply</a></code> time. Defaults to <tt>false</tt>.\r
-<pre><code><b>var</b> t = <b>new</b> Ext.Template(\r
-    <em>'&lt;div name=<em>"{id}"</em>&gt;'</em>,\r
-        <em>'&lt;span class=<em>"{cls}"</em>&gt;{name} {value}&lt;/span&gt;'</em>,\r
-    <em>'&lt;/div&gt;'</em>,\r
-    {\r
-        compiled: true,      <i>// <a href="output/Ext.Template.html#Ext.Template-compile" ext:member="compile" ext:cls="Ext.Template">compile</a> immediately\r</i>
-        disableFormats: true <i>// reduce <code><a href="output/Ext.Template.html#Ext.Template-apply" ext:member="apply" ext:cls="Ext.Template">apply</a></i></code> time since no formatting\r
-    }    \r
-);\r
-</code></pre>\r
+Defaults to <tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.Template.html#compiled" ext:member="#compiled" ext:cls="Ext.Template">Template</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Template-disableFormats"></a><b><a href="source/Template-more.html#cfg-Ext.Template-disableFormats">disableFormats</a></b> : Boolean<div class="mdesc"><div class="short">Specify true to disable format
+functions in the template. If the template does not contain
+format functions, setting ...</div><div class="long">Specify <tt>true</tt> to disable format
+functions in the template. If the template does not contain
+<a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">format functions</a>, setting <code>disableFormats</code>
+to true will reduce <code><a href="output/Ext.Template.html#Ext.Template-apply" ext:member="apply" ext:cls="Ext.Template">apply</a></code> time. Defaults to <tt>false</tt>.
+<pre><code><b>var</b> t = <b>new</b> Ext.Template(
+    <em>'&lt;div name=<em>"{id}"</em>&gt;'</em>,
+        <em>'&lt;span class=<em>"{cls}"</em>&gt;{name} {value}&lt;/span&gt;'</em>,
+    <em>'&lt;/div&gt;'</em>,
+    {
+        compiled: true,      <i>// <a href="output/Ext.Template.html#Ext.Template-compile" ext:member="compile" ext:cls="Ext.Template">compile</a> immediately</i>
+        disableFormats: true <i>// reduce <code><a href="output/Ext.Template.html#Ext.Template-apply" ext:member="apply" ext:cls="Ext.Template">apply</a></i></code> time since no formatting
+    }
+);
+</code></pre>

 For a list of available format functions, see <a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">Ext.util.Format</a>.</div></div></td><td class="msource"><a href="output/Ext.Template.html#disableFormats" ext:member="#disableFormats" ext:cls="Ext.Template">Template</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Template-re"></a><b><a href="source/Template.html#cfg-Ext.Template-re">re</a></b> : RegExp<div class="mdesc"><div class="short">The regular expression used to match template variables.
 Defaults to:re : /\{([\w-]+)\}/g                            ...</div><div class="long">The regular expression used to match template variables.
 Defaults to:<pre><code>re : /\{([\w-]+)\}/g                                     <i>// <b>for</b> Ext Core</i>
 For a list of available format functions, see <a href="output/Ext.util.Format.html" ext:cls="Ext.util.Format">Ext.util.Format</a>.</div></div></td><td class="msource"><a href="output/Ext.Template.html#disableFormats" ext:member="#disableFormats" ext:cls="Ext.Template">Template</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Template-re"></a><b><a href="source/Template.html#cfg-Ext.Template-re">re</a></b> : RegExp<div class="mdesc"><div class="short">The regular expression used to match template variables.
 Defaults to:re : /\{([\w-]+)\}/g                            ...</div><div class="long">The regular expression used to match template variables.
 Defaults to:<pre><code>re : /\{([\w-]+)\}/g                                     <i>// <b>for</b> Ext Core</i>


@@ -45,7 +45,7 @@ examples d...</div><div class="long">The <a href="output/Ext.Template.html#Ext.T
 the acceptable parameters to pass to the constructor. The following
 examples demonstrate all of the supported features.</p>
 <div class="mdetail-params"><ul>
 the acceptable parameters to pass to the constructor. The following
 examples demonstrate all of the supported features.</p>
 <div class="mdetail-params"><ul>

-<li><b><u>Sample Data</u></b> 
+<li><b><u>Sample Data</u></b>

 <div class="sub-desc">
 <p>This is the data object used for reference in each code example:</p>
 <pre><code><b>var</b> data = {
 <div class="sub-desc">
 <p>This is the data object used for reference in each code example:</p>
 <pre><code><b>var</b> data = {


@@ -71,7 +71,7 @@ examples demonstrate all of the supported features.</p>
 };</code></pre>
 </div>
 </li>
 };</code></pre>
 </div>
 </li>

-<li><b><u>Auto filling of arrays</u></b> 
+<li><b><u>Auto filling of arrays</u></b>

 <div class="sub-desc">
 <p>The <b><tt>tpl</tt></b> tag and the <b><tt>for</tt></b> operator are used
 to process the provided data object:
 <div class="sub-desc">
 <p>The <b><tt>tpl</tt></b> tag and the <b><tt>for</tt></b> operator are used
 to process the provided data object:


@@ -132,7 +132,7 @@ you can access the parent object's members via the <b><tt>parent</tt></b> object
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>

-<li><b><u>Conditional processing with basic comparison operators</u></b> 
+<li><b><u>Conditional processing with basic comparison operators</u></b>

 <div class="sub-desc">
 <p>The <b><tt>tpl</tt></b> tag and the <b><tt>if</tt></b> operator are used
 to provide conditional checks for deciding whether or not to render specific
 <div class="sub-desc">
 <p>The <b><tt>tpl</tt></b> tag and the <b><tt>if</tt></b> operator are used
 to provide conditional checks for deciding whether or not to render specific


@@ -163,7 +163,7 @@ Using the sample data above:
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>

-<li><b><u>Basic math support</u></b> 
+<li><b><u>Basic math support</u></b>

 <div class="sub-desc">
 <p>The following basic math operators may be applied directly on numeric
 data values:</p><pre>
 <div class="sub-desc">
 <p>The following basic math operators may be applied directly on numeric
 data values:</p><pre>


@@ -184,7 +184,7 @@ For example:
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>

-<li><b><u>Execute arbitrary inline code with special built-in template variables</u></b> 
+<li><b><u>Execute arbitrary inline code with special built-in template variables</u></b>

 <div class="sub-desc">
 <p>Anything between <code>{[ ... ]}</code> is considered code to be executed
 in the scope of the template. There are some special variables available in that code:
 <div class="sub-desc">
 <p>Anything between <code>{[ ... ]}</code> is considered code to be executed
 in the scope of the template. There are some special variables available in that code:


@@ -213,7 +213,7 @@ This example demonstrates basic row striping using an inline code block and the
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>
 tpl.overwrite(panel.body, data);</code></pre>
 </div>
 </li>

-<li><b><u>Template member functions</u></b> 
+<li><b><u>Template member functions</u></b>

 <div class="sub-desc">
 <p>One or more member functions can be specified in a configuration
 object passed into the XTemplate constructor for more complex processing:</p>
 <div class="sub-desc">
 <p>One or more member functions can be specified in a configuration
 object passed into the XTemplate constructor for more complex processing:</p>