Subversion Repositories AndroidProjects

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
356 chris 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<!-- Generated by javadoc (build 1.6.0_26) on Sun Jan 27 20:37:08 CET 2013 -->
6
<TITLE>
7
Timer.Task (libgdx API)
8
</TITLE>
9
 
10
<META NAME="date" CONTENT="2013-01-27">
11
 
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
 
14
<SCRIPT type="text/javascript">
15
function windowTitle()
16
{
17
    if (location.href.indexOf('is-external=true') == -1) {
18
        parent.document.title="Timer.Task (libgdx API)";
19
    }
20
}
21
</SCRIPT>
22
<NOSCRIPT>
23
</NOSCRIPT>
24
 
25
</HEAD>
26
 
27
<BODY BGCOLOR="white" onload="windowTitle();">
28
<HR>
29
 
30
 
31
<!-- ========= START OF TOP NAVBAR ======= -->
32
<A NAME="navbar_top"><!-- --></A>
33
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35
<TR>
36
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37
<A NAME="navbar_top_firstrow"><!-- --></A>
38
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39
  <TR ALIGN="center" VALIGN="top">
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Timer.Task.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48
  </TR>
49
</TABLE>
50
</TD>
51
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52
 
53
                                libgdx API
54
                                <style>
55
                                body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
56
                                pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
57
                                h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%;  font-weight:bold }
