More bug fixes and added documentation - passes the test suite now.
[jquery.git] / fx / fx.js
index c7a0924..71764c0 100644 (file)
--- a/fx/fx.js
+++ b/fx/fx.js
-$.speed = function(s,o) {
-       if ( o && o.constructor == Function ) { o = { onComplete: o }; }
-       o = o || {};
-       var ss = {"crawl":1200,"xslow":850,"slow":600,"medium":400,"fast":200,"xfast":75,"normal":400};
-       o.duration = typeof s == "number" ? s : ss[s] || 400;
-       return o;
-};
+jQuery.fn.extend({
 
-$.fn.hide = function(a,o) {
-       o = $.speed(a,o);
-       return a ? this.each(function(){
-               new $.fx.FadeSize(this,o).hide();
-       }) : this._hide();
-};
-
-$.fn.show = function(a,o) {
-       o = $.speed(a,o);
-       return a ? this.each(function(){
-               new $.fx.FadeSize(this,o).show();
-       }) : this._show();
-};
-
-$.fn.slideDown = function(a,o) {
-       o = $.speed(a,o);
-       return this.each(function(){
-               new $.fx.Resize(this,o).show("height");
-       });
-};
-
-$.fn.slideUp = function(a,o) {
-       o = $.speed(a,o);
-       return this.each(function(){
-               new $.fx.Resize(this,o).hide("height");
-       });
-};
-
-$.fn.fadeOut = function(a,o) {
-       o = $.speed(a,o);
-       return a ? this.each(function(){
-               new $.fx.Opacity(this,o,1).hide();
-       }) : this._hide();
-};
-
-$.fn.fadeIn = function(a,o) {
-       o = $.speed(a,o);
-       return a ? this.each(function(){
-               new $.fx.Opacity(this,o,1).show();
-       }) : this._show();
-};
-
-$.fn.fadeTo = function(a,ev,o) {
-       o = $.speed(a,o);
-       return a ? this.each(function(){
-               ef = new $.fx.Opacity(this,o);
-               ef.custom(ef.cur(),parseFloat(ev));
-               ef.show();
-       }) : this._show();
-};
-
-$.fn.center = function(f) {
-       return this.each(function(){
-               if ( !f && this.nodeName == 'IMG' &&
-                                !this.offsetWidth && !this.offsetHeight ) {
-                       var self = this;
-                       setTimeout(function(){
-                               $(self).center(true);
-                       }, 13);
-               } else {
-                       var s = this.style;
-                       var p = this.parentNode;
-                       if ( $.css(p,"position") == 'static' ) {
-                               p.style.position = 'relative';
+       // overwrite the old show method
+       _show: jQuery.fn.show,
+       
+       /**
+        * The effects module overloads the show method to now allow 
+        * for a speed to the show operation. What actually happens is 
+        * that the height, width, and opacity to the matched elements 
+        * are changed dynamically. The only three current speeds are 
+        * "slow", "normal", and "fast". For example:
+        *   $("p").show("slow");
+        * Note: You should not run the show method on things 
+        * that are already shown. This can be circumvented by doing this:
+        *   $("p:hidden").show("slow");
+        */
+       show: function(speed,callback){
+               return speed ? this.animate({
+                       height: "show", width: "show", opacity: "show"
+               }, speed, callback) : this._show();
+       },
+       
+       // We're overwriting the old hide method
+       _hide: jQuery.fn.hide,
+       
+       /**
+        * The hide function behaves very similary to the show function, 
+        * but is just the opposite.
+        *   $("p:visible").hide("slow");
+        */
+       hide: function(speed,callback){
+               return speed ? this.animate({
+                       height: "hide", width: "hide", opacity: "hide"
+               }, speed, callback) : this._hide();
+       },
+       
+       /**
+        * This function increases the height and opacity for all matched 
+        * elements. This is very similar to 'show', but does not change 
+        * the width - creating a neat sliding effect.
+        *   $("p:hidden").slideDown("slow");
+        */
+       slideDown: function(speed,callback){
+               return this.animate({height: "show"}, speed, callback);
+       },
+       
+       /**
+        * Just like slideDown, only it hides all matched elements.
+        *   $("p:visible").slideUp("slow");
+        */
+       slideUp: function(speed,callback){
+               return this.animate({height: "hide"}, speed, callback);
+       },
+       
+       /**
+        * Adjusts the opacity of all matched elements from a hidden, 
+        * to a fully visible, state.
+        *   $("p:hidden").fadeIn("slow");
+        */
+       fadeIn: function(speed,callback){
+               return this.animate({opacity: "show"}, speed, callback);
+       },
+       
+       /**
+        * Same as fadeIn, but transitions from a visible, to a hidden state.
+        *   $("p:visible").fadeOut("slow");
+        */
+       fadeOut: function(speed,callback){
+               return this.animate({opacity: "hide"}, speed, callback);
+       },
+       
+       /**
+        * ...
+        */
+       fadeTo: function(speed,to,callback){
+               return this.animate({opacity: to}, speed, callback);
+       },
+       
+       /**
+        *
+        */
+       animate: function(prop,speed,callback) {
+               return this.queue(function(){
+                       var i = 0;
+                       for ( var p in prop ) {
+                               var e = new jQuery.fx( this, jQuery.speed(speed,callback,i++), p );
+                               if ( prop[p].constructor == Number )
+                                       e.custom( e.cur(), prop[p] );
+                               else
+                                       e[ prop[p] ]();
                        }
-                       s.position = 'absolute';
-                       s.left = parseInt(($.css(p,"width") - $.css(this,"width"))/2, 10) + "px";
-                       s.top = parseInt(($.css(p,"height") - $.css(this,"height"))/2, 10) + "px";
+               });
+       },
+       
+       /**
+        *
+        * @private
+        */
+       queue: function(type,fn){
+               if ( !fn ) {
+                       fn = type;
+                       type = "fx";
                }
-  });
-};
-
-$.setAuto = function(e,p) {
-       var a = e.style[p];
-       var o = $.css(e,p);
-       e.style[p] = 'auto';
-       var n = $.css(e,p);
-       if ( o != n ) {
-               e.style[p] = a;
+       
+               return this.each(function(){
+                       if ( !this.queue )
+                               this.queue = {};
+       
+                       if ( !this.queue[type] )
+                               this.queue[type] = [];
+       
+                       this.queue[type].push( fn );
+               
+                       if ( this.queue[type].length == 1 )
+                               fn.apply(this);
+               });
        }
-};
-
-/*
- * I originally wrote fx() as a clone of moo.fx and in the process
- * of making it small in size the code became illegible to sane
- * people. You've been warned.
- */
 
-$.fx = function(el,op,ty,tz){
-       var z = this;
-       z.el = el.constructor==String?document.getElementById(el):el;
-       var y = z.el.style;
-       z.a = function(){z.el.style[ty]=z.now+z.o.unit;};
-       z.max = function(){return z.el["io"+ty]||z.cur();};
-       z.cur = function(){return $.css(z.el,ty);};
-       z.show = function(){z.ss("block");z.o.auto=true;z.custom(0,z.max());};
-       z.hide = function(){z.el.$o=$.getCSS(z.el,"overflow");z.el["io"+ty]=this.cur();z.custom(z.cur(),0);};
-       z.ss = function(a){if(y.display!=a){y.display=a;}};
-       z.toggle = function(){if(z.cur()>0){z.hide();}else{z.show();}};
-       z.modify = function(a){z.custom(z.cur(),z.cur()+a);};
-       z.clear = function(){clearInterval(z.timer);z.timer=null;};
-       z.oo = y.overflow;
-       y.overflow = "hidden";
-       z.o = {
-               unit: "px",
-               duration: (op && op.duration) || 400,
-               onComplete: (op && op.onComplete) || op
-       };
-       z.step = function(f,tt){
-               var t = (new Date()).getTime();
-               var p = (t - z.s) / z.o.duration;
-               if (t >= z.o.duration+z.s) {
-                       z.now = tt;
-                       z.clear();
-                       setTimeout(function(){
-                               y.overflow = z.oo;
-                               if(y.height=="0px"||y.width=="0px"){z.ss("none");}
-                               if ( ty != "opacity" && z.o.auto ) {
-                                       $.setAuto( z.el, "height" );
-                                       $.setAuto( z.el, "width" );
-                               }
-                               if(z.o.onComplete.constructor == Function){z.el.$_ = z.o.onComplete;z.el.$_();}
-                       },13);
-               } else {
-                       z.now = ((-Math.cos(p*Math.PI)/2) + 0.5) * (tt-f) + f;
-               }
-               z.a();
-       };
-       z.custom = function(f,t){
-               if(z.timer) {return null;}
-               this.now=f;z.a();z.io=z.cur();z.s=(new Date()).getTime();
-               z.timer=setInterval(function(){z.step(f,t);}, 13);
-       };
-};
+});
 
-$.fx.fn = ["show","hide","toggle"];
-$.fx.ty = ["Height","Width","Left","Top"];
+jQuery.extend({
 
-(function(){
-       for(var $i in $.fx.ty){(function(){
-               var c = $.fx.ty[$i];
-               $.fx[c] = function(a,b){
-                       return new $.fx(a,b,c.toLowerCase(),c);
+       setAuto: function(e,p) {
+               var a = e.style[p];
+               var o = jQuery.css(e,p);
+               e.style[p] = "auto";
+               var n = jQuery.css(e,p);
+               if ( o != n )
+                       e.style[p] = a;
+       },
+       
+       speed: function(s,o,i) {
+               o = o || {};
+               
+               if ( o.constructor == Function )
+                       o = { complete: o };
+               
+               var ss = { slow: 600, fast: 200 };
+               o.duration = (s && s.constructor == Number ? s : ss[s]) || 400;
+       
+               // Queueing
+               o.oldComplete = o.complete;
+               o.complete = function(){
+                       jQuery.dequeue(this, "fx");
+                       if ( o.oldComplete && o.oldComplete.constructor == Function )
+                               o.oldComplete.apply( this );
                };
-       })();}
-})();
-
-$.fx.Opacity = function(a,b,sv){
-       var o = new $.fx(a,b,"opacity");
-       o.cur = function(){return parseFloat(o.el.style.opacity);};
-       o.a = function() {
-               var e = o.el.style;
-               if (o.now == 1) { o.now = 0.9999; }
-               if (window.ActiveXObject) {
-                       e.filter = "alpha(opacity=" + o.now*100 + ")";
+               
+               if ( i > 0 )
+                       o.complete = null;
+       
+               return o;
+       },
+       
+       queue: {},
+       
+       dequeue: function(elem,type){
+               type = type || "fx";
+       
+               if ( elem.queue && elem.queue[type] ) {
+                       // Remove self
+                       elem.queue[type].shift();
+       
+                       // Get next function
+                       var f = elem.queue[type][0];
+               
+                       if ( f )
+                               f.apply( elem );
                }
-               e.opacity = o.now;
-       };
-       o.io = o.now = (sv || o.cur());
-       o.a();
-       return o;
-};
-$.fx.Resize = function(e,o){
-       var z = this;
-       var h = new $.fx.Height(e,o);
-       if(o) { o.onComplete = null; }
-       var w = new $.fx.Width(e,o);
-       function c(a,b,d){return (!a||a==d||b==d);}
-       for(var i in $.fx.fn){(function(){
-               var j = $.fx.fn[i];
-               z[j] = function(a,b){
-                       if(c(a,b,"height")) { h[j](); }
-                       if(c(a,b,"width")) { w[j](); }
+       },
+
+       /*
+        * I originally wrote fx() as a clone of moo.fx and in the process
+        * of making it small in size the code became illegible to sane
+        * people. You've been warned.
+        */
+       
+       fx: function( elem, options, prop ){
+       
+               var z = this;
+       
+               // The users options
+               z.o = {
+                       duration: options.duration || 400,
+                       complete: options.complete
+               };
+       
+               // The element
+               z.el = elem;
+       
+               // The styles
+               var y = z.el.style;
+       
+               // Simple function for setting a style value
+               z.a = function(){
+                       if ( prop == "opacity" ) {
+                               if (z.now == 1) z.now = 0.9999;
+                               if (window.ActiveXObject)
+                                       y.filter = "alpha(opacity=" + z.now*100 + ")";
+                               y.opacity = z.now;
+                       } else
+                               y[prop] = z.now+"px";
+               };
+       
+               // Figure out the maximum number to run to
+               z.max = function(){
+                       return z.el["orig"+prop] || z.cur();
+               };
+       
+               // Get the current size
+               z.cur = function(){
+                       return parseFloat( jQuery.css(z.el,prop) );
+               };
+       
+               // Start an animation from one number to another
+               z.custom = function(from,to){
+                       z.startTime = (new Date()).getTime();
+                       z.now = from;
+                       z.a();
+       
+                       z.timer = setInterval(function(){
+                               z.step(from, to);
+                       }, 13);
+               };
+       
+               // Simple 'show' function
+               z.show = function(){
+                       y.display = "block";
+                       z.o.auto = true;
+                       z.custom(0,z.max());
                };
-       })();}
-       z.modify = function(c,d){
-               h.modify(c);
-               w.modify(d);
-       };
-};
-$.fx.FadeSize = function(e,o){
-       var z = this;
-       var r = new $.fx.Resize(e,o);
-       if(o) { o.onComplete = null; }
-       var p = new $.fx.Opacity(e,o,1);
-       for(var i in $.fx.fn){(function(){
-               var j = $.fx.fn[i];
-               z[j] = function(a,b){p[j]();r[j](a,b);};
-       })();}
-};
+       
+               // Simple 'hide' function
+               z.hide = function(){
+                       // Remember where we started, so that we can go back to it later
+                       z.el["orig"+prop] = this.cur();
+       
+                       // Begin the animation
+                       z.custom(z.cur(),0);
+               };
+       
+               // IE has trouble with opacity if it doesn't have layout
+               if ( jQuery.browser.msie && !z.el.currentStyle.hasLayout )
+                       y.zoom = 1;
+       
+               // Remember  the overflow of the element
+               z.oldOverflow = y.overflow;
+       
+               // Make sure that nothing sneaks out
+               y.overflow = "hidden";
+       
+               // Each step of an animation
+               z.step = function(firstNum, lastNum){
+                       var t = (new Date()).getTime();
+       
+                       if (t > z.o.duration + z.startTime) {
+                               // Stop the timer
+                               clearInterval(z.timer);
+                               z.timer = null;
+       
+                               z.now = lastNum;
+                               z.a();
+       
+                               // Reset the overflow
+                               y.overflow = z.oldOverflow;
+       
+                               // If the element was shown, and not using a custom number,
+                               // set its height and/or width to auto
+                               if ( (prop == "height" || prop == "width") && z.o.auto )
+                                       jQuery.setAuto( z.el, prop );
+       
+                               // If a callback was provided, execute it
+                               if( z.o.complete && z.o.complete.constructor == Function ) {
+       
+                                       // Yes, this is a weird place for this, but it needs to be executed
+                                       // only once per cluster of effects.
+                                       // If the element is, effectively, hidden - hide it
+                                       if ( y.height == "0px" || y.width == "0px" )
+                                               y.display = "none";
+       
+                                       // Execute the complete function
+                                       z.o.complete.apply( z.el );
+                               }
+                       } else {
+                               // Figure out where in the animation we are and set the number
+                               var p = (t - this.startTime) / z.o.duration;
+                               z.now = ((-Math.cos(p*Math.PI)/2) + 0.5) * (lastNum-firstNum) + firstNum;
+       
+                               // Perform the next step of the animation
+                               z.a();
+                       }
+               };
+       
+       }
+
+});