Android
android.os
public abstract class

android.os.CountDownTimer

java.lang.Object
android.os.CountDownTimer

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

    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.
Methods inherited from class java.lang.Object

Details

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 void cancel()

Cancel the countdown.

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.

public final synchronized CountDownTimer start()

Start the countdown.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56