Changeset 506

Timestamp:

01/15/06 08:02:34 (3 years ago)

Author:

therve@gmail.com

Message:

Add doc, correct bug on Pulsate.

Files:

• mochikit/branches/scriptaculous/MochiKit/Effects.js (modified) (21 diffs)

mochikit/branches/scriptaculous/MochiKit/Effects.js

@@ -614 +614 @@
-        MochiKit.DOM.setStyle(this.element,
-            MochiKit.Base.update(this.oldStyle, {
-
+    
-        }));
-    }
@@ -670 +670 @@
-
-Effect.Fade = function (element, options) {
+    /***
+
+    Fade a given element: change its opacity and hide it in the end.
+
+    @param options: 'to' and 'from' to change opacity.
+
+    ***/
-    var oldOpacity = MochiKit.DOM.getInlineOpacity(element);
-    options = MochiKit.Base.update({
@@ -675 +682 @@
-        to: 0.0,
-        afterFinishInternal: function (effect) {
-effect.options.to != 0
+!effect.options.to
-                return;
-            }
@@ -686 +693 @@
-
-Effect.Appear = function (element, options) {
+    /***
+
+    Make an element appear.
+
+    @param options: 'to' and 'from' to change opacity.
+
+    ***/
-    options = MochiKit.Base.update({
-
+
+
-        to: 1.0,
-        beforeSetup: function (effect) {
@@ -698 +713 @@
-
-Effect.Puff = function (element, options) {
+    /***
+
+    'Puff' an element: grow it to double size, fading it and make it hidden.
+
+    @param options: 'duration' in seconds for the effect, default to 1.0.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    var oldStyle = {
@@ -706 +728 @@
-        duration: 1.0,
-        beforeSetupInternal: function (effect) {
-
+
+
-        },
-        afterFinishInternal: function (effect) {
@@ -714 +737 @@
-    }, options || {});
-    return new Effect.Parallel(
-
+   
-            {sync: true, scaleFromCenter: true,
-             scaleContent: true, restoreAfterFinish: true}),
-
-
+   
+  
-    );
-};
-
-Effect.BlindUp = function (element, options) {
+    /***
+
+    Blind an element up: change its vertical size to 0.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    MochiKit.DOM.makeClipping(element);
@@ -739 +767 @@
-
-Effect.BlindDown = function (element, options) {
+    /***
+
+    Blind an element down: restore its vertical size.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    var oldHeight = MochiKit.DOM.getStyle(element, 'height');
@@ -763 +796 @@
-
-Effect.SwitchOff = function (element) {
+    /***
+
+    Apply a switch-off-like effect.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    var oldOpacity = MochiKit.DOM.getInlineOpacity(element);
@@ -793 +831 @@
-
-Effect.DropOut = function (element, options) {
+    /***
+
+    Make an element fall and disappear.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    var oldStyle = {
@@ -818 +861 @@
-
-Effect.Shake = function (element) {
+    /***
+
+    Move an element from left to right several times.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    var oldStyle = {
@@ -823 +871 @@
-        left: MochiKit.DOM.getStyle(element, 'left') };
-        return new Effect.Move(element,
-  
+
-        new Effect.Move(effect.element,
-  
+
-        new Effect.Move(effect.element,
- 
+
-        new Effect.Move(effect.element,
-  
+
-        new Effect.Move(effect.element,
- 
+
-        new Effect.Move(effect.element,
-   
+
-                MochiKit.DOM.undoPositioned(effect.element);
-                MochiKit.DOM.setStyle(effect.element, oldStyle);
@@ -840 +888 @@
-
-Effect.SlideDown = function (element, options) {
+    /***
+
+    Slide an element down.
+    It needs to have the content of the element wrapped in a container
+    element with fixed height.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    MochiKit.DOM.cleanWhitespace(element);
-    // SlideDown need to have the content of the element wrapped in
-    // a container element with fixed height!
-    var oldInnerBottom = MochiKit.DOM.getStyle(element.firstChild, 'bottom');
-    var elementDimensions = MochiKit.DOM.elementDimensions(element);
@@ -871 +924 @@
-            MochiKit.DOM.undoPositioned(effect.element.firstChild);
-            MochiKit.DOM.undoPositioned(effect.element);
-
+
+
-        }
-    }, options || {});
@@ -879 +933 @@
-
-Effect.SlideUp = function (element, options) {
+    /***
+
+    Slide an element up.
+    It needs to have the content of the element wrapped in a container
+    element with fixed height.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    MochiKit.DOM.cleanWhitespace(element);
@@ -912 +973 @@
-};
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-             MochiKit.DOM.makeClipping(effect.element);
- 
- 
+
+
-              MochiKit.DOM.hideElement(effect.element);
-              MochiKit.DOM.undoClipping(effect.element);
-
-
+
+
+
+
-};
-
-Effect.Grow = function (element, options) {
+    /***
+
+    Grow an element to its original size. Make it zero-sized before
+    if necessary.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    options = MochiKit.Base.update({
@@ -997 +1072 @@
-            new Effect.Parallel(
-                [new Effect.Opacity(effect.element, {
-
+
+
-                 }),
-                 new Effect.Move(effect.element, {
-
+
+
-                 }),
-                 new Effect.Scale(effect.element, 100, {
@@ -1017 +1094 @@
-
-Effect.Shrink = function (element, options) {
+    /***
+
+    Shrink an element and make it disappear.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    options = MochiKit.Base.update({
@@ -1056 +1138 @@
-    }
-
-
-
+
-        beforeStartInternal: function (effect) {
-            MochiKit.DOM.makePositioned(effect.effects[0].element);
@@ -1087 +1168 @@
-
-Effect.Pulsate = function (element, options) {
+    /***
+
+    Pulse an element between appear/fade.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    options = MochiKit.Base.update({
@@ -1093 +1179 @@
-        afterFinishInternal: function (effect) {
-            MochiKit.DOM.setStyle(effect.element, {opacity: oldOpacity});
-
-
+
-    }, options || {});
-    var oldOpacity = MochiKit.DOM.getInlineOpacity(element);
-    var transition = options.transition || Effect.Transitions.sinoidal;
-
+MochiKit.Base.bind(
-        return transition(1 - Effect.Transitions.pulse(pos));
-
+, transition)
-    MochiKit.Base.bind(reverser, transition);
-
+
+
-};
-
-Effect.Fold = function (element, options) {
+    /***
+
+    Fold an element, first vertically, then horizontally.
+
+    ***/
-    element = MochiKit.DOM.getElement(element);
-    var oldStyle = {