Added a couple new AJAX methods and finished documenting everything.
[jquery.git] / src / fx / fx.js
index 72bfbf8..14dfa55 100644 (file)
@@ -1,7 +1,7 @@
 jQuery.fn.extend({
 
        // overwrite the old show method
-       //_show: jQuery.fn.show,
+       _show: jQuery.fn.show,
        
        /**
         * Show all matched elements using a graceful animation.
@@ -39,7 +39,7 @@ jQuery.fn.extend({
        },
        
        // Overwrite the old hide method
-       //_hide: jQuery.fn.hide,
+       _hide: jQuery.fn.hide,
        
        /**
         * Hide all matched elements using a graceful animation.
@@ -142,6 +142,35 @@ jQuery.fn.extend({
                return this.animate({height: "hide"}, speed, callback);
        },
 
+       /**
+        * Toggle the visibility of all matched elements by adjusting their height.
+        * Only the height is adjusted for this animation, causing all matched
+        * elements to be hidden in a "sliding" manner.
+        *
+        * @example $("p").slideToggle("slow");
+        *
+        * @name slideToggle
+        * @type jQuery
+        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).
+        * @cat Effects/Animations
+        */
+        
+       /**
+        * Toggle the visibility of all matched elements by adjusting their height
+        * and firing a callback function after completion.
+        * Only the height is adjusted for this animation, causing all matched
+        * elements to be hidden in a "sliding" manner.
+        *
+        * @example $("p").slideToggle("slow",function(){
+        *   alert("Animation Done.");
+        * });
+        *
+        * @name slideToggle
+        * @type jQuery
+        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).
+        * @param Function callback A function to be executed whenever the animation completes.
+        * @cat Effects/Animations
+        */
        slideToggle: function(speed,callback){
                return this.each(function(){
                        var state = $(this).is(":hidden") ? "show" : "hide";
@@ -257,18 +286,45 @@ jQuery.fn.extend({
        },
        
        /**
-        * @private
+        * A function for making your own, custom, animations. The key aspect of
+        * this function is the object of style properties that will be animated,
+        * and to what end. Each key within the object represents a style property
+        * that will also be animated (for example: "height", "top", or "opacity").
+        *
+        * The value associated with the key represents to what end the property
+        * will be animated. If a number is provided as the value, then the style
+        * property will be transitioned from its current state to that new number.
+        * Oterwise if the string "hide", "show", or "toggle" is provided, a default
+        * animation will be constructed for that property.
+        *
+        * @example $("p").animate({
+        *   height: 'toggle', opacity: 'toggle'
+        * }, "slow");
+        *
+        * @example $("p").animate({
+        *   left: 50, opacity: 'show'
+        * }, 500);
+        *
+        * @name animate
+        * @type jQuery
+        * @param Hash params A set of style attributes that you wish to animate, and to what end.
+        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).
+        * @param Function callback A function to be executed whenever the animation completes.
+        * @cat Effects/Animations
         */
        animate: function(prop,speed,callback) {
                return this.queue(function(){
-                       var i = 0;
+               
+                       this.curAnim = prop;
+                       
                        for ( var p in prop ) {
-                               var e = new jQuery.fx( this, jQuery.speed(speed,callback,i++), p );
+                               var e = new jQuery.fx( this, jQuery.speed(speed,callback), p );
                                if ( prop[p].constructor == Number )
                                        e.custom( e.cur(), prop[p] );
                                else
                                        e[ prop[p] ]( prop );
                        }
+                       
                });
        },
        
@@ -328,7 +384,7 @@ jQuery.extend({
                }
        },
        
-       speed: function(s,o,i) {
+       speed: function(s,o) {
                o = o || {};
                
                if ( o.constructor == Function )
@@ -344,9 +400,6 @@ jQuery.extend({
                        if ( o.oldComplete && o.oldComplete.constructor == Function )
                                o.oldComplete.apply( this );
                };
-               
-               if ( i > 0 )
-                       o.complete = null;
        
                return o;
        },
@@ -396,7 +449,7 @@ jQuery.extend({
                                options.step.apply( elem, [ z.now ] );
 
                        if ( prop == "opacity" ) {
-                               if (z.now == 1) z.now = 0.9999;
+                               if (jQuery.browser.mozilla && z.now == 1) z.now = 0.9999;
                                if (window.ActiveXObject)
                                        y.filter = "alpha(opacity=" + z.now*100 + ")";
                                else
@@ -405,6 +458,7 @@ jQuery.extend({
                        // My hate for IE will never die
                        } else if ( parseInt(z.now) )
                                y[prop] = parseInt(z.now) + "px";
+                               
                        y.display = "block";
                };
        
@@ -454,7 +508,7 @@ jQuery.extend({
                        z.o.hide = true;
 
                        // Begin the animation
-                       z.custom(z.cur(),0);
+                       z.custom(z.el.orig[prop], 0);
                };
        
                // IE has trouble with opacity if it does not have layout
@@ -466,7 +520,6 @@ jQuery.extend({
                        z.el.oldOverflow = jQuery.css( z.el, "overflow" );
        
                // Make sure that nothing sneaks out
-               //if ( z.el.oldOverlay == "visible" )
                y.overflow = "hidden";
        
                // Each step of an animation
@@ -481,23 +534,35 @@ jQuery.extend({
                                z.now = lastNum;
                                z.a();
 
-                               // Hide the element if the "hide" operation was done
-                               if ( z.o.hide ) y.display = 'none';
-       
-                               // Reset the overflow
-                               y.overflow = z.el.oldOverflow;
-
-                               // Reset the property, if the item has been hidden
-                               if ( z.o.hide )
-                                       y[ prop ] = z.el.orig[ prop ].constructor == Number && prop != "opacity" ?
-                                               z.el.orig[prop] + "px" : z.el.orig[prop];
-
-                               // set its height and/or width to auto
-                               if ( prop == 'height' || prop == 'width' )
-                                       jQuery.setAuto( z.el, prop );
+                               z.el.curAnim[ prop ] = true;
+                               
+                               var done = true;
+                               for ( var i in z.el.curAnim )
+                                       if ( z.el.curAnim[i] !== true )
+                                               done = false;
+                                               
+                               if ( done ) {
+                                       // Reset the overflow
+                                       y.overflow = z.el.oldOverflow;
+                               
+                                       // Hide the element if the "hide" operation was done
+                                       if ( z.o.hide ) 
+                                               y.display = 'none';
+                                       
+                                       // Reset the property, if the item has been hidden
+                                       if ( z.o.hide ) {
+                                               for ( var p in z.el.curAnim ) {
+                                                       y[ p ] = z.el.orig[p] + ( p == "opacity" ? "" : "px" );
+       
+                                                       // set its height and/or width to auto
+                                                       if ( p == 'height' || p == 'width' )
+                                                               jQuery.setAuto( z.el, p );
+                                               }
+                                       }
+                               }
 
                                // If a callback was provided, execute it
-                               if( z.o.complete && z.o.complete.constructor == Function )
+                               if( done && z.o.complete && z.o.complete.constructor == Function )
                                        // Execute the complete function
                                        z.o.complete.apply( z.el );
                        } else {