X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/CompositeSprite.html
diff --git a/docs/source/CompositeSprite.html b/docs/source/CompositeSprite.html
index b1bf8438..0c398d32 100644
--- a/docs/source/CompositeSprite.html
+++ b/docs/source/CompositeSprite.html
@@ -3,8 +3,8 @@
The source code
-
-
+
+
@@ -111,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;
@@ -122,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({
@@ -134,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,
@@ -174,10 +175,11 @@ 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,
@@ -193,6 +195,8 @@ Ext.define('Ext.draw.CompositeSprite', {
/**
* 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(redraw) {
var i = 0,
@@ -208,6 +212,8 @@ Ext.define('Ext.draw.CompositeSprite', {
/**
* 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(redraw) {
var i = 0,