Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 aperonnet 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="../source/core/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 
            Represents an HTML fragment template. Templates can be precompiled for greater performance.
18 
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 />
19 
Usage:
20 
<pre><code>var t = <b>new</b> Ext.Template(
21 
    <em>'&lt;div name="{id}"&gt;'</em>,
22 
        <em>'&lt;span class="{cls}"&gt;{name:trim} {value:ellipsis(10)}&lt;/span&gt;'</em>,
23 
    <em>'&lt;/div&gt;'</em>
24 
);
25 
t.append(<em>'some-element'</em>, {id: <em>'myid'</em>, cls: <em>'myclass'</em>, name: <em>'foo'</em>, value: <em>'bar'</em>});</code></pre>
26 
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>
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">&nbsp;</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">&nbsp;</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">&nbsp;</a></td>
64 
        <td class="sig">
65 
        <a id="Ext.Template-Template"></a>
66 
            <b>Template</b>(&nbsp;<code>String/Array html</code>&nbsp;)            <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">&nbsp;</a></td>
84 
        <td class="sig">
85 
        <a id="Ext.Template-Template.from"></a>
86 
            <b>Template.from</b>(&nbsp;<code>String/HTMLElement el</code>, <code>Object config</code>&nbsp;) : Ext.Template            <div class="mdesc">
87 
                        <div class="short">&lt;static&gt; Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.</div>
88 
            <div class="long">
89 
                &lt;static&gt; 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">&nbsp;</a></td>
104 
        <td class="sig">
105 
        <a id="Ext.Template-append"></a>
106 
            <b>append</b>(&nbsp;<code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span>&nbsp;) : 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">&nbsp;</a></td>
124 
        <td class="sig">
125 
        <a id="Ext.Template-apply"></a>
126 
            <b>apply</b>() : void            <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></div>
128 
            <div class="long">
129 
                Alias for <a ext:cls="Ext.Template" ext:member="applyTemplate" href="output/Ext.Template.html#applyTemplate">applyTemplate</a>    <div class="mdetail-params">
130 
        <strong>Parameters:</strong>
131 
        <ul><li>None.</li>        </ul>
132 
        <strong>Returns:</strong>
133 
        <ul>
134 
            <li><code>void</code></li>
135 
        </ul>
136 
    </div>
137 
                </div>
138 
                        </div>
139 
        </td>
140 
        <td class="msource">Template</td>
141 
    </tr>
142 
        <tr class="method-row expandable">
143 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
144 
        <td class="sig">
145 
        <a id="Ext.Template-applyTemplate"></a>
146 
            <b>applyTemplate</b>(&nbsp;<code>Object/Array values</code>&nbsp;) : String            <div class="mdesc">
147 
                        <div class="short">Returns an HTML fragment of this template with the specified values applied.</div>
148 
            <div class="long">
149 
                Returns an HTML fragment of this template with the specified values applied.    <div class="mdetail-params">
150 
        <strong>Parameters:</strong>
151 
        <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>
152 
        <strong>Returns:</strong>
153 
        <ul>
154 
            <li><code>String</code><div class="sub-desc">The HTML fragment</div></li>
155 
        </ul>
156 
    </div>
157 
                </div>
158 
                        </div>
159 
        </td>
160 
        <td class="msource">Template</td>
161 
    </tr>
162 
        <tr class="method-row alt expandable">
163 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
164 
        <td class="sig">
165 
        <a id="Ext.Template-compile"></a>
166 
            <b>compile</b>() : Ext.Template            <div class="mdesc">
167 
                        <div class="short">Compiles the template into an internal function, eliminating the RegEx overhead.</div>
168 
            <div class="long">
169 
                Compiles the template into an internal function, eliminating the RegEx overhead.    <div class="mdetail-params">
170 
        <strong>Parameters:</strong>
171 
        <ul><li>None.</li>        </ul>
172 
        <strong>Returns:</strong>
173 
        <ul>
174 
            <li><code>Ext.Template</code><div class="sub-desc">this</div></li>
175 
        </ul>
176 
    </div>
177 
                </div>
178 
                        </div>
179 
        </td>
180 
        <td class="msource">Template</td>
181 
    </tr>
182 
        <tr class="method-row expandable">
183 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
184 
        <td class="sig">
185 
        <a id="Ext.Template-insertAfter"></a>
