Changeset 504

Timestamp:

01/15/06 06:24:58 (3 years ago)

Author:

therve@gmail.com

Message:

Add docs to effects, correct a bug in ScrollTo?.

Files:

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

mochikit/branches/scriptaculous/MochiKit/Effects.js

@@ -14 +14 @@
-var Effect = {
-    tagifyText: function (element) {
+        // XXX: what's this function for ? Doesn't work
-        var tagifyStyle = 'position:relative';
-        if (MochiKit.Base.isIE()) {
@@ -33 +34 @@
-
-    multiple: function (element, effect, options) {
+        // XXX: what's this function for ? Doesn't work
-        var elements;
-        if (((typeof(element) == 'object') ||
@@ -59 +61 @@
-    },
-
-
+
+
+
+
+
+
+
+
-        element = MochiKit.DOM.getElement(element);
-        effect = (effect || 'appear').toLowerCase();
@@ -66 +75 @@
-        }, options || {});
-        Effect[MochiKit.DOM.isVisible(element) ?
-  
+
-    }
-};
-
-
+
+
+
+
+
-
-Effect.Transitions = {}
@@ -80 +93 @@
-    return (-Math.cos(pos*Math.PI)/2) + 0.5;
-}
-   
--
+
+ - 
-}
-Effect.Transitions.flicker = function (pos) {
@@ -91 +104 @@
-Effect.Transitions.pulse = function (pos) {
-    return (Math.floor(pos*10) % 2 == 0 ?
--Math.floor(pos*10)) : 1-(pos*10-
+ - Math.floor(pos*10)) : 1 - (pos*10 - 
-}
-Effect.Transitions.none = function (pos) {
@@ -100 +113 @@
-}
-
-
+
+
+
+
+
-
-Effect.ScopedQueue = function () {
@@ -145 +162 @@
-        this.effects.push(effect);
-        if (!this.interval) {
-
+
+
-        }
-    },
@@ -169 +187 @@
-Effect.Queues = {
-    instances: new Array(),
+
-    get: function (queueName) {
-        if (typeof(queueName) != 'string') {
@@ -197 +216 @@
-
-Effect.Base.prototype = {
+    /***
+
+    Basic class for all Effects. Define a looping mecanism called for each step
+    of an effect. Don't instanciate it, only subclass it.
+
+    ***/
-    position: null,
-
-    start: function (options) {
-
+
+
-        this.currentFrame = 0;
-        this.state = 'idle';
@@ -225 +251 @@
-            }
-            var pos = (timePos - this.startOn) / (this.finishOn - this.startOn);
-
+
+
-            if (frame > this.currentFrame) {
-                this.render(pos);
@@ -275 +302 @@
-
-    __repr__: function () {
-
+
+
-    }
-}
@@ -286 +314 @@
-
-MochiKit.Base.update(Effect.Parallel.prototype, {
+    /***
+
+    Run multiple effects at the same time.
+
+    ***/
-    __init__: function (effects, options) {
-        this.effects = effects || [];
@@ -317 +350 @@
-
-MochiKit.Base.update(Effect.Opacity.prototype, {
-
+
+
+
+
+
+
+
+
+
-        this.element = MochiKit.DOM.getElement(element);
-        // make this work on IE on elements without 'layout'
@@ -342 +383 @@
-
-MochiKit.Base.update(Effect.Move.prototype, {
-
+
+
+
+
+
+
+
+
-        this.element = MochiKit.DOM.getElement(element);
-        options = MochiKit.Base.update({
@@ -353 +401 @@
-
-    setup: function () {
- or
-
- stylesheets
-
+
+or 
+
+stylesheets 
-        MochiKit.DOM.makePositioned(this.element);
-
-
+
+
+
+
-        if (this.options.mode == 'absolute') {
-            // absolute movement, so we need to calc deltaX and deltaY
@@ -382 +432 @@
-
-MochiKit.Base.update(Effect.Scale.prototype, {
-
+
+
+
+
+
+
+
+
+
+
-        this.element = MochiKit.DOM.getElement(element)
-        options = MochiKit.Base.update({
@@ -398 +457 @@
-    setup: function () {
-        this.restoreAfterFinish = this.options.restoreAfterFinish || false;
-
+
+
-
-        this.originalStyle = {};
@@ -409 +469 @@
-        this.originalLeft = this.element.offsetLeft;
-
-
-
+
+
+
+
-            if (fontSize.indexOf(fontSizeType) > 0) {
-                this.fontSize = parseFloat(fontSize);
@@ -433 +495 @@
-
-    update: function (position) {
-
+
+
-        if (this.options.scaleContent && this.fontSize) {
-            MochiKit.DOM.setStyle(this.element, {
@@ -439 +502 @@
-            });
-        }
-
+
+
-    },
-
@@ -486 +550 @@
-
-MochiKit.Base.update(Effect.Highlight.prototype, {
-
+
+
+
+
+
+
+
+
+
-        this.element = MochiKit.DOM.getElement(element);
-        options = MochiKit.Base.update({
-
-
+
-        }, options || {});
-        this.start(options);
@@ -503 +574 @@
-        // Disable background image during the effect
-        this.oldStyle = {
-
+
+
-        };
-        MochiKit.DOM.setStyle(this.element, {
@@ -510 +582 @@
-
-        if (!this.options.endcolor) {
-
+
+
-        }
-        if(!this.options.restorecolor) {
-
+
+
-        }
-        // init color calculations
-        this._base = MochiKit.Base.map(MochiKit.Base.bind(function (i) {
-
+
+
-        }, this), [0, 1, 2]);
-        this._delta = MochiKit.Base.map(MochiKit.Base.bind(function (i) {
-
+
+
-        }, this), [0, 1, 2]);
-    },
@@ -527 +603 @@
-        var m = '#';
-        MochiKit.Iter.forEach([0, 1, 2], MochiKit.Base.bind(function (i) {
-
+
+
-        }, this));
-        MochiKit.DOM.setStyle(this.element, {
@@ -535 +612 @@
-
-    finish: function () {
-
+
+
-            backgroundColor: this.options.endColor
-        }));
@@ -548 +626 @@
-
-MochiKit.Base.update(Effect.ScrollTo.prototype, {
-
+
+
+
+
+
+
-        this.element = MochiKit.DOM.getElement(element);
-        this.start(options || {});
@@ -554 +637 @@
-
-    setup: function () {
-
+MochiKit.
-        var offsets = MochiKit.Position.cumulativeOffset(this.element);
-        if (this.options.offset) {
@@ -563 +646 @@
-            document.body.scrollHeight -
-                (document.documentElement.clientHeight ?
-
+
+
-        this.scrollStart = MochiKit.Position.deltaY;
-        this.delta = (offsets[1] > max ? max : offsets[1]) - this.scrollStart;
@@ -569 +653 @@
-
-    update: function (position) {
-
-
+MochiKit.
+MochiKit.
-            this.scrollStart + (position*this.delta));
-    }
-});
-
-
+
+
+
+
+
-
-Effect.Fade = function (element, options) {