Changeset 603

Timestamp:

02/04/06 09:25:56 (3 years ago)

Author:

therve@gmail.com

Message:

Update docs

Files:

• mochikit/branches/scriptaculous/MochiKit/Visual.js (modified) (4 diffs)
• mochikit/branches/scriptaculous/doc/html/MochiKit/DragAndDrop.html (modified) (1 diff)
• mochikit/branches/scriptaculous/doc/html/MochiKit/Visual.html (modified) (5 diffs)
• mochikit/branches/scriptaculous/doc/html/MochiKit/index.html (modified) (1 diff)
• mochikit/branches/scriptaculous/doc/rst/MochiKit/DragAndDrop.rst (modified) (1 diff)
• mochikit/branches/scriptaculous/doc/rst/MochiKit/Visual.rst (modified) (6 diffs)
• mochikit/branches/scriptaculous/doc/rst/MochiKit/index.rst (modified) (1 diff)

mochikit/branches/scriptaculous/MochiKit/Visual.js

@@ -686 +686 @@
-};
-
-
+
+
-
-MochiKit.Base.update(MochiKit.Visual.Parallel.prototype, {
@@ -722 +723 @@
-};
-
-
+
+
-
-MochiKit.Base.update(MochiKit.Visual.Opacity.prototype, {
@@ -1106 +1108 @@
-    '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);
@@ -1115 +1115 @@
-    };
-    options = MochiKit.Base.update({
-        duration: 1.0,
-        beforeSetupInternal: function (effect) {
-            MochiKit.DOM.setStyle(effect.effects[0].element,

mochikit/branches/scriptaculous/doc/html/MochiKit/DragAndDrop.html

@@ -19 +19 @@
-// Create a draggable
-new Draggable('mydrag');
+
-// Create a corresponding droppable
-new Droppable('mydrop', {

mochikit/branches/scriptaculous/doc/html/MochiKit/Visual.html

@@ -24 +24 @@
-
-// Add an fade effect to an element
-MochiKit.Effect.
+
-</pre>
-</div>
@@ -122 +122 @@
-<a class="mochidef reference" href="#fn-toggle">toggle(element[, effect[, options]])</a>:</p>
-<blockquote>
-
+
+
+
+
+
+
-<p>
-<a name="fn-tagifytext"></a>
-<a class="mochidef reference" href="#fn-tagifytext">tagifyText(element[, tagifyStyle])</a>:</p>
-<blockquote>
-
+
+
+
+
+
-<p>
-<a name="fn-multiple"></a>
@@ -137 +146 @@
-<h2><a id="basic-effects-classes" name="basic-effects-classes">Basic Effects classes</a></h2>
-<p>
+<a name="fn-defaultoptions"></a>
+<a class="mochidef reference" href="#fn-defaultoptions">DefaultOptions</a>:</p>
+<blockquote>
+<p>Default options for all Effect creation.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="78%" />
+</colgroup>
+<tbody valign="top">
+<tr><td>transition</td>
+<td><tt class="docutils literal"><span class="pre">MochiKit.Visual.Transitions.sinoidal</span></tt></td>
+</tr>
+<tr><td>duration</td>
+<td><tt class="docutils literal"><span class="pre">1.0</span></tt></td>
+</tr>
+<tr><td>fps</td>
+<td><tt class="docutils literal"><span class="pre">25.0</span></tt></td>
+</tr>
+<tr><td>sync</td>
+<td><tt class="docutils literal"><span class="pre">false</span></tt></td>
+</tr>
+<tr><td>from</td>
+<td><tt class="docutils literal"><span class="pre">0.0</span></tt></td>
+</tr>
+<tr><td>to</td>
+<td><tt class="docutils literal"><span class="pre">1.0</span></tt></td>
+</tr>
+<tr><td>delay</td>
+<td><tt class="docutils literal"><span class="pre">0.0</span></tt></td>
+</tr>
+<tr><td>queue</td>
+<td><tt class="docutils literal"><span class="pre">'parallel'</span></tt></td>
+</tr>
+</tbody>
+</table>
+</blockquote>
+<p>
-<a name="fn-base"></a>
-<a class="mochidef reference" href="#fn-base">Base()</a>:</p>
-<blockquote>
-
-
+
+
+
+
-<p>
-<a name="fn-parallel"></a>
@@ -151 +200 @@
-<a class="mochidef reference" href="#fn-opacity">Opacity(element [, options])</a>:</p>
-<blockquote>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<p>
-<a name="fn-move"></a>
-<a class="mochidef reference" href="#fn-move">Move(element [, options])</a>:</p>
-<blockquote>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<p>
-<a name="fn-scale"></a>
-<a class="mochidef reference" href="#fn-scale">Scale(element, percent [, options])</a>:</p>
-<blockquote>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<p>
-<a name="fn-highlight"></a>
-<a class="mochidef reference" href="#fn-highlight">Highlight(element [, options])</a>:</p>
-<blockquote>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<p>
-<a name="fn-scrollto"></a>
@@ -179 +311 @@
-<a class="mochidef reference" href="#fn-fade">Fade(element [, options])</a>:</p>
-<blockquote>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<p>
-<a name="fn-appear"></a>
-<a class="mochidef reference" href="#fn-appear">Appear(element [, options])</a>:</p>
-<blockquote>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<p>
-<a name="fn-puff"></a>

mochikit/branches/scriptaculous/doc/html/MochiKit/index.html

@@ -28 +28 @@
-<li><a class="mochiref reference" href="Visual.html">MochiKit.Visual</a> - visual effects</li>
-<li><a class="mochiref reference" href="DragAndDrop.html">MochiKit.DragAndDrop</a> - drag and drop</li>
-<li><a class="mochiref reference" href="Effects.html">MochiKit.Effects</a> - visual effects too</li>
-</ul>
-</div>

mochikit/branches/scriptaculous/doc/rst/MochiKit/DragAndDrop.rst

@@ -13 +13 @@
-    // Create a draggable
-    new Draggable('mydrag');
+
-    // Create a corresponding droppable
-    new Droppable('mydrop', {

mochikit/branches/scriptaculous/doc/rst/MochiKit/Visual.rst

@@ -19 +19 @@
-
-    // Add an fade effect to an element
-MochiKit.Effect.
+
-    
-
@@ -105 +105 @@
-    Toggle an element between visible and invisible state using an effect.
-
+    effect:
+        
+        One of the visual pairs to use, between 'slide', 'blind', 'appear', 
+        and 'size'.
+
-:mochidef:`tagifyText(element[, tagifyStyle])`:
-
-    Transform a node text into nodes containing one letter by tag.
+
+    tagifyStyle:
+
+        style to apply to character nodes, default to 'position: relative'.
-
-:mochidef:`multiple(elements, effect[, options])`:
@@ -116 +125 @@
----------------------
-
+:mochidef:`DefaultOptions`:
+
+    Default options for all Effect creation.
+
+    =========== ========================================
+    transition  ``MochiKit.Visual.Transitions.sinoidal``
+    duration    ``1.0``
+    fps         ``25.0``
+    sync        ``false``
+    from        ``0.0``
+    to          ``1.0``
+    delay       ``0.0``
+    queue       ``'parallel'``
+    =========== ========================================
+
-:mochidef:`Base()`:
-
@@ -121 +145 @@
-    creating new effects.
-
+    You can override the methods ``setup``, ``update`` and ``finish```.
+
-:mochidef:`Parallel(effects [, options])`:
-
@@ -129 +155 @@
-    Change the opacity of an element progressively.
-
+    options:
+
+    ====== ========
+    from   ``0.0``
+    to     ``1.0``
+    ====== ========
+
-:mochidef:`Move(element [, options])`:
-
-    Change the position of an element in small steps, creating a moving effect.
-
+    options:
+
+    ========= ================
+    x         ``0``
+    y         ``0``
+    position  ``'relative'``
+    ========= ================
+
-:mochidef:`Scale(element, percent [, options])`:
-
-    Change the size of an element.
-
+    percent:
+    
+        Final wanted size in percent of current size. The size will be reduced
+        if the value is between 0 and 1, and raised if the value is above 1.
+
+    options:
+
+    ================ ============
+    scaleX           ``true``
+    scaleY           ``true``
+    scaleContent     ``true``
+    scaleFromCenter  ``false``
+    scaleMode        ``'box'``
+    scaleFrom        ``100.0``
+    scaleTo          ``percent``
+    ================ ============
+
+
-:mochidef:`Highlight(element [, options])`:
-
-    Highlight an element, flashing with one color.
+
+    options:
+
+    =========== ==============
+    startcolor  ``'#ffff99'``
+    =========== ==============
-
-:mochidef:`ScrollTo(element [, options])`:
@@ -152 +217 @@
-    Change the opacity of an element until making it disappear.
-
+    options:
+
+    ====== =============================================
+    from   ``MochiKit.DOM.getOpacity(element) || 1.0``
+    to     ``0.0``
+    ====== =============================================
+
-:mochidef:`Appear(element [, options])`:
-
-    Slowly show an invisible element.
+
+    options:
+
+    ===== =========
+    from  ``0.0``
+    to    ``1.0``
+    ===== =========
-
-:mochidef:`Puff(element [, options])`:

mochikit/branches/scriptaculous/doc/rst/MochiKit/index.rst

@@ -20 +20 @@
-- :mochiref:`MochiKit.Visual` - visual effects
-- :mochiref:`MochiKit.DragAndDrop` - drag and drop
-- :mochiref:`MochiKit.Effects` - visual effects too
-
-