1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext.Template-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext.Template-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext.Template-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="bookmark" href="../docs/?class=Ext.Template"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
7 | </div> |
---|
8 | <h1>Class Ext.Template</h1> |
---|
9 | <table cellspacing="0"> |
---|
10 | <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr> |
---|
11 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Template.js" target="_blank">Template.js</a></td></tr> |
---|
12 | <tr><td class="label">Class:</td><td class="hd-info">Template</td></tr> |
---|
13 | <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.XTemplate" href="output/Ext.XTemplate.html">XTemplate</a></td></tr> |
---|
14 | <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr> |
---|
15 | </table> |
---|
16 | <div class="description"> |
---|
17 | * |
---|
18 | Represents an HTML fragment template. Templates can be precompiled for greater performance. |
---|
19 | 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 /> |
---|
20 | Usage: |
---|
21 | <pre><code>var t = <b>new</b> Ext.Template( |
---|
22 | <em>'<div name="{id}">'</em>, |
---|
23 | <em>'<span class="{cls}">{name:trim} {value:ellipsis(10)}</span>'</em>, |
---|
24 | <em>'</div>'</em> |
---|
25 | ); |
---|
26 | t.append(<em>'some-element'</em>, {id: <em>'myid'</em>, cls: <em>'myclass'</em>, name: <em>'foo'</em>, value: <em>'bar'</em>});</code></pre> </div> |
---|
27 | |
---|
28 | <div class="hr"></div> |
---|
29 | <a id="Ext.Template-props"></a> |
---|
30 | <h2>Public Properties</h2> |
---|
31 | <table cellspacing="0" class="member-table"> |
---|
32 | <tr> |
---|
33 | <th class="sig-header" colspan="2">Property</th> |
---|
34 | <th class="msource-header">Defined By</th> |
---|
35 | </tr> |
---|
36 | <tr class="property-row"> |
---|
37 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
38 | <td class="sig"> |
---|
39 | <a id="Ext.Template-disableFormats"></a> |
---|
40 | <b>disableFormats</b> : Boolean <div class="mdesc"> |
---|
41 | True to disable format functions (defaults to false) </div> |
---|
42 | </td> |
---|
43 | <td class="msource">Template</td> |
---|
44 | </tr> |
---|
45 | <tr class="property-row alt"> |
---|
46 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
47 | <td class="sig"> |
---|
48 | <a id="Ext.Template-re"></a> |
---|
49 | <b>re</b> : RegExp <div class="mdesc"> |
---|
50 | The regular expression used to match template variables </div> |
---|
51 | </td> |
---|
52 | <td class="msource">Template</td> |
---|
53 | </tr> |
---|
54 | </table> |
---|
55 | <a id="Ext.Template-methods"></a> |
---|
56 | <h2>Public Methods</h2> |
---|
57 | <table cellspacing="0" class="member-table"> |
---|
58 | <tr> |
---|
59 | <th class="sig-header" colspan="2">Method</th> |
---|
60 | <th class="msource-header">Defined By</th> |
---|
61 | </tr> |
---|
62 | <tr class="method-row expandable"> |
---|
63 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
64 | <td class="sig"> |
---|
65 | <a id="Ext.Template-Template"></a> |
---|
66 | <b>Template</b>( <code>String/Array html</code> ) <div class="mdesc"> |
---|
67 | <div class="short"></div> |
---|
68 | <div class="long"> |
---|
69 | <div class="mdetail-params"> |
---|
70 | <strong>Parameters:</strong> |
---|
71 | <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> |
---|
72 | <strong>Returns:</strong> |
---|
73 | <ul> |
---|
74 | <li><code></code></li> |
---|
75 | </ul> |
---|
76 | </div> |
---|
77 | </div> |
---|
78 | </div> |
---|
79 | </td> |
---|
80 | <td class="msource">Template</td> |
---|
81 | </tr> |
---|
82 | <tr class="method-row alt expandable"> |
---|
83 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
84 | <td class="sig"> |
---|
85 | <a id="Ext.Template-Template.from"></a> |
---|
86 | <b>Template.from</b>( <code>String/HTMLElement el</code>, <code>Object config</code> ) : Ext.Template <div class="mdesc"> |
---|
87 | <div class="short"><static> Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.</div> |
---|
88 | <div class="long"> |
---|
89 | <static> Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML. <div class="mdetail-params"> |
---|
90 | <strong>Parameters:</strong> |
---|
91 | <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> |
---|
92 | <strong>Returns:</strong> |
---|
93 | <ul> |
---|
94 | <li><code>Ext.Template</code><div class="sub-desc">The created template</div></li> |
---|
95 | </ul> |
---|
96 | </div> |
---|
97 | </div> |
---|
98 | </div> |
---|
99 | </td> |
---|
100 | <td class="msource">Template</td> |
---|
101 | </tr> |
---|
102 | <tr class="method-row expandable"> |
---|
103 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
104 | <td class="sig"> |
---|
105 | <a id="Ext.Template-append"></a> |
---|
106 | <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"> |
---|
107 | <div class="short">Applies the supplied values to the template and appends the new node(s) to el.</div> |
---|
108 | <div class="long"> |
---|
109 | Applies the supplied values to the template and appends the new node(s) to el. <div class="mdetail-params"> |
---|
110 | <strong>Parameters:</strong> |
---|
111 | <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> |
---|
112 | <strong>Returns:</strong> |
---|
113 | <ul> |
---|
114 | <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li> |
---|
115 | </ul> |
---|
116 | </div> |
---|
117 | </div> |
---|
118 | </div> |
---|
119 | </td> |
---|
120 | <td class="msource">Template</td> |
---|
121 | </tr> |
---|
122 | <tr class="method-row alt expandable"> |
---|
123 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
124 | <td class="sig"> |
---|
125 | <a id="Ext.Template-apply"></a> |
---|
126 | <b>apply</b>( <code>Object/Array values</code> ) : String <div class="mdesc"> |
---|
127 | <div class="short">Alias for <a ext:cls="Ext.Template" ext:member="applyTemplate" href="output/Ext.Template.html#applyTemplate">applyTemplate</a> |
---|
128 | Returns an HTML fragment of this template with the specified values applied.</div> |
---|
129 | <div class="long"> |
---|
130 | Alias for <a ext:cls="Ext.Template" ext:member="applyTemplate" href="output/Ext.Template.html#applyTemplate">applyTemplate</a> |
---|
131 | Returns an HTML fragment of this template with the specified values applied. <div class="mdetail-params"> |
---|
132 | <strong>Parameters:</strong> |
---|
133 | <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> |
---|
134 | <strong>Returns:</strong> |
---|
135 | <ul> |
---|
136 | <li><code>String</code><div class="sub-desc">The HTML fragment</div></li> |
---|
137 | </ul> |
---|
138 | </div> |
---|
139 | </div> |
---|
140 | </div> |
---|
141 | </td> |
---|
142 | <td class="msource">Template</td> |
---|
143 | </tr> |
---|
144 | <tr class="method-row expandable"> |
---|
145 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
146 | <td class="sig"> |
---|
147 | <a id="Ext.Template-applyTemplate"></a> |
---|
148 | <b>applyTemplate</b>( <code>Object/Array values</code> ) : String <div class="mdesc"> |
---|
149 | <div class="short">Returns an HTML fragment of this template with the specified values applied.</div> |
---|
150 | <div class="long"> |
---|
151 | Returns an HTML fragment of this template with the specified values applied. <div class="mdetail-params"> |
---|
152 | <strong>Parameters:</strong> |
---|
153 | <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> |
---|
154 | <strong>Returns:</strong> |
---|
155 | <ul> |
---|
156 | <li><code>String</code><div class="sub-desc">The HTML fragment</div></li> |
---|
157 | </ul> |
---|
158 | </div> |
---|
159 | </div> |
---|
160 | </div> |
---|
161 | </td> |
---|
162 | <td class="msource">Template</td> |
---|
163 | </tr> |
---|
164 | <tr class="method-row alt expandable"> |
---|
165 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
166 | <td class="sig"> |
---|
167 | <a id="Ext.Template-compile"></a> |
---|
168 | <b>compile</b>() : Ext.Template <div class="mdesc"> |
---|
169 | <div class="short">Compiles the template into an internal function, eliminating the RegEx overhead.</div> |
---|
170 | <div class="long"> |
---|
171 | Compiles the template into an internal function, eliminating the RegEx overhead. <div class="mdetail-params"> |
---|
172 | <strong>Parameters:</strong> |
---|
173 | <ul><li>None.</li> </ul> |
---|
174 | <strong>Returns:</strong> |
---|
175 | <ul> |
---|
176 | <li><code>Ext.Template</code><div class="sub-desc">this</div></li> |
---|
177 | </ul> |
---|
178 | </div> |
---|
179 | </div> |
---|
180 | </div> |
---|
181 | </td> |
---|
182 | <td class="msource">Template</td> |
---|
183 | </tr> |
---|
184 | <tr class="method-row expandable"> |
---|
185 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
186 | <td class="sig"> |
---|
187 | <a id="Ext.Template-insertAfter"></a> |
---|
188 | <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"> |
---|
189 | <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div> |
---|
190 | <div class="long"> |
---|
191 | Applies the supplied values to the template and inserts the new node(s) after el. <div class="mdetail-params"> |
---|
192 | <strong>Parameters:</strong> |
---|
193 | <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> |
---|
194 | <strong>Returns:</strong> |
---|
195 | <ul> |
---|
196 | <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li> |
---|
197 | </ul> |
---|
198 | </div> |
---|
199 | </div> |
---|
200 | </div> |
---|
201 | </td> |
---|
202 | <td class="msource">Template</td> |
---|
203 | </tr> |
---|
204 | <tr class="method-row alt expandable"> |
---|
205 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
206 | <td class="sig"> |
---|
207 | <a id="Ext.Template-insertBefore"></a> |
---|
208 | <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"> |
---|
209 | <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div> |
---|
210 | <div class="long"> |
---|
211 | Applies the supplied values to the template and inserts the new node(s) before el. <div class="mdetail-params"> |
---|
212 | <strong>Parameters:</strong> |
---|
213 | <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> |
---|
214 | <strong>Returns:</strong> |
---|
215 | <ul> |
---|
216 | <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li> |
---|
217 | </ul> |
---|
218 | </div> |
---|
219 | </div> |
---|
220 | </div> |
---|
221 | </td> |
---|
222 | <td class="msource">Template</td> |
---|
223 | </tr> |
---|
224 | <tr class="method-row expandable"> |
---|
225 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
226 | <td class="sig"> |
---|
227 | <a id="Ext.Template-insertFirst"></a> |
---|
228 | <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"> |
---|
229 | <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div> |
---|
230 | <div class="long"> |
---|
231 | Applies the supplied values to the template and inserts the new node(s) as the first child of el. <div class="mdetail-params"> |
---|
232 | <strong>Parameters:</strong> |
---|
233 | <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> |
---|
234 | <strong>Returns:</strong> |
---|
235 | <ul> |
---|
236 | <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li> |
---|
237 | </ul> |
---|
238 | </div> |
---|
239 | </div> |
---|
240 | </div> |
---|
241 | </td> |
---|
242 | <td class="msource">Template</td> |
---|
243 | </tr> |
---|
244 | <tr class="method-row alt expandable"> |
---|
245 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
246 | <td class="sig"> |
---|
247 | <a id="Ext.Template-overwrite"></a> |
---|
248 | <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"> |
---|
249 | <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div> |
---|
250 | <div class="long"> |
---|
251 | Applies the supplied values to the template and overwrites the content of el with the new node(s). <div class="mdetail-params"> |
---|
252 | <strong>Parameters:</strong> |
---|
253 | <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> |
---|
254 | <strong>Returns:</strong> |
---|
255 | <ul> |
---|
256 | <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li> |
---|
257 | </ul> |
---|
258 | </div> |
---|
259 | </div> |
---|
260 | </div> |
---|
261 | </td> |
---|
262 | <td class="msource">Template</td> |
---|
263 | </tr> |
---|
264 | <tr class="method-row expandable"> |
---|
265 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
266 | <td class="sig"> |
---|
267 | <a id="Ext.Template-set"></a> |
---|
268 | <b>set</b>( <code>String html</code>, <span class="optional" title="Optional">[<code>Boolean compile</code>]</span> ) : Ext.Template <div class="mdesc"> |
---|
269 | <div class="short">Sets the HTML used as the template and optionally compiles it.</div> |
---|
270 | <div class="long"> |
---|
271 | Sets the HTML used as the template and optionally compiles it. <div class="mdetail-params"> |
---|
272 | <strong>Parameters:</strong> |
---|
273 | <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> |
---|
274 | <strong>Returns:</strong> |
---|
275 | <ul> |
---|
276 | <li><code>Ext.Template</code><div class="sub-desc">this</div></li> |
---|
277 | </ul> |
---|
278 | </div> |
---|
279 | </div> |
---|
280 | </div> |
---|
281 | </td> |
---|
282 | <td class="msource">Template</td> |
---|
283 | </tr> |
---|
284 | </table> |
---|
285 | <a id="Ext.Template-events"></a> |
---|
286 | <h2>Public Events</h2> |
---|
287 | <div class="no-members">This class has no public events.</div> |
---|
288 | </div> |
---|