Upgrade to ExtJS 3.0.3 - Released 10/11/2009

[extjs.git] / src / core / CompositeElement.js

diff --git a/src/core/CompositeElement.js b/src/core/CompositeElement.js
index be5cc9b..f366ddb 100644 (file)
--- a/src/core/CompositeElement.js
+++ b/src/core/CompositeElement.js
@@ -1,5 +1,5 @@
 /*!
- * Ext JS Library 3.0.0
+ * Ext JS Library 3.0.3
  * Copyright(c) 2006-2009 Ext JS, LLC
  * licensing@extjs.com
  * http://www.extjs.com/license
@@ -37,7 +37,7 @@ Ext.extend(Ext.CompositeElement, Ext.CompositeElementLite, {
         });\r
         return this;\r
     },\r
-    \r
+\r
     /**\r
     * Adds elements to this composite.\r
     * @param {String/Array} els A string CSS selector, an array of elements or an element\r
@@ -50,13 +50,13 @@ Ext.extend(Ext.CompositeElement, Ext.CompositeElementLite, {
         if(typeof els == "string"){\r
             els = Ext.Element.selectorFunction(els, root);\r
         }\r
-        var yels = this.elements;        \r
+        var yels = this.elements;\r
            Ext.each(els, function(e) {\r
                yels.push(Ext.get(e));\r
         });\r
         return this;\r
-    },    \r
-    \r
+    },\r
+\r
     /**\r
      * Returns the Element object at the specified index\r
      * @param {Number} index\r
@@ -70,12 +70,12 @@ Ext.extend(Ext.CompositeElement, Ext.CompositeElementLite, {
     indexOf : function(el){\r
         return this.elements.indexOf(Ext.get(el));\r
     },\r
-        \r
+\r
     filter : function(selector){\r
                var me = this,\r
                        out = [];\r
-                       \r
-               Ext.each(me.elements, function(el) {    \r
+\r
+               Ext.each(me.elements, function(el) {\r
                        if(el.is(selector)){\r
                                out.push(Ext.get(el));\r
                        }\r
@@ -83,16 +83,31 @@ Ext.extend(Ext.CompositeElement, Ext.CompositeElementLite, {
                me.elements = out;\r
                return me;\r
        },\r
-       \r
-       /**\r
-    * Calls the passed function passing (el, this, index) for each element in this composite.\r
-    * @param {Function} fn The function to call\r
-    * @param {Object} scope (optional) The <i>this</i> object (defaults to the element)\r
-    * @return {CompositeElement} this\r
-    */\r
-    each : function(fn, scope){        \r
-        Ext.each(this.elements, function(e,i) {\r
-               return fn.call(scope || e, e, this, i);\r
+\r
+    /**\r
+     * Iterates each <code>element</code> in this <code>composite</code>\r
+     * calling the supplied function using {@link Ext#each}.\r
+     * @param {Function} fn The function to be called with each\r
+     * <code>element</code>. If the supplied function returns <tt>false</tt>,\r
+     * iteration stops. This function is called with the following arguments:\r
+     * <div class="mdetail-params"><ul>\r
+     * <li><code>element</code> : <i>Object</i>\r
+     * <div class="sub-desc">The element at the current <code>index</code>\r
+     * in the <code>composite</code></div></li>\r
+     * <li><code>composite</code> : <i>Object</i>\r
+     * <div class="sub-desc">This composite.</div></li>\r
+     * <li><code>index</code> : <i>Number</i>\r
+     * <div class="sub-desc">The current index within the <code>composite</code>\r
+     * </div></li>\r
+     * </ul></div>\r
+     * @param {Object} scope (optional) The scope to call the specified function.\r
+     * Defaults to the <code>element</code> at the current <code>index</code>\r
+     * within the composite.\r
+     * @return {CompositeElement} this\r
+     */\r
+    each : function(fn, scope){\r
+        Ext.each(this.elements, function(e, i){\r
+            return fn.call(scope || e, e, this, i);\r
         }, this);\r
         return this;\r
     }\r
@@ -120,7 +135,7 @@ Ext.Element.select = function(selector, unique, root){
     }\r
 \r
     return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);\r
-};
+};\r
 \r
 /**\r
  * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods\r