275 lines
14 KiB
HTML
275 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<html>
|
||
<head>
|
||
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
|
||
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
|
||
<meta content="AnimationEvent,com.yahoo.astra.animation.AnimationEvent,COMPLETE,PAUSE,START,UPDATE,parameters" name="keywords">
|
||
<title>com.yahoo.astra.animation.AnimationEvent</title>
|
||
</head>
|
||
<body>
|
||
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
|
||
<!--
|
||
asdocTitle = 'AnimationEvent - YUI AS Component Documentation';
|
||
var baseRef = '../../../../';
|
||
window.onload = configPage;
|
||
--></script>
|
||
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
|
||
<tr>
|
||
<td align="left" class="titleTableTitle">YUI AS Component Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All Packages</a> | <a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a> | <a href="../../../../index.html?com/yahoo/astra/animation/AnimationEvent.html&com/yahoo/astra/animation/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
|
||
</tr>
|
||
<tr class="titleTableRow2">
|
||
<td align="left" id="subTitle" class="titleTableSubTitle">Class AnimationEvent</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#constantSummary">Constants</a></td>
|
||
</tr>
|
||
<tr class="titleTableRow3">
|
||
<td colspan="2"> </td>
|
||
</tr>
|
||
</table>
|
||
<script type="text/javascript" language="javascript">
|
||
<!--
|
||
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class AnimationEvent"); titleBar_setSubNav(true,true,false,false,false,false,true,false,false,false,false,false,false,false);}
|
||
--></script>
|
||
<div class="MainContent">
|
||
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
|
||
<tr>
|
||
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.yahoo.astra.animation</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class AnimationEvent</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">AnimationEvent <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> flash.events.Event</td>
|
||
</tr>
|
||
</table>
|
||
<p></p>
|
||
The AnimationEvent class represents events that are broadcast by the com.yahoo.astra.animation.Animation class.
|
||
<p></p>
|
||
<p>
|
||
<span class="classHeaderTableLabel">See also</span>
|
||
</p>
|
||
<div class="seeAlso">
|
||
<a href="../animation/Animation.html" target="">com.yahoo.astra.animation.Animation</a>
|
||
</div>
|
||
<br>
|
||
<hr>
|
||
</div>
|
||
<a name="propertySummary"></a>
|
||
<div class="summarySection">
|
||
<div class="summaryTableTitle">Public Properties</div>
|
||
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
|
||
<tr>
|
||
<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#parameters">parameters</a> : Object<div class="summaryTableDescription">
|
||
The values of the properties controlled by the animation, when the event occurred.</div>
|
||
</td><td class="summaryTableOwnerCol">AnimationEvent</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<a name="methodSummary"></a>
|
||
<div class="summarySection">
|
||
<div class="summaryTableTitle">Public Methods</div>
|
||
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
||
<tr>
|
||
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
||
<div class="summarySignature">
|
||
<a class="signatureLink" href="#AnimationEvent()">AnimationEvent</a>(type:String, parameters:Object)</div>
|
||
<div class="summaryTableDescription">
|
||
Constructor.</div>
|
||
</td><td class="summaryTableOwnerCol">AnimationEvent</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<a name="constantSummary"></a>
|
||
<div class="summarySection">
|
||
<div class="summaryTableTitle">Public Constants</div>
|
||
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
|
||
<tr>
|
||
<th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined by</th>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#COMPLETE">COMPLETE</a> : String = "animationComplete"<div class="summaryTableDescription">[static]
|
||
Indicates that the animation has reached the end and finished.</div>
|
||
</td><td class="summaryTableOwnerCol">AnimationEvent</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#PAUSE">PAUSE</a> : String = "animationPause"<div class="summaryTableDescription">[static]
|
||
Indicates that the animation has been paused.</div>
|
||
</td><td class="summaryTableOwnerCol">AnimationEvent</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#START">START</a> : String = "animationStart"<div class="summaryTableDescription">[static]
|
||
Indicates that the animation has started playing.</div>
|
||
</td><td class="summaryTableOwnerCol">AnimationEvent</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#UPDATE">UPDATE</a> : String = "animationUpdate"<div class="summaryTableDescription">[static]
|
||
Indicates that the animation has changed and the screen has been updated.</div>
|
||
</td><td class="summaryTableOwnerCol">AnimationEvent</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<script type="text/javascript" language="javascript">
|
||
<!--
|
||
showHideInherited();
|
||
--></script>
|
||
<div class="MainContent">
|
||
<a name="propertyDetail"></a>
|
||
<div class="detailSectionHeader">Property detail</div>
|
||
<a name="parameters"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">parameters</td><td class="detailHeaderType">property</td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>public var parameters:Object</code><p>
|
||
The values of the properties controlled by the animation, when the event occurred.
|
||
</p></div>
|
||
<a name="constructorDetail"></a>
|
||
<div class="detailSectionHeader">Constructor detail</div>
|
||
<a name="AnimationEvent()"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">AnimationEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>public function AnimationEvent(type:String, parameters:Object)</code><p>
|
||
Constructor.
|
||
</p><span class="label">Parameters</span>
|
||
<table border="0" cellspacing="0" cellpadding="0">
|
||
<tr>
|
||
<td width="20px"></td><td><code><span class="label">type</span>:String</code> — The event type; indicates the action that caused the event.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramSpacer"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td width="20px"></td><td><code><span class="label">parameters</span>:Object</code> — The current values of the properties controlled by the animation.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<a name="constantDetail"></a>
|
||
<div class="detailSectionHeader">Constant detail</div>
|
||
<a name="COMPLETE"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">COMPLETE</td><td class="detailHeaderType">constant</td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>public static const COMPLETE:String = "animationComplete"</code><p>
|
||
Indicates that the animation has reached the end and finished.
|
||
</p><p>The properties of the event object have the following values:</p>
|
||
<table class="innertable">
|
||
<tr><th>Property</th><th>Value</th></tr>
|
||
<tr><td><code>bubbles</code></td><td>false</td></tr>
|
||
<tr><td><code>cancelable</code></td><td>false</td></tr>
|
||
<tr><td><code>currentTarget</code></td><td>The object that defines the
|
||
event listener that handles the event. For example, if you use
|
||
<code>myButton.addEventListener()</code> to register an event listener,
|
||
<code>myButton</code> is the value of the <code>currentTarget</code> property.</td></tr>
|
||
<tr><td><code>target</code></td><td>The object that dispatched the event;
|
||
it is not always the object listening for the event.
|
||
Use the <code>currentTarget</code> property to always access the
|
||
object listening for the event.</td></tr>
|
||
<tr><td><code>parameters</code></td><td>The values of the properties controlled by the animation,
|
||
when the event occurred.</td></tr>
|
||
</table>
|
||
</div>
|
||
<a name="PAUSE"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">PAUSE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>public static const PAUSE:String = "animationPause"</code><p>
|
||
Indicates that the animation has been paused.
|
||
</p><p>The properties of the event object have the following values:</p>
|
||
<table class="innertable">
|
||
<tr><th>Property</th><th>Value</th></tr>
|
||
<tr><td><code>bubbles</code></td><td>false</td></tr>
|
||
<tr><td><code>cancelable</code></td><td>false</td></tr>
|
||
<tr><td><code>currentTarget</code></td><td>The object that defines the
|
||
event listener that handles the event. For example, if you use
|
||
<code>myButton.addEventListener()</code> to register an event listener,
|
||
<code>myButton</code> is the value of the <code>currentTarget</code> property.</td></tr>
|
||
<tr><td><code>target</code></td><td>The object that dispatched the event;
|
||
it is not always the object listening for the event.
|
||
Use the <code>currentTarget</code> property to always access the
|
||
object listening for the event.</td></tr>
|
||
<tr><td><code>parameters</code></td><td>The values of the properties controlled by the animation,
|
||
when the event occurred.</td></tr>
|
||
</table>
|
||
</div>
|
||
<a name="START"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">START</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>public static const START:String = "animationStart"</code><p>
|
||
Indicates that the animation has started playing.
|
||
</p><p>The properties of the event object have the following values:</p>
|
||
<table class="innertable">
|
||
<tr><th>Property</th><th>Value</th></tr>
|
||
<tr><td><code>bubbles</code></td><td>false</td></tr>
|
||
<tr><td><code>cancelable</code></td><td>false</td></tr>
|
||
<tr><td><code>currentTarget</code></td><td>The object that defines the
|
||
event listener that handles the event. For example, if you use
|
||
<code>myButton.addEventListener()</code> to register an event listener,
|
||
<code>myButton</code> is the value of the <code>currentTarget</code> property.</td></tr>
|
||
<tr><td><code>target</code></td><td>The object that dispatched the event;
|
||
it is not always the object listening for the event.
|
||
Use the <code>currentTarget</code> property to always access the
|
||
object listening for the event.</td></tr>
|
||
<tr><td><code>parameters</code></td><td>The values of the properties controlled by the animation,
|
||
when the event occurred.</td></tr>
|
||
</table>
|
||
</div>
|
||
<a name="UPDATE"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">UPDATE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>public static const UPDATE:String = "animationUpdate"</code><p>
|
||
Indicates that the animation has changed and the screen has been updated.
|
||
</p><p>The properties of the event object have the following values:</p>
|
||
<table class="innertable">
|
||
<tr><th>Property</th><th>Value</th></tr>
|
||
<tr><td><code>bubbles</code></td><td>false</td></tr>
|
||
<tr><td><code>cancelable</code></td><td>false</td></tr>
|
||
<tr><td><code>currentTarget</code></td><td>The object that defines the
|
||
event listener that handles the event. For example, if you use
|
||
<code>myButton.addEventListener()</code> to register an event listener,
|
||
<code>myButton</code> is the value of the <code>currentTarget</code> property.</td></tr>
|
||
<tr><td><code>target</code></td><td>The object that dispatched the event;
|
||
it is not always the object listening for the event.
|
||
Use the <code>currentTarget</code> property to always access the
|
||
object listening for the event.</td></tr>
|
||
<tr><td><code>parameters</code></td><td>The values of the properties controlled by the animation,
|
||
when the event occurred.</td></tr>
|
||
</table>
|
||
</div>
|
||
<br>
|
||
<br>
|
||
<hr>
|
||
<br>
|
||
<p></p>
|
||
<center class="copyright">
|
||
</center>
|
||
</div>
|
||
</body>
|
||
</html>
|
||
<!-- -->
|