git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / source / CompositeElementLite.html
diff --git a/docs/source/CompositeElementLite.html b/docs/source/CompositeElementLite.html
index 87fc3ff..8563549 100644 (file)
--- a/docs/source/CompositeElementLite.html
+++ b/docs/source/CompositeElementLite.html
@@ -1,25 +1,28 @@
+<!DOCTYPE html>
 <html>
 <head>
 <html>
 <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
   <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>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
 </head>
 </head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.2.0
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-<div id="cls-Ext.CompositeElementLite"></div>/**
- * @class 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>
- * Example:<pre><code>
-var els = Ext.select("#some-el div.some-class");
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-CompositeElementLite'>/**
+</span> * @class Ext.CompositeElementLite
+ * &lt;p&gt;This class encapsulates a &lt;i&gt;collection&lt;/i&gt; of DOM elements, providing methods to filter
+ * members, or to perform collective actions upon the whole set.&lt;/p&gt;
+ * &lt;p&gt;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.&lt;/p&gt;
+ * Example:&lt;pre&gt;&lt;code&gt;
+var els = Ext.select(&quot;#some-el div.some-class&quot;);
 // or select directly from an existing element
 var el = Ext.get('some-el');
 el.select('div.some-class');
 // or select directly from an existing element
 var el = Ext.get('some-el');
 el.select('div.some-class');
@@ -28,23 +31,23 @@ els.setWidth(100); // all elements become 100 width
 els.hide(true); // all elements fade out and hide
 // or
 els.setWidth(100).hide(true);
 els.hide(true); // all elements fade out and hide
 // or
 els.setWidth(100).hide(true);
-</code>
+&lt;/code&gt;&lt;/pre&gt;
  */
 Ext.CompositeElementLite = function(els, root){
  */
 Ext.CompositeElementLite = function(els, root){
-    <div id="prop-Ext.CompositeElementLite-elements"></div>/**
-     * <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
+<span id='Ext-CompositeElementLite-property-elements'>    /**
+</span>     * &lt;p&gt;The Array of DOM elements which this CompositeElement encapsulates. Read-only.&lt;/p&gt;
+     * &lt;p&gt;This will not &lt;i&gt;usually&lt;/i&gt; be accessed in developers' code, but developers wishing
      * to augment the capabilities of the CompositeElementLite class may use it when adding
      * 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>
+     * methods to the class.&lt;/p&gt;
+     * &lt;p&gt;For example to add the &lt;code&gt;nextAll&lt;/code&gt; method to the class to &lt;b&gt;add&lt;/b&gt; all
+     * following siblings of selected elements, the code would be&lt;/p&gt;&lt;code&gt;&lt;pre&gt;
 Ext.override(Ext.CompositeElementLite, {
     nextAll: function() {
         var els = this.elements, i, l = els.length, n, r = [], ri = -1;
 
 //      Loop through all elements in this Composite, accumulating
 //      an Array of all siblings.
 Ext.override(Ext.CompositeElementLite, {
     nextAll: function() {
         var els = this.elements, i, l = els.length, n, r = [], ri = -1;
 
 //      Loop through all elements in this Composite, accumulating
 //      an Array of all siblings.
-        for (i = 0; i < l; i++) {
+        for (i = 0; i &lt; l; i++) {
             for (n = els[i].nextSibling; n; n = n.nextSibling) {
                 r[++ri] = n;
             }
             for (n = els[i].nextSibling; n; n = n.nextSibling) {
                 r[++ri] = n;
             }
@@ -53,18 +56,18 @@ Ext.override(Ext.CompositeElementLite, {
 //      Add all found siblings to this Composite
         return this.add(r);
     }
 //      Add all found siblings to this Composite
         return this.add(r);
     }
-});</pre></code>
+});&lt;/pre&gt;&lt;/code&gt;
      * @type Array
      * @property elements
      */
     this.elements = [];
     this.add(els, root);
      * @type Array
      * @property elements
      */
     this.elements = [];
     this.add(els, root);
-    this.el = new Ext.Element.Flyweight();
+    this.el = new Ext.core.Element.Flyweight();
 };
 
 Ext.CompositeElementLite.prototype = {
 };
 
 Ext.CompositeElementLite.prototype = {
-    isComposite: true,    
-    
+    isComposite: true,
+
     // private
     getElement : function(el){
         // Set the shared flyweight dom property to the current element
     // private
     getElement : function(el){
         // Set the shared flyweight dom property to the current element
@@ -73,21 +76,21 @@ Ext.CompositeElementLite.prototype = {
         e.id = el.id;
         return e;
     },
         e.id = el.id;
         return e;
     },
-    
+
     // private
     transformElement : function(el){
         return Ext.getDom(el);
     },
     // private
     transformElement : function(el){
         return Ext.getDom(el);
     },
-    
-    <div id="method-Ext.CompositeElementLite-getCount"></div>/**
-     * Returns the number of elements in this Composite.
+
+<span id='Ext-CompositeElementLite-method-getCount'>    /**
+</span>     * Returns the number of elements in this Composite.
      * @return Number
      */
     getCount : function(){
         return this.elements.length;
      * @return Number
      */
     getCount : function(){
         return this.elements.length;
-    },    
-    <div id="method-Ext.CompositeElementLite-add"></div>/**
-     * Adds elements to this Composite object.
+    },
+<span id='Ext-CompositeElementLite-method-add'>    /**
+</span>     * Adds elements to this Composite object.
      * @param {Mixed} els Either an Array of DOM elements to add, or another Composite object who's elements should be added.
      * @return {CompositeElement} This Composite object.
      */
      * @param {Mixed} els Either an Array of DOM elements to add, or another Composite object who's elements should be added.
      * @return {CompositeElement} This Composite object.
      */
@@ -97,39 +100,39 @@ Ext.CompositeElementLite.prototype = {
         if(!els){
             return this;
         }
         if(!els){
             return this;
         }
-        if(Ext.isString(els)){
-            els = Ext.Element.selectorFunction(els, root);
+        if(typeof els == &quot;string&quot;){
+            els = Ext.core.Element.selectorFunction(els, root);
         }else if(els.isComposite){
             els = els.elements;
         }else if(!Ext.isIterable(els)){
             els = [els];
         }
         }else if(els.isComposite){
             els = els.elements;
         }else if(!Ext.isIterable(els)){
             els = [els];
         }
-        
-        for(var i = 0, len = els.length; i < len; ++i){
+
+        for(var i = 0, len = els.length; i &lt; len; ++i){
             elements.push(me.transformElement(els[i]));
         }
         return me;
     },
             elements.push(me.transformElement(els[i]));
         }
         return me;
     },
-    
+
     invoke : function(fn, args){
         var me = this,
             els = me.elements,
     invoke : function(fn, args){
         var me = this,
             els = me.elements,
-            len = els.length, 
-            e, 
+            len = els.length,
+            e,
             i;
             i;
-            
-        for(i = 0; i < len; i++) {
+
+        for(i = 0; i &lt; len; i++) {
             e = els[i];
             if(e){
             e = els[i];
             if(e){
-                Ext.Element.prototype[fn].apply(me.getElement(e), args);
+                Ext.core.Element.prototype[fn].apply(me.getElement(e), args);
             }
         }
         return me;
     },
             }
         }
         return me;
     },
-    <div id="method-Ext.CompositeElementLite-item"></div>/**
-     * Returns a flyweight Element of the dom element object at the specified index
+<span id='Ext-CompositeElementLite-method-item'>    /**
+</span>     * Returns a flyweight Element of the dom element object at the specified index
      * @param {Number} index
      * @param {Number} index
-     * @return {Ext.Element}
+     * @return {Ext.core.Element}
      */
     item : function(index){
         var me = this,
      */
     item : function(index){
         var me = this,
@@ -147,8 +150,8 @@ Ext.CompositeElementLite.prototype = {
         var els = this.elements,
             len = els.length,
             i, e;
         var els = this.elements,
             len = els.length,
             i, e;
-        
-        for(i = 0; i<len; i++) {
+
+        for(i = 0; i&lt;len; i++) {
             e = els[i];
             if(e) {
                 Ext.EventManager.on(e, eventName, handler, scope || e, opt);
             e = els[i];
             if(e) {
                 Ext.EventManager.on(e, eventName, handler, scope || e, opt);
@@ -156,25 +159,25 @@ Ext.CompositeElementLite.prototype = {
         }
         return this;
     },
         }
         return this;
     },
-    <div id="method-Ext.CompositeElementLite-each"></div>/**
-     * <p>Calls the passed function for each element in this composite.</p>
-     * @param {Function} fn 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>
-     * @param {Object} scope (optional) The scope (<i>this</i> reference) in which the function is executed. (defaults to the Element)
+<span id='Ext-CompositeElementLite-method-each'>    /**
+</span>     * &lt;p&gt;Calls the passed function for each element in this composite.&lt;/p&gt;
+     * @param {Function} fn The function to call. The function is passed the following parameters:&lt;ul&gt;
+     * &lt;li&gt;&lt;b&gt;el&lt;/b&gt; : Element&lt;div class=&quot;sub-desc&quot;&gt;The current Element in the iteration.
+     * &lt;b&gt;This is the flyweight (shared) Ext.core.Element instance, so if you require a
+     * a reference to the dom node, use el.dom.&lt;/b&gt;&lt;/div&gt;&lt;/li&gt;
+     * &lt;li&gt;&lt;b&gt;c&lt;/b&gt; : Composite&lt;div class=&quot;sub-desc&quot;&gt;This Composite object.&lt;/div&gt;&lt;/li&gt;
+     * &lt;li&gt;&lt;b&gt;idx&lt;/b&gt; : Number&lt;div class=&quot;sub-desc&quot;&gt;The zero-based index in the iteration.&lt;/div&gt;&lt;/li&gt;
+     * &lt;/ul&gt;
+     * @param {Object} scope (optional) The scope (&lt;i&gt;this&lt;/i&gt; reference) in which the function is executed. (defaults to the Element)
      * @return {CompositeElement} this
      */
      * @return {CompositeElement} this
      */
-    each : function(fn, scope){       
+    each : function(fn, scope){
         var me = this,
             els = me.elements,
             len = els.length,
             i, e;
         var me = this,
             els = me.elements,
             len = els.length,
             i, e;
-        
-        for(i = 0; i<len; i++) {
+
+        for(i = 0; i&lt;len; i++) {
             e = els[i];
             if(e){
                 e = this.getElement(e);
             e = els[i];
             if(e){
                 e = this.getElement(e);
@@ -185,9 +188,9 @@ Ext.CompositeElementLite.prototype = {
         }
         return me;
     },
         }
         return me;
     },
-    
-    <div id="method-Ext.CompositeElementLite-fill"></div>/**
-    * Clears this Composite and adds the elements passed.
+
+<span id='Ext-CompositeElementLite-method-fill'>    /**
+</span>    * Clears this Composite and adds the elements passed.
     * @param {Mixed} els Either an array of DOM elements, or another Composite from which to fill this Composite.
     * @return {CompositeElement} this
     */
     * @param {Mixed} els Either an array of DOM elements, or another Composite from which to fill this Composite.
     * @return {CompositeElement} this
     */
@@ -197,56 +200,55 @@ Ext.CompositeElementLite.prototype = {
         me.add(els);
         return me;
     },
         me.add(els);
         return me;
     },
-    
-    <div id="method-Ext.CompositeElementLite-filter"></div>/**
-     * Filters this composite to only elements that match the passed selector.
+
+<span id='Ext-CompositeElementLite-method-filter'>    /**
+</span>     * Filters this composite to only elements that match the passed selector.
      * @param {String/Function} selector A string CSS selector or a comparison function.
      * @param {String/Function} selector 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>
+     * The comparison function will be called with the following arguments:&lt;ul&gt;
+     * &lt;li&gt;&lt;code&gt;el&lt;/code&gt; : Ext.core.Element&lt;div class=&quot;sub-desc&quot;&gt;The current DOM element.&lt;/div&gt;&lt;/li&gt;
+     * &lt;li&gt;&lt;code&gt;index&lt;/code&gt; : Number&lt;div class=&quot;sub-desc&quot;&gt;The current index within the collection.&lt;/div&gt;&lt;/li&gt;
+     * &lt;/ul&gt;
      * @return {CompositeElement} this
      */
     filter : function(selector){
         var els = [],
             me = this,
      * @return {CompositeElement} this
      */
     filter : function(selector){
         var els = [],
             me = this,
-            elements = me.elements,
             fn = Ext.isFunction(selector) ? selector
                 : function(el){
                     return el.is(selector);
                 };
             fn = Ext.isFunction(selector) ? selector
                 : function(el){
                     return el.is(selector);
                 };
-                
-        
-        me.each(function(el, self, i){
-            if(fn(el, i) !== false){
+
+        me.each(function(el, self, i) {
+            if (fn(el, i) !== false) {
                 els[els.length] = me.transformElement(el);
             }
         });
                 els[els.length] = me.transformElement(el);
             }
         });
+        
         me.elements = els;
         return me;
     },
         me.elements = els;
         return me;
     },
-    
-    <div id="method-Ext.CompositeElementLite-indexOf"></div>/**
-     * Find the index of the passed element within the composite collection.
-     * @param el {Mixed} The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.
-     * @return Number The index of the passed Ext.Element in the composite collection, or -1 if not found.
+
+<span id='Ext-CompositeElementLite-method-indexOf'>    /**
+</span>     * Find the index of the passed element within the composite collection.
+     * @param el {Mixed} The id of an element, or an Ext.core.Element, or an HtmlElement to find within the composite collection.
+     * @return Number The index of the passed Ext.core.Element in the composite collection, or -1 if not found.
      */
     indexOf : function(el){
      */
     indexOf : function(el){
-        return this.elements.indexOf(this.transformElement(el));
+        return Ext.Array.indexOf(this.elements, this.transformElement(el));
     },
     },
-    
-    <div id="method-Ext.CompositeElementLite-replaceElement"></div>/**
-    * Replaces the specified element with the passed element.
+
+<span id='Ext-CompositeElementLite-method-replaceElement'>    /**
+</span>    * Replaces the specified element with the passed element.
     * @param {Mixed} el The id of an element, the Element itself, the index of the element in this composite
     * to replace.
     * @param {Mixed} replacement The id of an element or the Element itself.
     * @param {Boolean} domReplace (Optional) True to remove and replace the element in the document too.
     * @return {CompositeElement} this
     * @param {Mixed} el The id of an element, the Element itself, the index of the element in this composite
     * to replace.
     * @param {Mixed} replacement The id of an element or the Element itself.
     * @param {Boolean} domReplace (Optional) True to remove and replace the element in the document too.
     * @return {CompositeElement} this
-    */    
+    */
     replaceElement : function(el, replacement, domReplace){
         var index = !isNaN(el) ? el : this.indexOf(el),
             d;
     replaceElement : function(el, replacement, domReplace){
         var index = !isNaN(el) ? el : this.indexOf(el),
             d;
-        if(index > -1){
+        if(index &gt; -1){
             replacement = Ext.getDom(replacement);
             if(domReplace){
                 d = this.elements[index];
             replacement = Ext.getDom(replacement);
             if(domReplace){
                 d = this.elements[index];
@@ -257,9 +259,9 @@ Ext.CompositeElementLite.prototype = {
         }
         return this;
     },
         }
         return this;
     },
-    
-    <div id="method-Ext.CompositeElementLite-clear"></div>/**
-     * Removes all elements.
+
+<span id='Ext-CompositeElementLite-method-clear'>    /**
+</span>     * Removes all elements.
      */
     clear : function(){
         this.elements = [];
      */
     clear : function(){
         this.elements = [];
@@ -268,50 +270,66 @@ Ext.CompositeElementLite.prototype = {
 
 Ext.CompositeElementLite.prototype.on = Ext.CompositeElementLite.prototype.addListener;
 
 
 Ext.CompositeElementLite.prototype.on = Ext.CompositeElementLite.prototype.addListener;
 
-(function(){
-var fnName,
-    ElProto = Ext.Element.prototype,
-    CelProto = Ext.CompositeElementLite.prototype;
-    
-for(fnName in ElProto){
-    if(Ext.isFunction(ElProto[fnName])){
-        (function(fnName){ 
-            CelProto[fnName] = CelProto[fnName] || function(){
-                return this.invoke(fnName, arguments);
-            };
-        }).call(CelProto, fnName);
-        
+<span id='Ext-CompositeElementLite-method-importElementMethods'>/**
+</span> * @private
+ * Copies all of the functions from Ext.core.Element's prototype onto CompositeElementLite's prototype.
+ * This is called twice - once immediately below, and once again after additional Ext.core.Element
+ * are added in Ext JS
+ */
+Ext.CompositeElementLite.importElementMethods = function() {
+    var fnName,
+        ElProto = Ext.core.Element.prototype,
+        CelProto = Ext.CompositeElementLite.prototype;
+
+    for (fnName in ElProto) {
+        if (typeof ElProto[fnName] == 'function'){
+            (function(fnName) {
+                CelProto[fnName] = CelProto[fnName] || function() {
+                    return this.invoke(fnName, arguments);
+                };
+            }).call(CelProto, fnName);
+
+        }
     }
     }
-}
-})();
+};
+
+Ext.CompositeElementLite.importElementMethods();
 
 if(Ext.DomQuery){
 
 if(Ext.DomQuery){
-    Ext.Element.selectorFunction = Ext.DomQuery.select;
-} 
+    Ext.core.Element.selectorFunction = Ext.DomQuery.select;
+}
 
 
-<div id="method-Ext.Element-select"></div>/**
- * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods
+<span id='Ext-core-Element-method-select'>/**
+</span> * 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 {HTMLElement/String} root (optional) The root element of the query or id of the root
  * @return {CompositeElementLite/CompositeElement}
  * 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 {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
  */
  * @method select
  */
-Ext.Element.select = function(selector, root){
+Ext.core.Element.select = function(selector, root){
     var els;
     var els;
-    if(typeof selector == "string"){
-        els = Ext.Element.selectorFunction(selector, root);
+    if(typeof selector == &quot;string&quot;){
+        els = Ext.core.Element.selectorFunction(selector, root);
     }else if(selector.length !== undefined){
         els = selector;
     }else{
     }else if(selector.length !== undefined){
         els = selector;
     }else{
-        throw "Invalid selector";
+        //&lt;debug&gt;
+        Ext.Error.raise({
+            sourceClass: &quot;Ext.core.Element&quot;,
+            sourceMethod: &quot;select&quot;,
+            selector: selector,
+            root: root,
+            msg: &quot;Invalid selector specified: &quot; + selector
+        });
+        //&lt;/debug&gt;
     }
     return new Ext.CompositeElementLite(els);
 };
     }
     return new Ext.CompositeElementLite(els);
 };
-<div id="method-Ext-select"></div>/**
- * Selects elements based on the passed CSS selector to enable {@link Ext.Element Element} methods
+<span id='Ext-method-select'>/**
+</span> * 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
  * 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
@@ -320,6 +338,7 @@ Ext.Element.select = function(selector, root){
  * @member Ext
  * @method select
  */
  * @member Ext
  * @method select
  */
-Ext.select = Ext.Element.select;</pre>    
+Ext.select = Ext.core.Element.select;
+</pre>
 </body>
 </body>
-</html>
\ No newline at end of file
+</html>
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.