186 
            <b>insertAfter</b>(&nbsp;<code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span>&nbsp;) : HTMLElement/Ext.Element            <div class="mdesc">
187 
                        <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div>
188 
            <div class="long">
189 
                Applies the supplied values to the template and inserts the new node(s) after el.    <div class="mdetail-params">
190 
        <strong>Parameters:</strong>
191 
        <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>
192 
        <strong>Returns:</strong>
193 
        <ul>
194 
            <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
195 
        </ul>
196 
    </div>
197 
                </div>
198 
                        </div>
199 
        </td>
200 
        <td class="msource">Template</td>
201 
    </tr>
202 
        <tr class="method-row alt expandable">
203 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
204 
        <td class="sig">
205 
        <a id="Ext.Template-insertBefore"></a>
206 
            <b>insertBefore</b>(&nbsp;<code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span>&nbsp;) : HTMLElement/Ext.Element            <div class="mdesc">
207 
                        <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div>
208 
            <div class="long">
209 
                Applies the supplied values to the template and inserts the new node(s) before el.    <div class="mdetail-params">
210 
        <strong>Parameters:</strong>
211 
        <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>
212 
        <strong>Returns:</strong>
213 
        <ul>
214 
            <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
215 
        </ul>
216 
    </div>
217 
                </div>
218 
                        </div>
219 
        </td>
220 
        <td class="msource">Template</td>
221 
    </tr>
222 
        <tr class="method-row expandable">
223 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
224 
        <td class="sig">
225 
        <a id="Ext.Template-insertFirst"></a>
226 
            <b>insertFirst</b>(&nbsp;<code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span>&nbsp;) : HTMLElement/Ext.Element            <div class="mdesc">
227 
                        <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div>
228 
            <div class="long">
229 
                Applies the supplied values to the template and inserts the new node(s) as the first child of el.    <div class="mdetail-params">
230 
        <strong>Parameters:</strong>
231 
        <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>
232 
        <strong>Returns:</strong>
233 
        <ul>
234 
            <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
235 
        </ul>
236 
    </div>
237 
                </div>
238 
                        </div>
239 
        </td>
240 
        <td class="msource">Template</td>
241 
    </tr>
242 
        <tr class="method-row alt expandable">
243 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
244 
        <td class="sig">
245 
        <a id="Ext.Template-overwrite"></a>
246 
            <b>overwrite</b>(&nbsp;<code>Mixed el</code>, <code>Object/Array values</code>, <span class="optional" title="Optional">[<code>Boolean returnElement</code>]</span>&nbsp;) : HTMLElement/Ext.Element            <div class="mdesc">
247 
                        <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div>
248 
            <div class="long">
249 
                Applies the supplied values to the template and overwrites the content of el with the new node(s).    <div class="mdetail-params">
250 
        <strong>Parameters:</strong>
251 
        <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>
252 
        <strong>Returns:</strong>
253 
        <ul>
254 
            <li><code>HTMLElement/Ext.Element</code><div class="sub-desc">The new node or Element</div></li>
255 
        </ul>
256 
    </div>
257 
                </div>
258 
                        </div>
259 
        </td>
260 
        <td class="msource">Template</td>
261 
    </tr>
262 
        <tr class="method-row expandable">
263 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
264 
        <td class="sig">
265 
        <a id="Ext.Template-set"></a>
266 
            <b>set</b>(&nbsp;<code>String html</code>, <span class="optional" title="Optional">[<code>Boolean compile</code>]</span>&nbsp;) : Ext.Template            <div class="mdesc">
267 
                        <div class="short">Sets the HTML used as the template and optionally compiles it.</div>
268 
            <div class="long">
269 
                Sets the HTML used as the template and optionally compiles it.    <div class="mdetail-params">
270 
        <strong>Parameters:</strong>
271 
        <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>
272 
        <strong>Returns:</strong>
273 
        <ul>
274 
            <li><code>Ext.Template</code><div class="sub-desc">this</div></li>
275 
        </ul>
276 
    </div>
277 
                </div>
278 
                        </div>
279 
        </td>
280 
        <td class="msource">Template</td>
281 
    </tr>
282 
            </table>
283 
                <a id="Ext.Template-events"></a>
284 
        <h2>Public Events</h2>
285 
        <div class="no-members">This class has no public events.</div>
286 
        </div>