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