oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui-ext/docs/YAHOO.ext.Animator.html
JT Smith 4f68a0933c added YUI and YUI-ext 
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

803 lines
24 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
YAHOO.ext.Animator
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="YAHOO.ext.Animator";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();" style="margin:15px;">
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class YAHOO.ext.Animator</H2>
<PRE>Object
|
+--<a href='YAHOO.ext.Element.html'>YAHOO.ext.Element</a>
|
+--<b>YAHOO.ext.Animator</b>
</PRE>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>YAHOO.ext.Animator</B>
<DT>extends <a href='YAHOO.ext.Element.html'>YAHOO.ext.Element</a>
</DL>
<P>
<BR/>Provides support for syncing animations for multiple <a href="YAHOO.ext.Actor.html#">YAHOO.ext.Actor</a>s.<br><br>
<br><br>This example can be seen in action <a href="http://jackslocum.blogspot.com/2006/08/splitbar-component-for-yahoo-ui.html" target="_new">here</a> by clicking on "Click here and I will point it out".<br>
<pre><code>
var animator = new YAHOO.ext.Animator();
var cursor = new YAHOO.ext.Actor('cursor-img', animator);
var click = new YAHOO.ext.Actor('click-img', animator);
var resize = new YAHOO.ext.Actor('resize-img', animator);
// start capturing
animator.startCapture();
// these animations will be run in sequence
cursor.show();
cursor.moveTo(500,400);
cursor.moveTo(20, getEl('navbar').getY()+10, true, .75);
click.show();
click.alignTo(cursor, 'tl', [-4, -4]);
// Add an async function call, pass callback to argument 1
animator.addAsyncCall(Blog.navbar.undockDelegate, 1);
// pause .5 seconds
animator.pause(.5);
// again, these animations will be run in sequence
click.hide(true, .7);
cursor.alignTo('splitter', 'tr', [0, +100], true, 1);
resize.alignTo('splitter', 'tr', [-12, +100]);
// start sync block: these animations will run at the same time
animator.beginSync();
cursor.hide();
resize.show();
animator.endSync();
// play the captured animation sequences, call myCallback when done
animator.play(myCallback);
</code></pre>
<BR/><I>Defined in <a href='overview-summary-Animator.js.html'>Animator.js</a></I><BR/><BR/><B>Requires:</B><UL>- <a href="YAHOO.ext.Element.html#">YAHOO.ext.Element</a><BR/>- YAHOO.util.Dom<BR/>- YAHOO.util.Event<BR/>- <a href="YAHOO.util.CustomEvent.html#">YAHOO.util.CustomEvent</a><BR/>- YAHOO.util.Anim<BR/>- YAHOO.util.ColorAnim<BR/>- YAHOO.util.Motion</UL>
</P>
<HR>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="inner_classes"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">Nested Class Summary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&nbsp;class&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="YAHOO.ext.Animator.AnimSequence.html">YAHOO.ext.Animator.AnimSequence</A></B></CODE></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&nbsp;class&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="YAHOO.ext.Animator.CompositeSequence.html">YAHOO.ext.Animator.CompositeSequence</A></B></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
&nbsp;<A NAME=""><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD class="title-cell"><B>Fields inherited from class <A HREF="YAHOO.ext.Element.html">YAHOO.ext.Element</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>
<a href="YAHOO.ext.Element.html#id">id</a>, <a href="YAHOO.ext.Element.html#defaultUnit">defaultUnit</a>, <a href="YAHOO.ext.Element.html#onVisibilityChanged">onVisibilityChanged</a>, <a href="YAHOO.ext.Element.html#onMoved">onMoved</a>, <a href="YAHOO.ext.Element.html#onResized">onResized</a>, <a href="YAHOO.ext.Element.html#autoBoxAdjust">autoBoxAdjust</a>
</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
Constructor Summary
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD>
<CODE>
<B>
<A HREF="YAHOO.ext.Animator.html#YAHOO.ext.Animator()">YAHOO.ext.Animator</A>
</B>
()
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
</TABLE>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
<span style="float:left">Method Summary</span>
<span style="float:right;font-weight:normal;font-size:8pt;">
<i>* Parameter types in italic indicate optional parameters</i>
</span>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addActor">addActor</A></B>(&lt;<a href="YAHOO.ext.Actor.html">YAHOO.ext.Actor</a>&gt; actor)
</CODE>
<BR>
&nbsp;&nbsp;
Add an actor.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addAsyncCall">addAsyncCall</A></B>(&lt;<a href="Function.html">Function</a>&gt; fcn, &lt;Number&gt; callbackIndex, &lt;<i>Array</i>&gt; args, &lt;<i>Object</i>&gt; scope)
</CODE>
<BR>
&nbsp;&nbsp;
Add an async function call to the playlist.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addCall">addCall</A></B>(&lt;<a href="Function.html">Function</a>&gt; fcn, &lt;<i>Array</i>&gt; args, &lt;<i>Object</i>&gt; scope)
</CODE>
<BR>
&nbsp;&nbsp;
Add a function call to the playlist.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#beginSync">beginSync</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Start a multi-actor sync block.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#clear">clear</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Clear the playlist
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#endSync">endSync</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
End the multi-actor sync block
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#isCapturing">isCapturing</A></B>(&lt;<a href="YAHOO.ext.Actor.html">YAHOO.ext.Actor</a>&gt; actor)
</CODE>
<BR>
&nbsp;&nbsp;
Checks whether this animator is listening to a specific actor.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#isPlaying">isPlaying</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Check if this animator is currently playing
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#pause">pause</A></B>(&lt;Number&gt; seconds)
</CODE>
<BR>
&nbsp;&nbsp;
Add a pause to the playlist (in seconds)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#play">play</A></B>(&lt;<i>Function</i>&gt; oncomplete)
</CODE>
<BR>
&nbsp;&nbsp;
Starts playback of the playlist, also stops any capturing.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#startCapture">startCapture</A></B>(&lt;<i>Boolean</i>&gt; clearPlaylist)
</CODE>
<BR>
&nbsp;&nbsp;
Start capturing actions on the added actors.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#stop">stop</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Stop at the next available stopping point
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#stopCapture">stopCapture</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Stop capturing on all added actors.
</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD class="title-cell"><B>Methods inherited from class <a href="YAHOO.ext.Element.html">YAHOO.ext.Element</a></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>
<!-- Inherited methods -->
<a href="YAHOO.ext.Element.html#setVisibilityMode">setVisibilityMode</a>, <a href="YAHOO.ext.Element.html#enableDisplayMode">enableDisplayMode</a>, <a href="YAHOO.ext.Element.html#animate">animate</a>, <a href="YAHOO.ext.Element.html#isVisible">isVisible</a>, <a href="YAHOO.ext.Element.html#setVisible">setVisible</a>, <a href="YAHOO.ext.Element.html#toggle">toggle</a>, <a href="YAHOO.ext.Element.html#focus">focus</a>, <a href="YAHOO.ext.Element.html#addClass">addClass</a>, <a href="YAHOO.ext.Element.html#radioClass">radioClass</a>, <a href="YAHOO.ext.Element.html#removeClass">removeClass</a>, <a href="YAHOO.ext.Element.html#toggleClass">toggleClass</a>, <a href="YAHOO.ext.Element.html#hasClass">hasClass</a>, <a href="YAHOO.ext.Element.html#replaceClass">replaceClass</a>, <a href="YAHOO.ext.Element.html#getStyle">getStyle</a>, <a href="YAHOO.ext.Element.html#setStyle">setStyle</a>, <a href="YAHOO.ext.Element.html#getX">getX</a>, <a href="YAHOO.ext.Element.html#getY">getY</a>, <a href="YAHOO.ext.Element.html#getXY">getXY</a>, <a href="YAHOO.ext.Element.html#setX">setX</a>, <a href="YAHOO.ext.Element.html#setY">setY</a>, <a href="YAHOO.ext.Element.html#setLeft">setLeft</a>, <a href="YAHOO.ext.Element.html#setTop">setTop</a>, <a href="YAHOO.ext.Element.html#setRight">setRight</a>, <a href="YAHOO.ext.Element.html#setBottom">setBottom</a>, <a href="YAHOO.ext.Element.html#setXY">setXY</a>, <a href="YAHOO.ext.Element.html#setLocation">setLocation</a>, <a href="YAHOO.ext.Element.html#moveTo">moveTo</a>, <a href="YAHOO.ext.Element.html#getRegion">getRegion</a>, <a href="YAHOO.ext.Element.html#getHeight">getHeight</a>, <a href="YAHOO.ext.Element.html#getWidth">getWidth</a>, <a href="YAHOO.ext.Element.html#getSize">getSize</a>, <a href="YAHOO.ext.Element.html#setWidth">setWidth</a>, <a href="YAHOO.ext.Element.html#setHeight">setHeight</a>, <a href="YAHOO.ext.Element.html#setSize">setSize</a>, <a href="YAHOO.ext.Element.html#setBounds">setBounds</a>, <a href="YAHOO.ext.Element.html#setRegion">setRegion</a>, <a href="YAHOO.ext.Element.html#addListener">addListener</a>, <a href="YAHOO.ext.Element.html#addHandler">addHandler</a>, <a href="YAHOO.ext.Element.html#on">on</a>, <a href="YAHOO.ext.Element.html#addManagedListener">addManagedListener</a>, <a href="YAHOO.ext.Element.html#mon">mon</a>, <a href="YAHOO.ext.Element.html#removeListener">removeListener</a>, <a href="YAHOO.ext.Element.html#removeAllListeners">removeAllListeners</a>, <a href="YAHOO.ext.Element.html#setOpacity">setOpacity</a>, <a href="YAHOO.ext.Element.html#getLeft">getLeft</a>, <a href="YAHOO.ext.Element.html#getRight">getRight</a>, <a href="YAHOO.ext.Element.html#getTop">getTop</a>, <a href="YAHOO.ext.Element.html#getBottom">getBottom</a>, <a href="YAHOO.ext.Element.html#setAbsolutePositioned">setAbsolutePositioned</a>, <a href="YAHOO.ext.Element.html#setRelativePositioned">setRelativePositioned</a>, <a href="YAHOO.ext.Element.html#clearPositioning">clearPositioning</a>, <a href="YAHOO.ext.Element.html#getPositioning">getPositioning</a>, <a href="YAHOO.ext.Element.html#getBorderWidth">getBorderWidth</a>, <a href="YAHOO.ext.Element.html#getPadding">getPadding</a>, <a href="YAHOO.ext.Element.html#setPositioning">setPositioning</a>, <a href="YAHOO.ext.Element.html#move">move</a>, <a href="YAHOO.ext.Element.html#clip">clip</a>, <a href="YAHOO.ext.Element.html#unclip">unclip</a>, <a href="YAHOO.ext.Element.html#alignTo">alignTo</a>, <a href="YAHOO.ext.Element.html#clearOpacity">clearOpacity</a>, <a href="YAHOO.ext.Element.html#hide">hide</a>, <a href="YAHOO.ext.Element.html#show">show</a>, <a href="YAHOO.ext.Element.html#beginMeasure">beginMeasure</a>, <a href="YAHOO.ext.Element.html#endMeasure">endMeasure</a>, <a href="YAHOO.ext.Element.html#update">update</a>, <a href="YAHOO.ext.Element.html#getUpdateManager">getUpdateManager</a>, <a href="YAHOO.ext.Element.html#getCenterXY">getCenterXY</a>, <a href="YAHOO.ext.Element.html#getChildrenByTagName">getChildrenByTagName</a>, <a href="YAHOO.ext.Element.html#getChildrenByClassName">getChildrenByClassName</a>, <a href="YAHOO.ext.Element.html#isBorderBox">isBorderBox</a>, <a href="YAHOO.ext.Element.html#getBox">getBox</a>, <a href="YAHOO.ext.Element.html#setBox">setBox</a>
</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Constructor Detail
</TD>
</TR>
</TABLE>
<A NAME="YAHOO.ext.Animator()"><!-- --></A><H3>
YAHOO.ext.Animator</H3>
<PRE><B>YAHOO.ext.Animator</B>()</PRE>
<UL>
<B>Parameters:</B>
<UL><CODE>el</CODE> - The dom element or element id
</UL>
<UL><CODE>animator</CODE> - (optional) The Animator that will capture this Actor's actions
</UL>
<UL><CODE>selfCapture</CODE> - (optional) Whether this actor should capture it's own actions to support self playback without an animator (defaults to false)
</UL>
</UL>
<!-- Constructor return value(s) -->
<!-- End constructor return value(s) -->
<!-- ADDITIONAL ATTRIBUTES -->
<UL>
<B>Requires:</B><UL>- <a href="YAHOO.ext.Element.html#">YAHOO.ext.Element</a><BR/>- YAHOO.util.Dom<BR/>- YAHOO.util.Event<BR/>- <a href="YAHOO.util.CustomEvent.html#">YAHOO.util.CustomEvent</a><BR/>- YAHOO.util.Anim<BR/>- YAHOO.util.ColorAnim<BR/>- YAHOO.util.Motion</UL>
</UL>
<HR/>
<!-- END ADDITIONAL ATTRIBUTES -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Method Detail
</TD>
</TR>
</TABLE>
<!-- One single method detail entry -->
<A NAME="addActor"><!-- --></A>
<H3>addActor</H3>
<PRE>void <B>addActor</B>(&lt;<a href="YAHOO.ext.Actor.html">YAHOO.ext.Actor</a>&gt; actor)</PRE>
<UL>Add an actor. The actor is also set to capturing = true.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>actor</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="addAsyncCall"><!-- --></A>
<H3>addAsyncCall</H3>
<PRE>void <B>addAsyncCall</B>(&lt;<a href="Function.html">Function</a>&gt; fcn, &lt;Number&gt; callbackIndex, &lt;<i>Array</i>&gt; args, &lt;<i>Object</i>&gt; scope)</PRE>
<UL>Add an async function call to the playlist.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>fcn</CODE> - The function to call
</UL>
<UL><CODE>callbackIndex</CODE> - The index of the callback parameter on the passed function. A CALLBACK IS REQUIRED.
</UL>
<UL><CODE>args</CODE> - The arguments to call the function with
</UL>
<UL><CODE>scope</CODE> - (optional) The scope of the function
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="addCall"><!-- --></A>
<H3>addCall</H3>
<PRE>void <B>addCall</B>(&lt;<a href="Function.html">Function</a>&gt; fcn, &lt;<i>Array</i>&gt; args, &lt;<i>Object</i>&gt; scope)</PRE>
<UL>Add a function call to the playlist.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>fcn</CODE> - The function to call
</UL>
<UL><CODE>args</CODE> - The arguments to call the function with
</UL>
<UL><CODE>scope</CODE> - (optional) The scope of the function
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="beginSync"><!-- --></A>
<H3>beginSync</H3>
<PRE>void <B>beginSync</B>()</PRE>
<UL>Start a multi-actor sync block. By default all animations are run in sequence. While in the sync block
each actor's own animations will still be sequenced, but all actors will animate at the same time.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="clear"><!-- --></A>
<H3>clear</H3>
<PRE>void <B>clear</B>()</PRE>
<UL>Clear the playlist</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="endSync"><!-- --></A>
<H3>endSync</H3>
<PRE>void <B>endSync</B>()</PRE>
<UL>End the multi-actor sync block</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isCapturing"><!-- --></A>
<H3>isCapturing</H3>
<PRE>Object <B>isCapturing</B>(&lt;<a href="YAHOO.ext.Actor.html">YAHOO.ext.Actor</a>&gt; actor)</PRE>
<UL>Checks whether this animator is listening to a specific actor.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>actor</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isPlaying"><!-- --></A>
<H3>isPlaying</H3>
<PRE>Object <B>isPlaying</B>()</PRE>
<UL>Check if this animator is currently playing</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="pause"><!-- --></A>
<H3>pause</H3>
<PRE>void <B>pause</B>(&lt;Number&gt; seconds)</PRE>
<UL>Add a pause to the playlist (in seconds)</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>seconds</CODE> - The number of seconds to pause.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="play"><!-- --></A>
<H3>play</H3>
<PRE>void <B>play</B>(&lt;<i>Function</i>&gt; oncomplete)</PRE>
<UL>Starts playback of the playlist, also stops any capturing. To start capturing again call <a href="#startCapture">startCapture()</a>.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>oncomplete</CODE> - (optional) Callback to execute when playback has completed
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="startCapture"><!-- --></A>
<H3>startCapture</H3>
<PRE>void <B>startCapture</B>(&lt;<i>Boolean</i>&gt; clearPlaylist)</PRE>
<UL>Start capturing actions on the added actors.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>clearPlaylist</CODE> - Whether to also create a new playlist
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="stop"><!-- --></A>
<H3>stop</H3>
<PRE>void <B>stop</B>()</PRE>
<UL>Stop at the next available stopping point</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="stopCapture"><!-- --></A>
<H3>stopCapture</H3>
<PRE>void <B>stopCapture</B>()</PRE>
<UL>Stop capturing on all added actors.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<!-- ============ METHOD DETAIL END ========== -->
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<FONT SIZE="-1">
</FONT>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sat Oct 14 06:07:10 2006</div>
</BODY>
</HTML>
Reference in a new issue View git blame Copy permalink