X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/CompositeSprite.html diff --git a/docs/source/CompositeSprite.html b/docs/source/CompositeSprite.html index c540b81c..0c398d32 100644 --- a/docs/source/CompositeSprite.html +++ b/docs/source/CompositeSprite.html @@ -1,4 +1,21 @@ -Sencha Documentation Project
/**
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
  * @class Ext.draw.CompositeSprite
  * @extends Ext.util.MixedCollection
  *
@@ -94,8 +111,8 @@ Ext.define('Ext.draw.CompositeSprite', {
         });
     },
 
-    /** Add a Sprite to the Group */
-    add: function(key, o) {
+    // Inherit docs from MixedCollection
+    add: function(key, o) {
         var result = this.callParent(arguments);
         this.attachEvents(result);
         return result;
@@ -105,8 +122,8 @@ Ext.define('Ext.draw.CompositeSprite', {
         return this.callParent(arguments);
     },
 
-    /** Remove a Sprite from the Group */
-    remove: function(o) {
+    // Inherit docs from MixedCollection
+    remove: function(o) {
         var me = this;
         
         o.un({
@@ -117,13 +134,14 @@ Ext.define('Ext.draw.CompositeSprite', {
             mouseout: me.onMouseOut,
             click: me.onClick
         });
-        me.callParent(arguments);
+        return me.callParent(arguments);
     },
     
-    /**
+    /**
      * Returns the group bounding box.
-     * Behaves like {@link Ext.draw.Sprite} getBBox method.
-    */
+     * Behaves like {@link Ext.draw.Sprite#getBBox} method.
+     * @return {Object} an object with x, y, width, and height properties.
+     */
     getBBox: function() {
         var i = 0,
             sprite,
@@ -156,11 +174,12 @@ Ext.define('Ext.draw.CompositeSprite', {
         };
     },
 
-    /**
-     *  Iterates through all sprites calling
-     *  `setAttributes` on each one. For more information
-     *  {@link Ext.draw.Sprite} provides a description of the
-     *  attributes that can be set with this method.
+    /**
+     * Iterates through all sprites calling `setAttributes` on each one. For more information {@link Ext.draw.Sprite}
+     * provides a description of the attributes that can be set with this method.
+     * @param {Object} attrs Attributes to be changed on the sprite.
+     * @param {Boolean} redraw Flag to immediatly draw the change.
+     * @return {Ext.draw.CompositeSprite} this
      */
     setAttributes: function(attrs, redraw) {
         var i = 0,
@@ -173,32 +192,36 @@ Ext.define('Ext.draw.CompositeSprite', {
         return this;
     },
 
-    /**
+    /**
      * Hides all sprites. If the first parameter of the method is true
      * then a redraw will be forced for each sprite.
+     * @param {Boolean} redraw Flag to immediatly draw the change.
+     * @return {Ext.draw.CompositeSprite} this
      */
-    hide: function(attrs) {
+    hide: function(redraw) {
         var i = 0,
             items = this.items,
             len = this.length;
             
         for (; i < len; i++) {
-            items[i].hide();
+            items[i].hide(redraw);
         }
         return this;
     },
 
-    /**
+    /**
      * Shows all sprites. If the first parameter of the method is true
      * then a redraw will be forced for each sprite.
+     * @param {Boolean} redraw Flag to immediatly draw the change.
+     * @return {Ext.draw.CompositeSprite} this
      */
-    show: function(attrs) {
+    show: function(redraw) {
         var i = 0,
             items = this.items,
             len = this.length;
             
         for (; i < len; i++) {
-            items[i].show();
+            items[i].show(redraw);
         }
         return this;
     },
@@ -259,7 +282,7 @@ Ext.define('Ext.draw.CompositeSprite', {
         }
     },
     
-    /**
+    /**
      * Grab the surface from the items
      * @private
      * @return {Ext.draw.Surface} The surface, null if not found
@@ -272,7 +295,7 @@ Ext.define('Ext.draw.CompositeSprite', {
         return null;
     },
     
-    /**
+    /**
      * Destroys the SpriteGroup
      */
     destroy: function(){
@@ -290,4 +313,6 @@ Ext.define('Ext.draw.CompositeSprite', {
         me.clearListeners();
     }
 });
-

\ No newline at end of file
+
+ +