1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext.CompositeElementLite-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext.CompositeElementLite-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext.CompositeElementLite-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="bookmark" href="../docs/?class=Ext.CompositeElementLite"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
7 | </div> |
---|
8 | <div class="inheritance res-block"> |
---|
9 | <pre class="res-block-inner"><a ext:cls="Ext.CompositeElement" ext:member="" href="output/Ext.CompositeElement.html">CompositeElement</a> |
---|
10 | <img src="resources/elbow-end.gif"/>CompositeElementLite</pre></div> |
---|
11 | <h1>Class Ext.CompositeElementLite</h1> |
---|
12 | <table cellspacing="0"> |
---|
13 | <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr> |
---|
14 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/CompositeElement.js" target="_blank">CompositeElement.js</a></td></tr> |
---|
15 | <tr><td class="label">Class:</td><td class="hd-info">CompositeElementLite</td></tr> |
---|
16 | <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.CompositeElement" ext:member="" href="output/Ext.CompositeElement.html">CompositeElement</a></td></tr> |
---|
17 | </table> |
---|
18 | <div class="description"> |
---|
19 | Flyweight composite class. Reuses the same Ext.Element for element operations. |
---|
20 | <pre><code>var els = Ext.select(<em>"#some-el div.some-class"</em>); |
---|
21 | <i>// or select directly from an existing element</i> |
---|
22 | <b>var</b> el = Ext.get(<em>'some-el'</em>); |
---|
23 | el.select(<em>'div.some-class'</em>); |
---|
24 | |
---|
25 | els.setWidth(100); <i>// all elements become 100 width</i> |
---|
26 | els.hide(true); <i>// all elements fade out and hide</i> |
---|
27 | <i>// or</i> |
---|
28 | els.setWidth(100).hide(true);</code></pre><br><br> |
---|
29 | <b>NOTE: Although they are not listed, this class supports all of the set/update methods of Ext.Element. All Ext.Element |
---|
30 | actions will be performed on all the elements in this collection.</b> </div> |
---|
31 | |
---|
32 | <div class="hr"></div> |
---|
33 | <a id="Ext.CompositeElementLite-props"></a> |
---|
34 | <h2>Public Properties</h2> |
---|
35 | <div class="no-members">This class has no public properties.</div> <a id="Ext.CompositeElementLite-methods"></a> |
---|
36 | <h2>Public Methods</h2> |
---|
37 | <table cellspacing="0" class="member-table"> |
---|
38 | <tr> |
---|
39 | <th class="sig-header" colspan="2">Method</th> |
---|
40 | <th class="msource-header">Defined By</th> |
---|
41 | </tr> |
---|
42 | <tr class="method-row inherited expandable"> |
---|
43 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
44 | <td class="sig"> |
---|
45 | <a id="Ext.CompositeElementLite-add"></a> |
---|
46 | <b>add</b>( <code>String/Array els</code> ) : CompositeElement <div class="mdesc"> |
---|
47 | <div class="short">Adds elements to this composite.</div> |
---|
48 | <div class="long"> |
---|
49 | Adds elements to this composite. <div class="mdetail-params"> |
---|
50 | <strong>Parameters:</strong> |
---|
51 | <ul><li><code>els</code> : String/Array<div class="sub-desc">A string CSS selector, an array of elements or an element</div></li> </ul> |
---|
52 | <strong>Returns:</strong> |
---|
53 | <ul> |
---|
54 | <li><code>CompositeElement</code><div class="sub-desc">this</div></li> |
---|
55 | </ul> |
---|
56 | </div> |
---|
57 | </div> |
---|
58 | </div> |
---|
59 | </td> |
---|
60 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#add" href="output/Ext.CompositeElement.html#add">CompositeElement</a></td> |
---|
61 | </tr> |
---|
62 | <tr class="method-row inherited alt expandable"> |
---|
63 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
64 | <td class="sig"> |
---|
65 | <a id="Ext.CompositeElementLite-clear"></a> |
---|
66 | <b>clear</b>() : void <div class="mdesc"> |
---|
67 | <div class="short">Removes all elements.</div> |
---|
68 | <div class="long"> |
---|
69 | Removes all elements. <div class="mdetail-params"> |
---|
70 | <strong>Parameters:</strong> |
---|
71 | <ul><li>None.</li> </ul> |
---|
72 | <strong>Returns:</strong> |
---|
73 | <ul> |
---|
74 | <li><code>void</code></li> |
---|
75 | </ul> |
---|
76 | </div> |
---|
77 | </div> |
---|
78 | </div> |
---|
79 | </td> |
---|
80 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#clear" href="output/Ext.CompositeElement.html#clear">CompositeElement</a></td> |
---|
81 | </tr> |
---|
82 | <tr class="method-row inherited expandable"> |
---|
83 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
84 | <td class="sig"> |
---|
85 | <a id="Ext.CompositeElementLite-contains"></a> |
---|
86 | <b>contains</b>( <code>el {Mixed}</code> ) : Boolean <div class="mdesc"> |
---|
87 | <div class="short">Returns true if this composite contains the passed element</div> |
---|
88 | <div class="long"> |
---|
89 | Returns true if this composite contains the passed element <div class="mdetail-params"> |
---|
90 | <strong>Parameters:</strong> |
---|
91 | <ul><li><code>{Mixed}</code> : el<div class="sub-desc">The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.</div></li> </ul> |
---|
92 | <strong>Returns:</strong> |
---|
93 | <ul> |
---|
94 | <li><code>Boolean</code></li> |
---|
95 | </ul> |
---|
96 | </div> |
---|
97 | </div> |
---|
98 | </div> |
---|
99 | </td> |
---|
100 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#contains" href="output/Ext.CompositeElement.html#contains">CompositeElement</a></td> |
---|
101 | </tr> |
---|
102 | <tr class="method-row alt expandable"> |
---|
103 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
104 | <td class="sig"> |
---|
105 | <a id="Ext.CompositeElementLite-each"></a> |
---|
106 | <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : CompositeElement <div class="mdesc"> |
---|
107 | <div class="short">Calls the passed function passing (el, this, index) for each element in this composite. The element |
---|
108 | passed is the fly...</div> |
---|
109 | <div class="long"> |
---|
110 | Calls the passed function passing (el, this, index) for each element in this composite. <b>The element |
---|
111 | passed is the flyweight (shared) Ext.Element instance, so if you require a |
---|
112 | a reference to the dom node, use el.dom.</b> <div class="mdetail-params"> |
---|
113 | <strong>Parameters:</strong> |
---|
114 | <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The <i>this</i> object (defaults to the element)</div></li> </ul> |
---|
115 | <strong>Returns:</strong> |
---|
116 | <ul> |
---|
117 | <li><code>CompositeElement</code><div class="sub-desc">this</div></li> |
---|
118 | </ul> |
---|
119 | </div> |
---|
120 | </div> |
---|
121 | </div> |
---|
122 | </td> |
---|
123 | <td class="msource">CompositeElementLite</td> |
---|
124 | </tr> |
---|
125 | <tr class="method-row inherited expandable"> |
---|
126 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
127 | <td class="sig"> |
---|
128 | <a id="Ext.CompositeElementLite-fill"></a> |
---|
129 | <b>fill</b>( <code>String/Array els</code> ) : CompositeElement <div class="mdesc"> |
---|
130 | <div class="short">Clears this composite and adds the elements returned by the passed selector.</div> |
---|
131 | <div class="long"> |
---|
132 | Clears this composite and adds the elements returned by the passed selector. <div class="mdetail-params"> |
---|
133 | <strong>Parameters:</strong> |
---|
134 | <ul><li><code>els</code> : String/Array<div class="sub-desc">A string CSS selector, an array of elements or an element</div></li> </ul> |
---|
135 | <strong>Returns:</strong> |
---|
136 | <ul> |
---|
137 | <li><code>CompositeElement</code><div class="sub-desc">this</div></li> |
---|
138 | </ul> |
---|
139 | </div> |
---|
140 | </div> |
---|
141 | </div> |
---|
142 | </td> |
---|
143 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#fill" href="output/Ext.CompositeElement.html#fill">CompositeElement</a></td> |
---|
144 | </tr> |
---|
145 | <tr class="method-row inherited alt expandable"> |
---|
146 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
147 | <td class="sig"> |
---|
148 | <a id="Ext.CompositeElementLite-filter"></a> |
---|
149 | <b>filter</b>( <code>String selector</code> ) : CompositeElement <div class="mdesc"> |
---|
150 | <div class="short">Filters this composite to only elements that match the passed selector.</div> |
---|
151 | <div class="long"> |
---|
152 | Filters this composite to only elements that match the passed selector. <div class="mdetail-params"> |
---|
153 | <strong>Parameters:</strong> |
---|
154 | <ul><li><code>selector</code> : String<div class="sub-desc">A string CSS selector</div></li> </ul> |
---|
155 | <strong>Returns:</strong> |
---|
156 | <ul> |
---|
157 | <li><code>CompositeElement</code><div class="sub-desc">this</div></li> |
---|
158 | </ul> |
---|
159 | </div> |
---|
160 | </div> |
---|
161 | </div> |
---|
162 | </td> |
---|
163 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#filter" href="output/Ext.CompositeElement.html#filter">CompositeElement</a></td> |
---|
164 | </tr> |
---|
165 | <tr class="method-row inherited expandable"> |
---|
166 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
167 | <td class="sig"> |
---|
168 | <a id="Ext.CompositeElementLite-first"></a> |
---|
169 | <b>first</b>() : Ext.Element <div class="mdesc"> |
---|
170 | <div class="short">Returns the first Element</div> |
---|
171 | <div class="long"> |
---|
172 | Returns the first Element <div class="mdetail-params"> |
---|
173 | <strong>Parameters:</strong> |
---|
174 | <ul><li>None.</li> </ul> |
---|
175 | <strong>Returns:</strong> |
---|
176 | <ul> |
---|
177 | <li><code>Ext.Element</code></li> |
---|
178 | </ul> |
---|
179 | </div> |
---|
180 | </div> |
---|
181 | </div> |
---|
182 | </td> |
---|
183 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#first" href="output/Ext.CompositeElement.html#first">CompositeElement</a></td> |
---|
184 | </tr> |
---|
185 | <tr class="method-row inherited alt expandable"> |
---|
186 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
187 | <td class="sig"> |
---|
188 | <a id="Ext.CompositeElementLite-getCount"></a> |
---|
189 | <b>getCount</b>() : Number <div class="mdesc"> |
---|
190 | <div class="short">Returns the number of elements in this composite</div> |
---|
191 | <div class="long"> |
---|
192 | Returns the number of elements in this composite <div class="mdetail-params"> |
---|
193 | <strong>Parameters:</strong> |
---|
194 | <ul><li>None.</li> </ul> |
---|
195 | <strong>Returns:</strong> |
---|
196 | <ul> |
---|
197 | <li><code>Number</code></li> |
---|
198 | </ul> |
---|
199 | </div> |
---|
200 | </div> |
---|
201 | </div> |
---|
202 | </td> |
---|
203 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#getCount" href="output/Ext.CompositeElement.html#getCount">CompositeElement</a></td> |
---|
204 | </tr> |
---|
205 | <tr class="method-row inherited expandable"> |
---|
206 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
207 | <td class="sig"> |
---|
208 | <a id="Ext.CompositeElementLite-indexOf"></a> |
---|
209 | <b>indexOf</b>( <code>el {Mixed}</code> ) : Number <div class="mdesc"> |
---|
210 | <div class="short">Find the index of the passed element within the composite collection.</div> |
---|
211 | <div class="long"> |
---|
212 | Find the index of the passed element within the composite collection. <div class="mdetail-params"> |
---|
213 | <strong>Parameters:</strong> |
---|
214 | <ul><li><code>{Mixed}</code> : el<div class="sub-desc">The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.</div></li> </ul> |
---|
215 | <strong>Returns:</strong> |
---|
216 | <ul> |
---|
217 | <li><code>Number</code><div class="sub-desc">The index of the passed Ext.Element in the composite collection, or -1 if not found.</div></li> |
---|
218 | </ul> |
---|
219 | </div> |
---|
220 | </div> |
---|
221 | </div> |
---|
222 | </td> |
---|
223 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#indexOf" href="output/Ext.CompositeElement.html#indexOf">CompositeElement</a></td> |
---|
224 | </tr> |
---|
225 | <tr class="method-row alt expandable"> |
---|
226 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
227 | <td class="sig"> |
---|
228 | <a id="Ext.CompositeElementLite-item"></a> |
---|
229 | <b>item</b>( <code>Number index</code> ) : Ext.Element <div class="mdesc"> |
---|
230 | <div class="short">Returns a flyweight Element of the dom element object at the specified index</div> |
---|
231 | <div class="long"> |
---|
232 | Returns a flyweight Element of the dom element object at the specified index <div class="mdetail-params"> |
---|
233 | <strong>Parameters:</strong> |
---|
234 | <ul><li><code>index</code> : Number<div class="sub-desc"></div></li> </ul> |
---|
235 | <strong>Returns:</strong> |
---|
236 | <ul> |
---|
237 | <li><code>Ext.Element</code></li> |
---|
238 | </ul> |
---|
239 | </div> |
---|
240 | </div> |
---|
241 | </div> |
---|
242 | </td> |
---|
243 | <td class="msource">CompositeElementLite</td> |
---|
244 | </tr> |
---|
245 | <tr class="method-row inherited expandable"> |
---|
246 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
247 | <td class="sig"> |
---|
248 | <a id="Ext.CompositeElementLite-last"></a> |
---|
249 | <b>last</b>() : Ext.Element <div class="mdesc"> |
---|
250 | <div class="short">Returns the last Element</div> |
---|
251 | <div class="long"> |
---|
252 | Returns the last Element <div class="mdetail-params"> |
---|
253 | <strong>Parameters:</strong> |
---|
254 | <ul><li>None.</li> </ul> |
---|
255 | <strong>Returns:</strong> |
---|
256 | <ul> |
---|
257 | <li><code>Ext.Element</code></li> |
---|
258 | </ul> |
---|
259 | </div> |
---|
260 | </div> |
---|
261 | </div> |
---|
262 | </td> |
---|
263 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#last" href="output/Ext.CompositeElement.html#last">CompositeElement</a></td> |
---|
264 | </tr> |
---|
265 | <tr class="method-row inherited alt expandable"> |
---|
266 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
267 | <td class="sig"> |
---|
268 | <a id="Ext.CompositeElementLite-removeElement"></a> |
---|
269 | <b>removeElement</b>( <code>Mixed el</code>, <span class="optional" title="Optional">[<code>Boolean removeDom</code>]</span> ) : CompositeElement <div class="mdesc"> |
---|
270 | <div class="short">Removes the specified element(s).</div> |
---|
271 | <div class="long"> |
---|
272 | Removes the specified element(s). <div class="mdetail-params"> |
---|
273 | <strong>Parameters:</strong> |
---|
274 | <ul><li><code>el</code> : Mixed<div class="sub-desc">The id of an element, the Element itself, the index of the element in this composite |
---|
275 | or an array of any of those.</div></li><li><code>removeDom</code> : Boolean<div class="sub-desc">(optional) True to also remove the element from the document</div></li> </ul> |
---|
276 | <strong>Returns:</strong> |
---|
277 | <ul> |
---|
278 | <li><code>CompositeElement</code><div class="sub-desc">this</div></li> |
---|
279 | </ul> |
---|
280 | </div> |
---|
281 | </div> |
---|
282 | </div> |
---|
283 | </td> |
---|
284 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#removeElement" href="output/Ext.CompositeElement.html#removeElement">CompositeElement</a></td> |
---|
285 | </tr> |
---|
286 | <tr class="method-row inherited expandable"> |
---|
287 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
288 | <td class="sig"> |
---|
289 | <a id="Ext.CompositeElementLite-replaceElement"></a> |
---|
290 | <b>replaceElement</b>( <code>Mixed el</code>, <code>Mixed replacement</code>, <span class="optional" title="Optional">[<code>Boolean domReplace</code>]</span> ) : CompositeElement <div class="mdesc"> |
---|
291 | <div class="short">Replaces the specified element with the passed element.</div> |
---|
292 | <div class="long"> |
---|
293 | Replaces the specified element with the passed element. <div class="mdetail-params"> |
---|
294 | <strong>Parameters:</strong> |
---|
295 | <ul><li><code>el</code> : Mixed<div class="sub-desc">The id of an element, the Element itself, the index of the element in this composite |
---|
296 | to replace.</div></li><li><code>replacement</code> : Mixed<div class="sub-desc">The id of an element or the Element itself.</div></li><li><code>domReplace</code> : Boolean<div class="sub-desc">(Optional) True to remove and replace the element in the document too.</div></li> </ul> |
---|
297 | <strong>Returns:</strong> |
---|
298 | <ul> |
---|
299 | <li><code>CompositeElement</code><div class="sub-desc">this</div></li> |
---|
300 | </ul> |
---|
301 | </div> |
---|
302 | </div> |
---|
303 | </div> |
---|
304 | </td> |
---|
305 | <td class="msource"><a ext:cls="Ext.CompositeElement" ext:member="#replaceElement" href="output/Ext.CompositeElement.html#replaceElement">CompositeElement</a></td> |
---|
306 | </tr> |
---|
307 | </table> |
---|
308 | <a id="Ext.CompositeElementLite-events"></a> |
---|
309 | <h2>Public Events</h2> |
---|
310 | <div class="no-members">This class has no public events.</div> |
---|
311 | </div> |
---|