123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286 |
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.Template-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.Template-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.Template-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.Template"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.Template</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="../src/Template.js" target="_blank">Template.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">Template</td></tr>
- <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.XTemplate" href="output/Ext.XTemplate.html">XTemplate</a></td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- Represents an HTML fragment template. Templates can be precompiled for greater performance.
- For a list of available format functions, see <a ext:cls="Ext.util.Format" href="output/Ext.util.Format.html">Ext.util.Format</a>.<br />
- Usage:
- <pre><code>var t = <b>new</b> Ext.Template(
- <em>'<div name="{id}">'</em>,
- <em>'<span class="{cls}">{name:trim} {value:ellipsis(10)}</span>'</em>,
- <em>'</div>'</em>
- );
- t.append(<em>'some-element'</em>, {id: <em>'myid'</em>, cls: <em>'myclass'</em>, name: <em>'foo'</em>, value: <em>'bar'</em>});</code></pre>
- For more information see this blog post with examples: <a href="http://www.jackslocum.com/blog/2006/10/06/domhelper-create-elements-using-dom-html-fragments-or-templates/">DomHelper - Create Elements using DOM, HTML fragments and Templates</a>. </div>
-
- <div class="hr"></div>
- <a id="Ext.Template-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-disableFormats"></a>
- <b>disableFormats</b> : Boolean <div class="mdesc">
- True to disable format functions (defaults to false) </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="property-row alt">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-re"></a>
- <b>re</b> : RegExp <div class="mdesc">
- The regular expression used to match template variables </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- </table>
- <a id="Ext.Template-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-Template"></a>
- <b>Template</b>( <code>String/Array html</code> ) <div class="mdesc">
- <div class="short"></div>
- <div class="long">
- <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>html</code> : String/Array<div class="sub-desc">The HTML fragment or an array of fragments to join("") or multiple arguments to join("")</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code></code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-Template.from"></a>
- <b>Template.from</b>( <code>String/HTMLElement el</code>, <code>Object config</code> ) : Ext.Template <div class="mdesc">
- <div class="short"><static> Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.</div>
- <div class="long">
- <static> Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc">A DOM element or its id</div></li><li><code>config</code> : Object<div class="sub-desc">A configuration object</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>Ext.Template</code><div class="sub-desc">The created template</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-append"></a>
- <b>append</b>( <code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">
- <div class="short">Applies the supplied values to the template and appends the new node(s) to el.</div>
- <div class="long">
- Applies the supplied values to the template and appends the new node(s) to el. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>values</code> : Object/Array<div class="sub-desc">The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element (defaults to undefined)</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-apply"></a>
- <b>apply</b>() : void <div class="mdesc">
- <div class="short">Alias for <a ext:cls="Ext.Template" ext:member="applyTemplate" href="output/Ext.Template.html#applyTemplate">applyTemplate</a></div>
- <div class="long">
- Alias for <a ext:cls="Ext.Template" ext:member="applyTemplate" href="output/Ext.Template.html#applyTemplate">applyTemplate</a> <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li>None.</li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-applyTemplate"></a>
- <b>applyTemplate</b>( <code>Object/Array values</code> ) : String <div class="mdesc">
- <div class="short">Returns an HTML fragment of this template with the specified values applied.</div>
- <div class="long">
- Returns an HTML fragment of this template with the specified values applied. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>values</code> : Object/Array<div class="sub-desc">The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>String</code><div class="sub-desc">The HTML fragment</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-compile"></a>
- <b>compile</b>() : Ext.Template <div class="mdesc">
- <div class="short">Compiles the template into an internal function, eliminating the RegEx overhead.</div>
- <div class="long">
- Compiles the template into an internal function, eliminating the RegEx overhead. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li>None.</li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>Ext.Template</code><div class="sub-desc">this</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-insertAfter"></a>
- <b>insertAfter</b>( <code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">
- <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div>
- <div class="long">
- Applies the supplied values to the template and inserts the new node(s) after el. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>values</code> : Object/Array<div class="sub-desc">The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element (defaults to undefined)</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-insertBefore"></a>
- <b>insertBefore</b>( <code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">
- <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div>
- <div class="long">
- Applies the supplied values to the template and inserts the new node(s) before el. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>values</code> : Object/Array<div class="sub-desc">The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element (defaults to undefined)</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-insertFirst"></a>
- <b>insertFirst</b>( <code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">
- <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div>
- <div class="long">
- Applies the supplied values to the template and inserts the new node(s) as the first child of el. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>values</code> : Object/Array<div class="sub-desc">The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element (defaults to undefined)</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-overwrite"></a>
- <b>overwrite</b>( <code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span> ) : HTMLElement/Ext.Element <div class="mdesc">
- <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div>
- <div class="long">
- Applies the supplied values to the template and overwrites the content of el with the new node(s). <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>el</code> : Mixed<div class="sub-desc">The context element</div></li><li><code>values</code> : Object/Array<div class="sub-desc">The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</div></li><li><code>returnElement</code> : Boolean<div class="sub-desc">(optional) true to return a Ext.Element (defaults to undefined)</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.Template-set"></a>
- <b>set</b>( <code>String html</code>, <span class="optional" title="Optional">[<code>Boolean compile</code>]</span> ) : Ext.Template <div class="mdesc">
- <div class="short">Sets the HTML used as the template and optionally compiles it.</div>
- <div class="long">
- Sets the HTML used as the template and optionally compiles it. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>html</code> : String<div class="sub-desc"></div></li><li><code>compile</code> : Boolean<div class="sub-desc">(optional) True to compile the template (defaults to undefined)</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>Ext.Template</code><div class="sub-desc">this</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">Template</td>
- </tr>
- </table>
- <a id="Ext.Template-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
|