Class Overview
Schedule a countdown until a time in the future, with
regular notifications on intervals along the way.
Example of showing a 30 second countdown in a text field:
new CountDownTimer(30000, 1000) {
public void onTick(long millisUntilFinished) {
mTextField.setText("seconds remaining: " + millisUntilFinished / 1000);
}
public void onFinish() {
mTextField.setText("done!");
}
}.start();
The calls to
onTick(long)
are synchronized to this object so that
one call to
onTick(long)
won't ever occur before the previous
callback is complete. This is only relevant when the implementation of
onTick(long)
takes an amount of time to execute that is significant
compared to the countdown interval.
Summary
Public Constructors |
|
CountDownTimer(long millisInFuture, long countDownInterval)
|
Public Methods |
synchronized
final
void
|
cancel()
Cancel the countdown.
|
abstract
void
|
onFinish()
Callback fired when the time is up.
|
abstract
void
|
onTick(long millisUntilFinished)
Callback fired on regular interval.
|
synchronized
final
CountDownTimer
|
start()
Start the countdown.
|
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this Object .
|
boolean
|
equals(Object o)
Compares this instance with the specified object and indicates if they
are equal.
|
void
|
finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
final
Class<?>
|
getClass()
Returns the unique instance of Class that represents this
object's class.
|
int
|
hashCode()
Returns an integer hash code for this object.
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
final
void
|
wait(long millis, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
final
void
|
wait(long millis)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
Public Constructors
public
CountDownTimer
(long millisInFuture, long countDownInterval)
Parameters
millisInFuture
| The number of millis in the future from the call
to start() until the countdown is done and onFinish()
is called. |
countDownInterval
| The interval along the way to receive
onTick(long) callbacks.
|
Public Methods
public
final
synchronized
void
cancel
()
public
abstract
void
onFinish
()
Callback fired when the time is up.
public
abstract
void
onTick
(long millisUntilFinished)
Callback fired on regular interval.
Parameters
millisUntilFinished
| The amount of time until finished.
|