Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / output / Ext.CompositeElementLite.html
1 <div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/CompositeElementLite-more.html#cls-Ext.CompositeElementLite">Ext.CompositeElementLite</a></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">CompositeElementLite-more.js,&#13;CompositeElementLite.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CompositeElementLite-more.html#cls-Ext.CompositeElementLite">CompositeElementLite</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.CompositeElement.html" ext:cls="Ext.CompositeElement">CompositeElement</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>This class encapsulates a <i>collection</i> of DOM elements, providing methods to filter\r
2 members, or to perform collective actions upon the whole set.</p>\r
3 <p>Although they are not listed, this class supports all of the methods of <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> and\r
4 <a href="output/Ext.Fx.html" ext:cls="Ext.Fx">Ext.Fx</a>. The methods from these classes will be performed on all the elements in this collection.</p>\r
5 Example:<pre><code><b>var</b> els = Ext.select(<em>"#some-el div.some-class"</em>);\r
6 <i>// or select directly from an existing element\r</i>
7 <b>var</b> el = Ext.get(<em>'some-el'</em>);\r
8 el.select(<em>'div.some-class'</em>);\r
9 \r
10 els.setWidth(100); <i>// all elements become 100 width\r</i>
11 els.hide(true); <i>// all elements fade out and hide\r</i>
12 <i>// or\r</i>
13 els.setWidth(100).hide(true);\r
14 </code></div><div class="hr"></div><a id="Ext.CompositeElementLite-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-elements"></a><b><a href="source/CompositeElementLite.html#prop-Ext.CompositeElementLite-elements">elements</a></b> : Array<div class="mdesc"><div class="short">The Array of DOM elements which this CompositeElement encapsulates. Read-only.&#13;\r
15 This will not usually be accessed in ...</div><div class="long"><p>The Array of DOM elements which this CompositeElement encapsulates. Read-only.</p>\r
16 <p>This will not <i>usually</i> be accessed in developers' code, but developers wishing\r
17 to augment the capabilities of the CompositeElementLite class may use it when adding\r
18 methods to the class.</p>\r
19 <p>For example to add the <code>nextAll</code> method to the class to <b>add</b> all\r
20 following siblings of selected elements, the code would be</p><code><pre>\r
21 Ext.override(Ext.CompositeElementLite, {\r
22     nextAll: <b>function</b>() {\r
23         <b>var</b> els = this.elements, i, l = els.length, n, r = [], ri = -1;\r
24 \r
25 <i>//      Loop through all elements <b>in</b> this Composite, accumulating\r</i>
26 <i>//      an Array of all siblings.\r</i>
27         <b>for</b> (i = 0; i < l; i++) {\r
28             <b>for</b> (n = els[i].nextSibling; n; n = n.nextSibling) {\r
29                 r[++ri] = n;\r
30             }\r
31         }\r
32 \r
33 <i>//      Add all found siblings to this Composite\r</i>
34         <b>return</b> this.add(r);\r
35     }\r
36 });</pre></code></div></div></td><td class="msource">CompositeElementLite</td></tr></tbody></table><a id="Ext.CompositeElementLite-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-add"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-add">add</a></b>(&nbsp;<code>Mixed&nbsp;els</code>&nbsp;)\r
37     :\r
38                                         CompositeElement<div class="mdesc"><div class="short">Adds elements to this Composite object.</div><div class="long">Adds elements to this Composite object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>els</code> : Mixed<div class="sub-desc">Either an Array of DOM elements to add, or another Composite object who's elements should be added.</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">This Composite object.</div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-clear"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-clear">clear</a></b>()\r
39     :\r
40                                         void<div class="mdesc"><div class="short">Removes all elements.</div><div class="long">Removes all elements.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-contains"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-contains">contains</a></b>(&nbsp;<code>el&nbsp;{Mixed}</code>&nbsp;)\r
41     :\r
42                                         Boolean<div class="mdesc"><div class="short">Returns true if this composite contains the passed element</div><div class="long">Returns true if this composite contains the passed element<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-each"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-each">each</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
43     :\r
44                                         CompositeElement<div class="mdesc"><div class="short">Calls the passed function for each element in this composite.</div><div class="long"><p>Calls the passed function for each element in this composite.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to call. The function is passed the following parameters:<ul>\r
45 <li><b>el</b> : Element<div class="sub-desc">The current Element in the iteration.\r
46 <b>This is the flyweight (shared) Ext.Element instance, so if you require a\r
47 a reference to the dom node, use el.dom.</b></div></li>\r
48 <li><b>c</b> : Composite<div class="sub-desc">This Composite object.</div></li>\r
49 <li><b>idx</b> : Number<div class="sub-desc">The zero-based index in the iteration.</div></li>\r
50 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<i>this</i> reference) in which the function is executed. (defaults to the Element)</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-fill"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-fill">fill</a></b>(&nbsp;<code>Mixed&nbsp;els</code>&nbsp;)\r
51     :\r
52                                         CompositeElement<div class="mdesc"><div class="short">Clears this Composite and adds the elements passed.</div><div class="long">Clears this Composite and adds the elements passed.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>els</code> : Mixed<div class="sub-desc">Either an array of DOM elements, or another Composite from which to fill this Composite.</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-filter"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-filter">filter</a></b>(&nbsp;<code>String/Function&nbsp;selector</code>&nbsp;)\r
53     :\r
54                                         CompositeElement<div class="mdesc"><div class="short">Filters this composite to only elements that match the passed selector.</div><div class="long">Filters this composite to only elements that match the passed selector.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String/Function<div class="sub-desc">A string CSS selector or a comparison function.\r
55 The comparison function will be called with the following arguments:<ul>\r
56 <li><code>el</code> : Ext.Element<div class="sub-desc">The current DOM element.</div></li>\r
57 <li><code>index</code> : Number<div class="sub-desc">The current index within the collection.</div></li>\r
58 </ul></div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-first"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-first">first</a></b>()\r
59     :\r
60                                         Ext.Element<div class="mdesc"><div class="short">Returns the first Element</div><div class="long">Returns the first Element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-getCount"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-getCount">getCount</a></b>()\r
61     :\r
62                                         Number<div class="mdesc"><div class="short">Returns the number of elements in this Composite.</div><div class="long">Returns the number of elements in this Composite.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-indexOf"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-indexOf">indexOf</a></b>(&nbsp;<code>el&nbsp;{Mixed}</code>&nbsp;)\r
63     :\r
64                                         Number<div class="mdesc"><div class="short">Find the index of the passed element within the composite collection.</div><div class="long">Find the index of the passed element within the composite collection.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><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></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-item"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-item">item</a></b>(&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
65     :\r
66                                         Ext.Element<div class="mdesc"><div class="short">Returns a flyweight Element of the dom element object at the specified index</div><div class="long">Returns a flyweight Element of the dom element object at the specified index<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-last"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-last">last</a></b>()\r
67     :\r
68                                         Ext.Element<div class="mdesc"><div class="short">Returns the last Element</div><div class="long">Returns the last Element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-removeElement"></a><b><a href="source/CompositeElementLite-more.html#method-Ext.CompositeElementLite-removeElement">removeElement</a></b>(&nbsp;<code>Mixed&nbsp;el</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;removeDom</code>]</span>&nbsp;)\r
69     :\r
70                                         CompositeElement<div class="mdesc"><div class="short">Removes the specified element(s).</div><div class="long">Removes the specified element(s).<div class="mdetail-params"><strong>Parameters:</strong><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\r
71 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><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.CompositeElementLite-replaceElement"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-replaceElement">replaceElement</a></b>(&nbsp;<code>Mixed&nbsp;el</code>,&nbsp;<code>Mixed&nbsp;replacement</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;domReplace</code>]</span>&nbsp;)\r
72     :\r
73                                         CompositeElement<div class="mdesc"><div class="short">Replaces the specified element with the passed element.</div><div class="long">Replaces the specified element with the passed element.<div class="mdetail-params"><strong>Parameters:</strong><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\r
74 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><strong>Returns:</strong><ul><li><code>CompositeElement</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">CompositeElementLite</td></tr></tbody></table><a id="Ext.CompositeElementLite-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>