Upgrade to ExtJS 4.0.7 - Released 10/19/2011

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

diff --git a/src/core/src/dom/CompositeElement.js b/src/core/src/dom/CompositeElement.js
index 7cf279b..3710e00 100644 (file)
--- a/src/core/src/dom/CompositeElement.js
+++ b/src/core/src/dom/CompositeElement.js
@@ -17,7 +17,7 @@ If you are unsure which license is appropriate for your use, please contact the
  * @extends Ext.CompositeElementLite
  * <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 {@link Ext.core.Element} and
+ * <p>Although they are not listed, this class supports all of the methods of {@link Ext.Element} and
  * {@link Ext.fx.Anim}. The methods from these classes will be performed on all the elements in this collection.</p>
  * <p>All methods return <i>this</i> and can be chained.</p>
  * Usage:
@@ -34,81 +34,45 @@ els.setWidth(100).hide(true);
 </code></pre>
  */
 Ext.CompositeElement = Ext.extend(Ext.CompositeElementLite, {
-    
+
     constructor : function(els, root){
         this.elements = [];
         this.add(els, root);
     },
-    
+
     // private
     getElement : function(el){
         // In this case just return it, since we already have a reference to it
         return el;
     },
-    
+
     // private
     transformElement : function(el){
         return Ext.get(el);
     }
-
-    /**
-    * Adds elements to this composite.
-    * @param {String/Array} els A string CSS selector, an array of elements or an element
-    * @return {CompositeElement} this
-    */
-
-    /**
-     * Returns the Element object at the specified index
-     * @param {Number} index
-     * @return {Ext.core.Element}
-     */
-
-    /**
-     * Iterates each `element` in this `composite` calling the supplied function using {@link Ext#each Ext.each}.
-     * @param {Function} fn 
-
-The function to be called with each
-`element`. If the supplied function returns <tt>false</tt>,
-iteration stops. This function is called with the following arguments:
-
-- `element` : __Ext.core.Element++
-    The element at the current `index` in the `composite`
-    
-- `composite` : __Object__ 
-    This composite.
-
-- `index` : __Number__ 
-    The current index within the `composite`
-
-     * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the specified function is executed.
-     * Defaults to the <code>element</code> at the current <code>index</code>
-     * within the composite.
-     * @return {CompositeElement} this
-     * @markdown
-     */
 });
 
 /**
- * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods
+ * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods
  * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or
  * {@link Ext.CompositeElementLite CompositeElementLite} object.
- * @param {String/Array} selector The CSS selector or an array of elements
- * @param {Boolean} unique (optional) true to create a unique Ext.core.Element for each element (defaults to a shared flyweight object)
- * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
- * @return {CompositeElementLite/CompositeElement}
- * @member Ext.core.Element
+ * @param {String/HTMLElement[]} selector The CSS selector or an array of elements
+ * @param {Boolean} [unique] true to create a unique Ext.Element for each element (defaults to a shared flyweight object)
+ * @param {HTMLElement/String} [root] The root element of the query or id of the root
+ * @return {Ext.CompositeElementLite/Ext.CompositeElement}
+ * @member Ext.Element
  * @method select
  */
-Ext.core.Element.select = function(selector, unique, root){
+Ext.Element.select = function(selector, unique, root){
     var els;
     if(typeof selector == "string"){
-        els = Ext.core.Element.selectorFunction(selector, root);
+        els = Ext.Element.selectorFunction(selector, root);
     }else if(selector.length !== undefined){
         els = selector;
     }else{
         //<debug>
         Ext.Error.raise({
-            sourceClass: "Ext.core.Element",
+            sourceClass: "Ext.Element",
             sourceMethod: "select",
             selector: selector,
             unique: unique,
@@ -121,14 +85,9 @@ Ext.core.Element.select = function(selector, unique, root){
 };
 
 /**
- * Selects elements based on the passed CSS selector to enable {@link Ext.core.Element Element} methods
- * to be applied to many related elements in one statement through the returned {@link Ext.CompositeElement CompositeElement} or
- * {@link Ext.CompositeElementLite CompositeElementLite} object.
- * @param {String/Array} selector The CSS selector or an array of elements
- * @param {Boolean} unique (optional) true to create a unique Ext.core.Element for each element (defaults to a shared flyweight object)
- * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
- * @return {CompositeElementLite/CompositeElement}
+ * Shorthand of {@link Ext.Element#select}.
  * @member Ext
  * @method select
+ * @alias Ext.Element#select
  */
-Ext.select = Ext.core.Element.select;
+Ext.select = Ext.Element.select;