X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..92c2b89db26be16707f4a805d3303ab2531006e1:/docs/output/Ext.CompositeElementLite.html?ds=inline

diff --git a/docs/output/Ext.CompositeElementLite.html b/docs/output/Ext.CompositeElementLite.html
index 1787b903..202a4097 100644
--- a/docs/output/Ext.CompositeElementLite.html
+++ b/docs/output/Ext.CompositeElementLite.html
@@ -1,32 +1,65 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.CompositeElementLite-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.CompositeElementLite-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.CompositeElementLite-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.CompositeElementLite"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/CompositeElementLite.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.js,&#13;CompositeElementLite-more.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CompositeElementLite.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">Flyweight composite class. Reuses the same Ext.Element for element operations.
- <pre><code><b>var</b> els = Ext.select(<em>"#some-el div.some-class"</em>);
- <i>// or select directly from an existing element
</i>
- <b>var</b> el = Ext.get(<em>'some-el'</em>);
- el.select(<em>'div.some-class'</em>);
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/CompositeElementLite.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.js,&#13;CompositeElementLite-more.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CompositeElementLite.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
+members, or to perform collective actions upon the whole set.</p>
+<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
+<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>
+Example:<pre><code><b>var</b> els = Ext.select(<em>"#some-el div.some-class"</em>);
+<i>// or select directly from an existing element
</i>
+<b>var</b> el = Ext.get(<em>'some-el'</em>);
+el.select(<em>'div.some-class'</em>);
 
- els.setWidth(100); <i>// all elements become 100 width
</i>
- els.hide(true); <i>// all elements fade out and hide
</i>
- <i>// or
</i>
- els.setWidth(100).hide(true);</code></pre><br><br>
-<b>NOTE: Although they are not listed, this class supports all of the set/update methods of Ext.Element. All Ext.Element
-actions will be performed on all the elements in this collection.</b></div><div class="hr"></div><a id="Ext.CompositeElementLite-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><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-clear"></a><b><a href="source/CompositeElementLite.html#method-Ext.CompositeElementLite-clear">clear</a></b>()
+els.setWidth(100); <i>// all elements become 100 width
</i>
+els.hide(true); <i>// all elements fade out and hide
</i>
+<i>// or
</i>
+els.setWidth(100).hide(true);
+</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;
+This will not usually be accessed in ...</div><div class="long"><p>The Array of DOM elements which this CompositeElement encapsulates. Read-only.</p>
+<p>This will not <i>usually</i> be accessed in developers' code, but developers wishing
+to augment the capabilities of the CompositeElementLite class may use it when adding
+methods to the class.</p>
+<p>For example to add the <code>nextAll</code> method to the class to <b>add</b> all
+following siblings of selected elements, the code would be</p><code><pre>
+Ext.override(Ext.CompositeElementLite, {
+    nextAll: <b>function</b>() {
+        <b>var</b> els = this.elements, i, l = els.length, n, r = [], ri = -1;
+
+<i>//      Loop through all elements <b>in</b> this Composite, accumulating
</i>
+<i>//      an Array of all siblings.
</i>
+        <b>for</b> (i = 0; i < l; i++) {
+            <b>for</b> (n = els[i].nextSibling; n; n = n.nextSibling) {
+                r[++ri] = n;
+            }
+        }
+
+<i>//      Add all found siblings to this Composite
</i>
+        <b>return</b> this.add(r);
+    }
+});</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;)
+    :
+                                        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>()
     :
                                         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;)
     :
                                         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;)
     :
-                                        CompositeElement<div class="mdesc"><div class="short">Calls the passed function passing (el, this, index) for each element in this composite. The element&#13;
-passed is the fl...</div><div class="long">Calls the passed function passing (el, this, index) for each element in this composite. <b>The element
-passed is the flyweight (shared) Ext.Element instance, so if you require a
-a reference to the dom node, use el.dom.</b><div class="mdetail-params"><strong>Parameters:</strong><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><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-more.html#method-Ext.CompositeElementLite-fill">fill</a></b>(&nbsp;<code>String/Array&nbsp;els</code>&nbsp;)
+                                        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>
+<li><b>el</b> : Element<div class="sub-desc">The current Element in the iteration.
+<b>This is the flyweight (shared) Ext.Element instance, so if you require a
+a reference to the dom node, use el.dom.</b></div></li>
+<li><b>c</b> : Composite<div class="sub-desc">This Composite object.</div></li>
+<li><b>idx</b> : Number<div class="sub-desc">The zero-based index in the iteration.</div></li>
+</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;)
     :
-                                        CompositeElement<div class="mdesc"><div class="short">Clears this composite and adds the elements returned by the passed selector.</div><div class="long">Clears this composite and adds the elements returned by the passed selector.<div class="mdetail-params"><strong>Parameters:</strong><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><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-more.html#method-Ext.CompositeElementLite-filter">filter</a></b>(&nbsp;<code>String&nbsp;selector</code>&nbsp;)
+                                        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;)
     :
-                                        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<div class="sub-desc">A string CSS selector</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>()
+                                        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.
+The comparison function will be called with the following arguments:<ul>
+<li><code>el</code> : Ext.Element<div class="sub-desc">The current DOM element.</div></li>
+<li><code>index</code> : Number<div class="sub-desc">The current index within the collection.</div></li>
+</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>()
     :
                                         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>()
     :
-                                        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;)
+                                        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;)
     :
                                         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;)
     :