Changeset 1327

Show
Ignore:
Timestamp:
03/13/08 22:58:23 (4 months ago)
Author:
cederberg@gmail.com
Message:

Moved "The Effects Queue" section in the MochiKit.Visual documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r1326 r1327  
    5454style sheets.  This implementation was adapted from <a class="reference" href="http://www.openrico.org">Rico</a>. Dynamic 
    5555effects are ported from <a class="reference" href="http://script.aculo.us">Scriptaculous</a>.</p> 
     56<div class="section"> 
     57<h2><a id="the-effects-queue" name="the-effects-queue">The Effects Queue</a></h2> 
     58<p>When you create effects based on user input (mouse clicks for example), it can 
     59create conflicts between the effects if multiple effects are running at the 
     60same time. To manage this problem, the Queue mechanism has been introduced: 
     61it's responsible for running the effects as you desired.</p> 
     62<p>By default, you have one Queue called 'global', and the effects run in 'parallel' 
     63(see default options). Every effects have a queue option to customize this. 
     64It can be a string, the scope is then global:</p> 
     65<ul class="simple"> 
     66<li><cite>start</cite>: the effect will be run before any other;</li> 
     67<li><cite>end</cite>: the effect will be run after any other;</li> 
     68<li><cite>break</cite>: every other effects break when the the effect start;</li> 
     69<li><cite>parallel</cite>: the effect run normally with others.</li> 
     70</ul> 
     71<p>But you have even more control if you use an array with the following keys:</p> 
     72<ul class="simple"> 
     73<li><cite>position</cite> takes a value listed above;</li> 
     74<li><cite>scope</cite> manages how the information has to be taken. If it's <cite>global</cite> 
     75then it's the same information for every effects. Otherwise you can define 
     76your own scode. For example, if you add an effect on a specified element, 
     77you may use the element id as scode;</li> 
     78<li><cite>limit</cite> defines how many effects can run in the current scode. If an 
     79effect is added whereas the limit is reached, it will never be run (it's 
     80lost).</li> 
     81</ul> 
     82</div> 
    5683</div> 
    5784<div class="section"> 
    …… 
    646673</blockquote> 
    647674</div> 
    648 <div class="section"> 
    649 <h2><a id="the-effects-queue" name="the-effects-queue">The Effects Queue</a></h2> 
    650 <p>When you create effects based on user input (mouse clicks for example), it can 
    651 create conflicts between the effects if multiple effects are running at the 
    652 same time. To manage this problem, the Queue mechanism has been introduced: 
    653 it's responsible for running the effects as you desired.</p> 
    654 <p>By default, you have one Queue called 'global', and the effects run in 'parallel' 
    655 (see default options). Every effects have a queue option to customize this. 
    656 It can be a string, the scope is then global:</p> 
    657 <ul class="simple"> 
    658 <li><cite>start</cite>: the effect will be run before any other;</li> 
    659 <li><cite>end</cite>: the effect will be run after any other;</li> 
    660 <li><cite>break</cite>: every other effects break when the the effect start;</li> 
    661 <li><cite>parallel</cite>: the effect run normally with others.</li> 
    662 </ul> 
    663 <p>But you have even more control if you use an array with the following keys:</p> 
    664 <ul class="simple"> 
    665 <li><cite>position</cite> takes a value listed above;</li> 
    666 <li><cite>scope</cite> manages how the information has to be taken. If it's <cite>global</cite> 
    667 then it's the same information for every effects. Otherwise you can define 
    668 your own scode. For example, if you add an effect on a specified element, 
    669 you may use the element id as scode;</li> 
    670 <li><cite>limit</cite> defines how many effects can run in the current scode. If an 
    671 effect is added whereas the limit is reached, it will never be run (it's 
    672 lost).</li> 
    673 </ul> 
    674 </div> 
    675675</div> 
    676676<div class="section"> 

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

    r1326 r1327  
    4949 
    5050.. _Scriptaculous: http://script.aculo.us 
     51 
     52 
     53The Effects Queue 
     54----------------- 
     55 
     56When you create effects based on user input (mouse clicks for example), it can 
     57create conflicts between the effects if multiple effects are running at the 
     58same time. To manage this problem, the Queue mechanism has been introduced: 
     59it's responsible for running the effects as you desired. 
     60 
     61By default, you have one Queue called 'global', and the effects run in 'parallel' 
     62(see default options). Every effects have a queue option to customize this. 
     63It can be a string, the scope is then global: 
     64     
     65- `start`: the effect will be run before any other; 
     66- `end`: the effect will be run after any other; 
     67- `break`: every other effects break when the the effect start; 
     68- `parallel`: the effect run normally with others. 
     69 
     70 
     71But you have even more control if you use an array with the following keys: 
     72 
     73- `position` takes a value listed above; 
     74- `scope` manages how the information has to be taken. If it's `global`  
     75  then it's the same information for every effects. Otherwise you can define 
     76  your own scode. For example, if you add an effect on a specified element, 
     77  you may use the element id as scode; 
     78- `limit` defines how many effects can run in the current scode. If an 
     79  effect is added whereas the limit is reached, it will never be run (it's 
     80  lost). 
    5181 
    5282 
    …… 
    489519 
    490520 
    491 The Effects Queue 
    492 ----------------- 
    493  
    494 When you create effects based on user input (mouse clicks for example), it can 
    495 create conflicts between the effects if multiple effects are running at the 
    496 same time. To manage this problem, the Queue mechanism has been introduced: 
    497 it's responsible for running the effects as you desired. 
    498  
    499 By default, you have one Queue called 'global', and the effects run in 'parallel' 
    500 (see default options). Every effects have a queue option to customize this. 
    501 It can be a string, the scope is then global: 
    502      
    503 - `start`: the effect will be run before any other; 
    504 - `end`: the effect will be run after any other; 
    505 - `break`: every other effects break when the the effect start; 
    506 - `parallel`: the effect run normally with others. 
    507  
    508  
    509 But you have even more control if you use an array with the following keys: 
    510  
    511 - `position` takes a value listed above; 
    512 - `scope` manages how the information has to be taken. If it's `global`  
    513   then it's the same information for every effects. Otherwise you can define 
    514   your own scode. For example, if you add an effect on a specified element, 
    515   you may use the element id as scode; 
    516 - `limit` defines how many effects can run in the current scode. If an 
    517   effect is added whereas the limit is reached, it will never be run (it's 
    518   lost). 
    519  
    520  
    521521See Also 
    522522========