Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / CompositeSprite.html
index c540b81..0c398d3 100644 (file)
@@ -1,4 +1,21 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-draw.CompositeSprite'>/**
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <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>
+  <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>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-draw-CompositeSprite'>/**
 </span> * @class Ext.draw.CompositeSprite
  * @extends Ext.util.MixedCollection
  *
@@ -94,8 +111,8 @@ Ext.define('Ext.draw.CompositeSprite', {
         });
     },
 
-<span id='Ext-draw.CompositeSprite-method-add'>    /** Add a Sprite to the Group */
-</span>    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);
     },
 
-<span id='Ext-draw.CompositeSprite-method-remove'>    /** Remove a Sprite from the Group */
-</span>    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);
     },
     
-<span id='Ext-draw.CompositeSprite-method-getBBox'>    /**
+<span id='Ext-draw-CompositeSprite-method-getBBox'>    /**
 </span>     * 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', {
         };
     },
 
-<span id='Ext-draw.CompositeSprite-method-setAttributes'>    /**
-</span>     *  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.
+<span id='Ext-draw-CompositeSprite-method-setAttributes'>    /**
+</span>     * 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;
     },
 
-<span id='Ext-draw.CompositeSprite-method-hide'>    /**
+<span id='Ext-draw-CompositeSprite-method-hide'>    /**
 </span>     * 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 &lt; len; i++) {
-            items[i].hide();
+            items[i].hide(redraw);
         }
         return this;
     },
 
-<span id='Ext-draw.CompositeSprite-method-show'>    /**
+<span id='Ext-draw-CompositeSprite-method-show'>    /**
 </span>     * 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 &lt; len; i++) {
-            items[i].show();
+            items[i].show(redraw);
         }
         return this;
     },
@@ -259,7 +282,7 @@ Ext.define('Ext.draw.CompositeSprite', {
         }
     },
     
-<span id='Ext-draw.CompositeSprite-method-getSurface'>    /**
+<span id='Ext-draw-CompositeSprite-method-getSurface'>    /**
 </span>     * 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;
     },
     
-<span id='Ext-draw.CompositeSprite-method-destroy'>    /**
+<span id='Ext-draw-CompositeSprite-method-destroy'>    /**
 </span>     * Destroys the SpriteGroup
      */
     destroy: function(){
@@ -290,4 +313,6 @@ Ext.define('Ext.draw.CompositeSprite', {
         me.clearListeners();
     }
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>