Upgrade to ExtJS 3.0.3 - Released 10/11/2009

[extjs.git] / docs / source / CompositeElement.html
diff --git a/docs/source/CompositeElement.html b/docs/source/CompositeElement.html

index 2d26e9c..8a932f2 100644 (file)
--- a/docs/source/CompositeElement.html
+++ b/docs/source/CompositeElement.html
@@ -1,11 +1,17 @@
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.CompositeElement"></div>/**\r
+<html>
+<head>
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.0.3
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.CompositeElement"></div>/**\r
   * @class Ext.CompositeElement\r
   * @extends Ext.CompositeElementLite\r
   * Standard composite class. Creates a Ext.Element for every element in the collection.\r
@@ -38,7 +44,7 @@ Ext.extend(Ext.CompositeElement, Ext.CompositeElementLite, {
          });\r
          return this;\r
      },\r
-    \r
+\r
      <div id="method-Ext.CompositeElement-add"></div>/**\r
      * Adds elements to this composite.\r
      * @param {String/Array} els A string CSS selector, an array of elements or an element\r
@@ -51,13 +57,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
      <div id="method-Ext.CompositeElement-item"></div>/**\r
       * Returns the Element object at the specified index\r
       * @param {Number} index\r
@@ -71,12 +77,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
@@ -84,16 +90,31 @@ Ext.extend(Ext.CompositeElement, Ext.CompositeElementLite, {
                 me.elements = out;\r
                 return me;\r
         },\r
-       \r
-       <div id="method-Ext.CompositeElement-each"></div>/**\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
+    <div id="method-Ext.CompositeElement-each"></div>/**\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
@@ -121,7 +142,7 @@ Ext.Element.select = function(selector, unique, root){
      }\r
  \r
      return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);\r
-};
+};\r
  \r
  <div id="method-Ext.Element-select"></div>/**\r
   * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods\r
@@ -134,6 +155,6 @@ Ext.Element.select = function(selector, unique, root){
   * @member Ext.Element\r
   * @method select\r
   */\r
-Ext.select = Ext.Element.select;</pre>    \r
-</body>\r
+Ext.select = Ext.Element.select;</pre>
+</body>
  </html>
 \ No newline at end of file