58
                                .TableHeadingColor { background:#EEEEFF; }
59
                                a { text-decoration:none }
60
                                a:hover { text-decoration:underline }
61
                                a:link, a:visited { color:blue }
62
                                table { border:0px }
63
                                .TableRowColor td:first-child { border-left:1px solid black }
64
                                .TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
65
                                hr { border:0px; border-bottom:1px solid #333366; }
66
                                </style>
67
                        </EM>
68
</TD>
69
</TR>
70
 
71
<TR>
72
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
73
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/Timer.html" title="class in com.badlogic.gdx.utils"><B>PREV CLASS</B></A>&nbsp;
74
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/TimeUtils.html" title="class in com.badlogic.gdx.utils"><B>NEXT CLASS</B></A></FONT></TD>
75
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
76
  <A HREF="../../../../index.html?com/badlogic/gdx/utils/Timer.Task.html" target="_top"><B>FRAMES</B></A>  &nbsp;
77
&nbsp;<A HREF="Timer.Task.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
78
&nbsp;<SCRIPT type="text/javascript">
79
  <!--
80
  if(window==top) {
81
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
82
  }
83
  //-->
84
</SCRIPT>
85
<NOSCRIPT>
86
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
87
</NOSCRIPT>
88
 
89
 
90
</FONT></TD>
91
</TR>
92
<TR>
93
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
94
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
95
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
96
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
97
</TR>
98
</TABLE>
99
<A NAME="skip-navbar_top"></A>
100
<!-- ========= END OF TOP NAVBAR ========= -->
101
 
102
<HR>
103
<!-- ======== START OF CLASS DATA ======== -->
104
<H2>
105
<FONT SIZE="-1">
106
com.badlogic.gdx.utils</FONT>
107
<BR>
108
Class Timer.Task</H2>
109
<PRE>
110
java.lang.Object
111
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.badlogic.gdx.utils.Timer.Task</B>
112
</PRE>
113
<DL>
114
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Runnable</DD>
115
</DL>
116
<DL>
117
<DT><B>Enclosing class:</B><DD><A HREF="../../../../com/badlogic/gdx/utils/Timer.html" title="class in com.badlogic.gdx.utils">Timer</A></DD>
118
</DL>
119
<HR>
120
<DL>
121
<DT><PRE>public abstract static class <B>Timer.Task</B><DT>extends java.lang.Object<DT>implements java.lang.Runnable</DL>
122
</PRE>
123
 
124
<P>
125
Runnable with a cancel method.
126
<P>
127
 
128
<P>
129
<DL>
130
<DT><B>Author:</B></DT>
131
  <DD>Nathan Sweet</DD>
132
<DT><B>See Also:</B><DD><A HREF="../../../../com/badlogic/gdx/utils/Timer.html" title="class in com.badlogic.gdx.utils"><CODE>Timer</CODE></A></DL>
133
<HR>
134
 
135
<P>
136
 
137
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
138
 
139
<A NAME="constructor_summary"><!-- --></A>
140
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143
<B>Constructor Summary</B></FONT></TH>
144
</TR>
145
<TR BGCOLOR="white" CLASS="TableRowColor">
146
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Timer.Task.html#Timer.Task()">Timer.Task</A></B>()</CODE>
147
 
148
<BR>
149
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150
</TR>
151
</TABLE>
152
&nbsp;
153
<!-- ========== METHOD SUMMARY =========== -->
154
 
155
<A NAME="method_summary"><!-- --></A>
156
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
158
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
159
<B>Method Summary</B></FONT></TH>
160
</TR>
161
<TR BGCOLOR="white" CLASS="TableRowColor">
162
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163
<CODE>&nbsp;void</CODE></FONT></TD>
164
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Timer.Task.html#cancel()">cancel</A></B>()</CODE>
165
 
166
<BR>
167
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Cancels the task.</TD>
168
</TR>
169
<TR BGCOLOR="white" CLASS="TableRowColor">
170
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171
<CODE>&nbsp;boolean</CODE></FONT></TD>
172
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Timer.Task.html#isScheduled()">isScheduled</A></B>()</CODE>
173
 
174
<BR>
175
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if this task is scheduled to be executed in the future by a timer.</TD>
176
</TR>
177
<TR BGCOLOR="white" CLASS="TableRowColor">
178
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179
<CODE>abstract &nbsp;void</CODE></FONT></TD>
180
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Timer.Task.html#run()">run</A></B>()</CODE>
181
 
182
<BR>
183
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If this is the last time the task will be ran or the task is first cancelled, it may be scheduled again in this method.</TD>
184
</TR>
185
</TABLE>
186
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
187
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
190
</TR>
191
<TR BGCOLOR="white" CLASS="TableRowColor">
192
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
193
</TR>
194
</TABLE>
195
&nbsp;
196
<P>
197
 
198
<!-- ========= CONSTRUCTOR DETAIL ======== -->
199
 
200
<A NAME="constructor_detail"><!-- --></A>
201
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
204
<B>Constructor Detail</B></FONT></TH>
205
</TR>
206
</TABLE>
207
 
208
<A NAME="Timer.Task()"><!-- --></A><H3>
209
Timer.Task</H3>
210
<PRE>
211
public <B>Timer.Task</B>()</PRE>
212
<DL>
213
</DL>
214
 
215
<!-- ============ METHOD DETAIL ========== -->
216
 
217
<A NAME="method_detail"><!-- --></A>
218
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
219
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
220
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
221
<B>Method Detail</B></FONT></TH>
222
</TR>
223
</TABLE>
224
 
225
<A NAME="run()"><!-- --></A><H3>
226
run</H3>
227
<PRE>
228
public abstract void <B>run</B>()</PRE>
229
<DL>
230
<DD>If this is the last time the task will be ran or the task is first cancelled, it may be scheduled again in this method.
231
<P>
232
<DD><DL>
233
<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
234
</DD>
235
<DD><DL>
236
</DL>
237
</DD>
238
</DL>
239
<HR>
240
 
241
<A NAME="cancel()"><!-- --></A><H3>
242
cancel</H3>
243
<PRE>
244
public void <B>cancel</B>()</PRE>
245
<DL>
246
<DD>Cancels the task. It will not be executed until it is scheduled again. This method can be called at any time.
247
<P>
248
<DD><DL>
249
</DL>
250
</DD>
251
<DD><DL>
252
</DL>
253
</DD>
254
</DL>
255
<HR>
256
 
257
<A NAME="isScheduled()"><!-- --></A><H3>
258
isScheduled</H3>
259
<PRE>
260
public boolean <B>isScheduled</B>()</PRE>
261
<DL>
262
<DD>Returns true if this task is scheduled to be executed in the future by a timer.
263
<P>
264
<DD><DL>
265
</DL>
266
</DD>
267
<DD><DL>
268
</DL>
269
</DD>
270
</DL>
271
<!-- ========= END OF CLASS DATA ========= -->
272
<HR>
273
 
274
 
275
<!-- ======= START OF BOTTOM NAVBAR ====== -->
276
<A NAME="navbar_bottom"><!-- --></A>
277
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
278
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
279
<TR>
280
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
281
<A NAME="navbar_bottom_firstrow"><!-- --></A>
282
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
283
  <TR ALIGN="center" VALIGN="top">
284
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
285
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
286
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
287
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Timer.Task.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
288
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
289
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
290
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
291
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
292
  </TR>
293
</TABLE>
294
</TD>
295
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
296
libgdx API</EM>
297
</TD>
298
</TR>
299
 
300
<TR>
301
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
302
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/Timer.html" title="class in com.badlogic.gdx.utils"><B>PREV CLASS</B></A>&nbsp;
303
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/TimeUtils.html" title="class in com.badlogic.gdx.utils"><B>NEXT CLASS</B></A></FONT></TD>
304
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
305
  <A HREF="../../../../index.html?com/badlogic/gdx/utils/Timer.Task.html" target="_top"><B>FRAMES</B></A>  &nbsp;
306
&nbsp;<A HREF="Timer.Task.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
307
&nbsp;<SCRIPT type="text/javascript">
308
  <!--
309
  if(window==top) {
310
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
311
  }
312
  //-->
313
</SCRIPT>
314
<NOSCRIPT>
315
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
316
</NOSCRIPT>
317
 
318
 
319
</FONT></TD>
320
</TR>
321
<TR>
322
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
323
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
324
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
325
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
326
</TR>
327
</TABLE>
328
<A NAME="skip-navbar_bottom"></A>
329
<!-- ======== END OF BOTTOM NAVBAR ======= -->
330
 
331
<HR>
332
 
333
                                <div style="font-size:9pt"><i>
334
                                Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
335
                                </i></div>
336
 
337
</BODY>
338
</HTML>