Changeset 1341

Show
Ignore:
Timestamp:
03/24/08 02:26:49 (4 months ago)
Author:
cederberg@gmail.com
Message:

Updated API docs for MochiKit.Visual.switchOff(), dropOut(), shake() and squish().

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • mochikit/trunk/doc/html/MochiKit/Visual.html

    r1337 r1341  
    383383<a class="mochidef reference" href="#fn-switchoff">switchOff(element [, options])</a>:</p> 
    384384<blockquote> 
    385 <p>A switch-off like effect, making the element disappear.</p> 
    386 <dl class="docutils"> 
    387 <dt>element:</dt> 
    388 <dd>An element ID string or a DOM node (see 
    389 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     385<p>A switch-off like effect, making the <tt class="docutils literal"><span class="pre">element</span></tt> disappear, using 
     386the <a class="mochiref reference" href="#fn-opacity">Opacity</a> and <a class="mochiref reference" href="#fn-scale">Scale</a> effects in sequence. 
     387The initial <a class="mochiref reference" href="#fn-opacity">Opacity</a> effect uses a flicker (partially 
     388random) transformation. Once the effect has completed, the 
     389<tt class="docutils literal"><span class="pre">element</span></tt> will be hidden with 
     390<a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> and the original element 
     391opacity, size and position will be restored.</p> 
     392<dl class="docutils"> 
     393<dt>element:</dt> 
     394<dd>An element ID string or a DOM node (see 
     395<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     396<dt>options:</dt> 
     397<dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>. Note that the options will 
     398only affect the secondary <a class="mochiref reference" href="#fn-scale">Scale</a> effect.</dd> 
    390399<dt><em>Availability</em>:</dt> 
    391400<dd>Available in MochiKit 1.4+</dd> 
    …… 
    396405<a class="mochidef reference" href="#fn-dropout">dropOut(element [, options])</a>:</p> 
    397406<blockquote> 
    398 <p>Make the element fall and fade.</p> 
    399 <dl class="docutils"> 
    400 <dt>element:</dt> 
    401 <dd>An element ID string or a DOM node (see 
    402 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
    403 <dt>options:</dt> 
    404 <dd><table border="1" class="first last docutils"> 
     407<p>Make the element fall and fade using the 
     408<a class="mochiref reference" href="#fn-move">Move</a> and <a class="mochiref reference" href="#fn-opacity">Opacity</a> effects in parallel. 
     409Once the effect has completed, the <tt class="docutils literal"><span class="pre">element</span></tt> will be hidden with 
     410<a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> and the original element 
     411position and opacity will be restored.</p> 
     412<dl class="docutils"> 
     413<dt>element:</dt> 
     414<dd>An element ID string or a DOM node (see 
     415<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     416<dt>options:</dt> 
     417<dd><p class="first">The <tt class="docutils literal"><span class="pre">distance</span></tt> option controls the number of pixels that the 
     418element will move downwards. See also the 
     419<a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</p> 
     420<table border="1" class="last docutils"> 
    405421<colgroup> 
    406422<col width="53%" /> 
    …… 
    422438<a class="mochidef reference" href="#fn-shake">shake(element [, options])</a>:</p> 
    423439<blockquote> 
    424 <p>Shake an element from left to right.</p> 
    425 <dl class="docutils"> 
    426 <dt>element:</dt> 
    427 <dd>An element ID string or a DOM node (see 
    428 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     440<p>Shake an element from left to right using a sequence of six 
     441<a class="mochiref reference" href="#fn-move">Move</a> effects. Once the effect has completed, the 
     442original <tt class="docutils literal"><span class="pre">element</span></tt> position will be restored.</p> 
     443<dl class="docutils"> 
     444<dt>element:</dt> 
     445<dd>An element ID string or a DOM node (see 
     446<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     447<dt>options:</dt> 
     448<dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>. Note that the options will 
     449only affect the last <a class="mochiref reference" href="#fn-move">Move</a> effect.</dd> 
    429450<dt><em>Availability</em>:</dt> 
    430451<dd>Available in MochiKit 1.4+</dd> 
    …… 
    473494<a class="mochidef reference" href="#fn-squish">squish(element [, options])</a>:</p> 
    474495<blockquote> 
    475 <p>Reduce the horizontal and vertical sizes at the same time, using 
    476 the top left corner.</p> 
    477 <dl class="docutils"> 
    478 <dt>element:</dt> 
    479 <dd>An element ID string or a DOM node (see 
    480 <a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     496<p>Reduce the horizontal and vertical sizes at the same time using 
     497a single <a class="mochiref reference" href="#fn-scale">Scale</a> effect. The result is similar to the 
     498<a class="mochiref reference" href="#fn-shrink">shrink</a> effect with a <tt class="docutils literal"><span class="pre">top-left</span></tt> value for the 
     499<tt class="docutils literal"><span class="pre">direction</span></tt> option. The <tt class="docutils literal"><span class="pre">element</span></tt> should have fixed width and 
     500height. Once the effect has completed, the <tt class="docutils literal"><span class="pre">element</span></tt> will be 
     501hidden with <a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> and the 
     502original element size will be restored.</p> 
     503<dl class="docutils"> 
     504<dt>element:</dt> 
     505<dd>An element ID string or a DOM node (see 
     506<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     507<dt>options:</dt> 
     508<dd>See <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>.</dd> 
    481509<dt><em>Availability</em>:</dt> 
    482510<dd>Available in MochiKit 1.4+</dd> 

  • mochikit/trunk/doc/rst/MochiKit/Visual.rst

    r1337 r1341  
    316316:mochidef:`switchOff(element [, options])`: 
    317317 
    318     A switch-off like effect, making the element disappear. 
    319  
    320     element: 
    321         An element ID string or a DOM node (see 
    322         :mochiref:`MochiKit.DOM.getElement`). 
     318    A switch-off like effect, making the ``element`` disappear, using 
     319    the :mochiref:`Opacity` and :mochiref:`Scale` effects in sequence. 
     320    The initial :mochiref:`Opacity` effect uses a flicker (partially 
     321    random) transformation. Once the effect has completed, the 
     322    ``element`` will be hidden with 
     323    :mochiref:`MochiKit.Style.hideElement` and the original element 
     324    opacity, size and position will be restored. 
     325 
     326    element: 
     327        An element ID string or a DOM node (see 
     328        :mochiref:`MochiKit.DOM.getElement`). 
     329 
     330    options: 
     331        See :mochiref:`DefaultOptions`. Note that the options will 
     332        only affect the secondary :mochiref:`Scale` effect. 
    323333 
    324334    *Availability*: 
    …… 
    328338:mochidef:`dropOut(element [, options])`: 
    329339 
    330     Make the element fall and fade. 
    331  
    332     element: 
    333         An element ID string or a DOM node (see 
    334         :mochiref:`MochiKit.DOM.getElement`). 
    335  
    336     options: 
     340    Make the element fall and fade using the 
     341    :mochiref:`Move` and :mochiref:`Opacity` effects in parallel. 
     342    Once the effect has completed, the ``element`` will be hidden with 
     343    :mochiref:`MochiKit.Style.hideElement` and the original element 
     344    position and opacity will be restored. 
     345 
     346    element: 
     347        An element ID string or a DOM node (see 
     348        :mochiref:`MochiKit.DOM.getElement`). 
     349 
     350    options: 
     351        The ``distance`` option controls the number of pixels that the 
     352        element will move downwards. See also the 
     353        :mochiref:`DefaultOptions`. 
     354 
    337355        ======== ======= 
    338356        distance ``100`` 
    …… 
    345363:mochidef:`shake(element [, options])`: 
    346364 
    347     Shake an element from left to right. 
    348  
    349     element: 
    350         An element ID string or a DOM node (see 
    351         :mochiref:`MochiKit.DOM.getElement`). 
     365    Shake an element from left to right using a sequence of six 
     366    :mochiref:`Move` effects. Once the effect has completed, the 
     367    original ``element`` position will be restored. 
     368 
     369    element: 
     370        An element ID string or a DOM node (see 
     371        :mochiref:`MochiKit.DOM.getElement`). 
     372 
     373    options: 
     374        See :mochiref:`DefaultOptions`. Note that the options will 
     375        only affect the last :mochiref:`Move` effect. 
    352376 
    353377    *Availability*: 
    …… 
    395419:mochidef:`squish(element [, options])`: 
    396420 
    397     Reduce the horizontal and vertical sizes at the same time, using 
    398     the top left corner. 
    399  
    400     element: 
    401         An element ID string or a DOM node (see 
    402         :mochiref:`MochiKit.DOM.getElement`). 
     421    Reduce the horizontal and vertical sizes at the same time using 
     422    a single :mochiref:`Scale` effect. The result is similar to the 
     423    :mochiref:`shrink` effect with a ``top-left`` value for the 
     424    ``direction`` option. The ``element`` should have fixed width and 
     425    height. Once the effect has completed, the ``element`` will be 
     426    hidden with :mochiref:`MochiKit.Style.hideElement` and the 
     427    original element size will be restored. 
     428 
     429    element: 
     430        An element ID string or a DOM node (see 
     431        :mochiref:`MochiKit.DOM.getElement`). 
     432 
     433    options: 
     434        See :mochiref:`DefaultOptions`. 
    403435 
    404436    *Availability*: