X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775:/docs/source/CompositeElementLite.html diff --git a/docs/source/CompositeElementLite.html b/docs/source/CompositeElementLite.html index 1f85cd1f..16a9832b 100644 --- a/docs/source/CompositeElementLite.html +++ b/docs/source/CompositeElementLite.html @@ -1,49 +1,87 @@ - - - The source code - - - - - 
/**
+
+
+  The source code
+    
+    
+
+
+    
/*!
+ * Ext JS Library 3.0.3
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**
  * @class Ext.CompositeElementLite
- * Flyweight composite class. Reuses the same Ext.Element for element operations.
- 

- var els = Ext.select("#some-el div.some-class");
- // or select directly from an existing element
- var el = Ext.get('some-el');
- el.select('div.some-class');
+ * 
This class encapsulates a collection of DOM elements, providing methods to filter
+ * members, or to perform collective actions upon the whole set.

+ * 
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.

+ * Example:

+var els = Ext.select("#some-el div.some-class");
+// or select directly from an existing element
+var el = Ext.get('some-el');
+el.select('div.some-class');
 
- els.setWidth(100); // all elements become 100 width
- els.hide(true); // all elements fade out and hide
- // or
- els.setWidth(100).hide(true);
- 



- * NOTE: Although they are not listed, this class supports all of the set/update methods of Ext.Element. All Ext.Element
- * actions will be performed on all the elements in this collection.
+els.setWidth(100); // all elements become 100 width
+els.hide(true); // all elements fade out and hide
+// or
+els.setWidth(100).hide(true);
+
  */
 Ext.CompositeElementLite = function(els, root){
+    
/**
+     * 
The Array of DOM elements which this CompositeElement encapsulates. Read-only.

+     * 
This will not usually be accessed in developers' code, but developers wishing
+     * to augment the capabilities of the CompositeElementLite class may use it when adding
+     * methods to the class.

+     * 
For example to add the nextAll method to the class to add all
+     * following siblings of selected elements, the code would be
+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 (n = els[i].nextSibling; n; n = n.nextSibling) {
+                r[++ri] = n;
+            }
+        }
+
+//      Add all found siblings to this Composite
+        return this.add(r);
+    }
+});

+     * @type Array
+     * @property elements
+     */
     this.elements = [];
     this.add(els, root);
     this.el = new Ext.Element.Flyweight();
 };
 
 Ext.CompositeElementLite.prototype = {
-	isComposite: true,	
-	
/**
-     * Returns the number of elements in this composite
+    isComposite: true,    
+    
/**
+     * Returns the number of elements in this Composite.
      * @return Number
      */
     getCount : function(){
         return this.elements.length;
     },    
-	add : function(els){
+    
/**
+     * 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.
+     */
+    add : function(els){
         if(els){
             if (Ext.isArray(els)) {
                 this.elements = this.elements.concat(els);
             } else {
-                var yels = this.elements;                	                
-	            Ext.each(els, function(e) {
+                var yels = this.elements;                                    
+                Ext.each(els, function(e) {
                     yels.push(e);
                 });
             }
@@ -52,10 +90,10 @@ Ext.CompositeElementLite.prototype = {
     },
     invoke : function(fn, args){
         var els = this.elements,
-        	el = this.el;        
-	    Ext.each(els, function(e) {    
+            el = this.el;        
+        Ext.each(els, function(e) {    
             el.dom = e;
-        	Ext.Element.prototype[fn].apply(el, args);
+            Ext.Element.prototype[fn].apply(el, args);
         });
         return this;
     },
@@ -65,7 +103,7 @@ Ext.CompositeElementLite.prototype = {
      * @return {Ext.Element}
      */
     item : function(index){
-	    var me = this;
+        var me = this;
         if(!me.elements[index]){
             return null;
         }
@@ -76,26 +114,67 @@ Ext.CompositeElementLite.prototype = {
     // fixes scope with flyweight
     addListener : function(eventName, handler, scope, opt){
         Ext.each(this.elements, function(e) {
-	        Ext.EventManager.on(e, eventName, handler, scope || e, opt);
+            Ext.EventManager.on(e, eventName, handler, scope || e, opt);
         });
         return this;
     },
     
/**
-    * Calls the passed function passing (el, this, index) for each element in this composite. The element
-    * passed is the flyweight (shared) Ext.Element instance, so if you require a
-    * a reference to the dom node, use el.dom.
-    * @param {Function} fn The function to call
-    * @param {Object} scope (optional) The this object (defaults to the element)
-    * @return {CompositeElement} this
-    */
+     * 
Calls the passed function for each element in this composite.

+     * @param {Function} fn The function to call. The function is passed the following parameters:
    
+     * 
  • el : Element
    The current Element in the iteration.
+     * This is the flyweight (shared) Ext.Element instance, so if you require a
+     * a reference to the dom node, use el.dom.
    • 
+     * 
  • c : Composite
    This Composite object.
    • 
+     * 
  • idx : Number
    The zero-based index in the iteration.
    • 
+     * 

+     * @param {Object} scope (optional) The scope (this reference) in which the function is executed. (defaults to the Element)
+     * @return {CompositeElement} this
+     */
     each : function(fn, scope){       
         var me = this,
-        	el = me.el;
+            el = me.el;
        
-	    Ext.each(me.elements, function(e,i) {    
+        Ext.each(me.elements, function(e,i) {    
             el.dom = e;
-        	return fn.call(scope || el, el, me, i);
+            return fn.call(scope || el, el, me, i);
+        });
+        return me;
+    },
+    
+    
/**
+    * 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
+    */
+    fill : function(els){
+        var me = this;
+        me.elements = [];
+        me.add(els);
+        return me;
+    },
+    
+    
/**
+     * Filters this composite to only elements that match the passed selector.
+     * @param {String/Function} selector A string CSS selector or a comparison function.
+     * The comparison function will be called with the following arguments:
    
+     * 
  • el : Ext.Element
    The current DOM element.
    • 
+     * 
  • index : Number
    The current index within the collection.
    • 
+     * 

+     * @return {CompositeElement} this
+     */
+    filter : function(selector){
+        var els = [],
+            me = this,
+            fn = Ext.isFunction(selector) ? selector
+                : function(el){
+                    return el.is(selector);
+                }
+        me.each(function(el, self, i){
+            if(fn(el, i) !== false){
+                els[els.length] = el.dom;
+            }
         });
+        me.fill(els);
         return me;
     },
     
@@ -118,7 +197,7 @@ Ext.CompositeElementLite.prototype = {
     */    
     replaceElement : function(el, replacement, domReplace){
         var index = !isNaN(el) ? el : this.indexOf(el),
-        	d;
+            d;
         if(index > -1){
             replacement = Ext.getDom(replacement);
             if(domReplace){
@@ -143,16 +222,16 @@ Ext.CompositeElementLite.prototype.on = Ext.CompositeElementLite.prototype.addLi
 
 (function(){
 var fnName,
-	ElProto = Ext.Element.prototype,
-	CelProto = Ext.CompositeElementLite.prototype;
-	
+    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);
+        (function(fnName){ 
+            CelProto[fnName] = CelProto[fnName] || function(){
+                return this.invoke(fnName, arguments);
+            };
+        }).call(CelProto, fnName);
         
     }
 }
@@ -195,6 +274,6 @@ Ext.Element.select = function(selector, unique, root){
  * @member Ext
  * @method select
  */
-Ext.select = Ext.Element.select;
    
-
+Ext.select = Ext.Element.select;

+
 
\ No newline at end of file