periodicaction.html

这个是java的quicktime for java 的详细使用文档

<A NAME="actor"><!-- --></A><H3>
actor</H3>
<PRE>
protected <A HREF="../../../quicktime/app/actions/Actionable.html">Actionable</A> <B>actor</B></PRE>
<DL>
<DD>The actionable actor object that can be invoked by an action if a constraining
 condition is reached</DL>
<HR>

<A NAME="reschedule"><!-- --></A><H3>
reschedule</H3>
<PRE>
protected boolean <B>reschedule</B></PRE>
<DL>
<DD>If true then the tickle method returns true and the action is considered to 
 be still active by its owner and will be invoked on consequent tickles.</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="PeriodicAction(int, int)"><!-- --></A><H3>
PeriodicAction</H3>
<PRE>
protected <B>PeriodicAction</B>(int&nbsp;scale,
                         int&nbsp;period)</PRE>
<DL>
<DD>Create a PeriodicAction. Subclasses are responsible for defining the action
 that occurs whenever the action is invoked.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scale</CODE> - the amount with which a second is divided into at a rate of one<DD><CODE>period</CODE> - the number of scale ticks that elapse between invocations of the action.</DL>
</DD>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="timeChanged(int)"><!-- --></A><H3>
timeChanged</H3>
<PRE>
public void <B>timeChanged</B>(int&nbsp;newTime)
                 throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method should be called by the actions owner whenver a time condition
 of the owner's time line has changed, as this can effect the trigger
 conditions of the action.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/time/Ticklish.html#timeChanged(int)">timeChanged</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/time/Ticklish.html">Ticklish</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>the</CODE> - new time expressed in Ticklish.kScale ticks<DT><B>See Also: </B><DD><A HREF="../../../quicktime/app/time/Ticklish.html"><CODE>Ticklish</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="tickle(float, int)"><!-- --></A><H3>
tickle</H3>
<PRE>
public boolean <B>tickle</B>(float&nbsp;effectiveRate,
                      int&nbsp;currentTime)
               throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method can be called as often as you like, though effective rate
 cannot be zero.
 The provided time and rate values are used to calculate whether an action
 should be executed. If an action should be executed this method calls
 the doAction method which should perform the action.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/time/Ticklish.html#tickle(float, int)">tickle</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/time/Ticklish.html">Ticklish</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>er</CODE> - the actual rate at which the action has been triggered<DD><CODE>t</CODE> - the time in Ticklish.kScale that the action has been triggered<DT><B>Returns:</B><DD>true if the action is still interested in being tickled.</DL>
</DD>
</DL>
<HR>

<A NAME="doAction(float, int)"><!-- --></A><H3>
doAction</H3>
<PRE>
protected abstract void <B>doAction</B>(float&nbsp;er,
                                 int&nbsp;t)
                          throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method is called by the tickle method when an action becomes active.
 Subclasses should do their desired actions
 when this method is called.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>er</CODE> - the actual rate at which the action has been triggered<DD><CODE>t</CODE> - the time in Ticklish.kScale that the action has been triggered</DL>
</DD>
</DL>
<HR>

<A NAME="constraintReached()"><!-- --></A><H3>
constraintReached</H3>
<PRE>
protected abstract boolean <B>constraintReached</B>()</PRE>
<DL>
<DD>If after the doAction method has exeucted this method returns true then
 if the Action has an Actionable object this actionable is triggered. If
 constraintReached returns false no further action is taken.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the actionable object (if set) should be triggered</DL>
</DD>
</DL>
<HR>

<A NAME="setActionable(quicktime.app.actions.Actionable)"><!-- --></A><H3>
setActionable</H3>
<PRE>
public void <B>setActionable</B>(<A HREF="../../../quicktime/app/actions/Actionable.html">Actionable</A>&nbsp;actor)</PRE>
<DL>
<DD>This method sets the actionable object of the action.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getActionable()"><!-- --></A><H3>
getActionable</H3>
<PRE>
public <A HREF="../../../quicktime/app/actions/Actionable.html">Actionable</A> <B>getActionable</B>()</PRE>
<DL>
<DD>This method retreives the current actor that is attached to the action<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setPeriod(int)"><!-- --></A><H3>
setPeriod</H3>
<PRE>
public void <B>setPeriod</B>(int&nbsp;period)</PRE>
<DL>
<DD>Sets the current period of the action - how many scale ticks will elapse
 before the action is executed. If the period is zero the doAction method
 is called whenever the PeriodicAction is tickled.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>period</CODE> - the new period</DL>
</DD>
</DL>
<HR>

<A NAME="getPeriod()"><!-- --></A><H3>
getPeriod</H3>
<PRE>
public int <B>getPeriod</B>()</PRE>
<DL>
<DD>Returns the current period of the action<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the period</DL>
</DD>
</DL>
<HR>

<A NAME="setScale(int)"><!-- --></A><H3>
setScale</H3>
<PRE>
public void <B>setScale</B>(int&nbsp;s)</PRE>
<DL>
<DD>Sets the scale of the action - this is the resolution of a second at rate == 1,
 thus a scale of 10 is 100msecs at rate == 1, 50msecs at rate == 2 etc. This value
 must be greater than zero.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - the new scale or resolution of the action</DL>
</DD>
</DL>
<HR>

<A NAME="getScale()"><!-- --></A><H3>
getScale</H3>
<PRE>
public int <B>getScale</B>()</PRE>
<DL>
<DD>Return the current scale of the action.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the current scale</DL>
</DD>
</DL>
<HR>

<A NAME="getTriggerCondition()"><!-- --></A><H3>
getTriggerCondition</H3>
<PRE>
public int <B>getTriggerCondition</B>()</PRE>
<DL>
<DD>Returns the trigger condition of the action - an action can trigger
 either when rate is positive, rate is negative or either.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the current trigger condition<DT><B>See Also: </B><DD><CODE>quicktime.std.StdConstants.triggerTimeFwd</CODE>, 
<CODE>quicktime.std.StdConstants.triggerTimeBwd</CODE>, 
<CODE>quicktime.std.StdConstants.triggerTimeEither</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setTriggerCondition(int)"><!-- --></A><H3>
setTriggerCondition</H3>
<PRE>
public void <B>setTriggerCondition</B>(int&nbsp;cond)</PRE>
<DL>
<DD>Sets the trigger condition of the action - an action can trigger
 either when rate is positive, rate is negative or either.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cond</CODE> - the current trigger condition<DT><B>See Also: </B><DD><CODE>quicktime.std.StdConstants.triggerTimeFwd</CODE>, 
<CODE>quicktime.std.StdConstants.triggerTimeBwd</CODE>, 
<CODE>quicktime.std.StdConstants.triggerTimeEither</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Return a String representation of this object.<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a String</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>
<DL>
<DD>Returns true if the objects are equal or false otherwise.<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to test<DT><B>Returns:</B><DD>a boolean</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PeriodicAction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../quicktime/app/actions/NextImageAction.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../quicktime/app/actions/QTMouseMotionAdapter.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PeriodicAction.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>