Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / src / core / src / dom / CompositeElement.js
similarity index 64%
rename from src/core/CompositeElement.js
rename to src/core/src/dom/CompositeElement.js
index 3c908f2..3689eb8 100644 (file)
@@ -1,16 +1,10 @@
-/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
 /**
  * @class Ext.CompositeElement
  * @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.Element} and
- * {@link Ext.Fx}. The methods from these classes will be performed on all the elements in this collection.</p>
+ * <p>Although they are not listed, this class supports all of the methods of {@link Ext.core.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:
 <pre><code>
@@ -52,61 +46,75 @@ Ext.CompositeElement = Ext.extend(Ext.CompositeElementLite, {
     /**
      * Returns the Element object at the specified index
      * @param {Number} index
-     * @return {Ext.Element}
+     * @return {Ext.core.Element}
      */
 
     /**
-     * Iterates each <code>element</code> in this <code>composite</code>
-     * calling the supplied function using {@link Ext#each}.
-     * @param {Function} fn The function to be called with each
-     * <code>element</code>. If the supplied function returns <tt>false</tt>,
-     * iteration stops. This function is called with the following arguments:
-     * <div class="mdetail-params"><ul>
-     * <li><code>element</code> : <i>Ext.Element</i><div class="sub-desc">The element at the current <code>index</code>
-     * in the <code>composite</code></div></li>
-     * <li><code>composite</code> : <i>Object</i> <div class="sub-desc">This composite.</div></li>
-     * <li><code>index</code> : <i>Number</i> <div class="sub-desc">The current index within the <code>composite</code> </div></li>
-     * </ul></div>
-     * @param {Object} scope (optional) The scope (<code><this</code> reference) in which the specified function is executed.
+     * 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.Element Element} methods
+ * 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.Element for each element (defaults to a shared flyweight object)
+ * @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.Element
+ * @member Ext.core.Element
  * @method select
  */
-Ext.Element.select = function(selector, unique, root){
+Ext.core.Element.select = function(selector, unique, root){
     var els;
     if(typeof selector == "string"){
-        els = Ext.Element.selectorFunction(selector, root);
+        els = Ext.core.Element.selectorFunction(selector, root);
     }else if(selector.length !== undefined){
         els = selector;
     }else{
-        throw "Invalid selector";
+        //<debug>
+        Ext.Error.raise({
+            sourceClass: "Ext.core.Element",
+            sourceMethod: "select",
+            selector: selector,
+            unique: unique,
+            root: root,
+            msg: "Invalid selector specified: " + selector
+        });
+        //</debug>
     }
-
     return (unique === true) ? new Ext.CompositeElement(els) : new Ext.CompositeElementLite(els);
 };
 
 /**
- * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods
+ * 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.Element for each element (defaults to a shared flyweight object)
+ * @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
  * @method select
  */
-Ext.select = Ext.Element.select;
\ No newline at end of file
+Ext.select = Ext.core.Element.select;
\ No newline at end of file