Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 4d2089c5 authored by Andrew Solovay's avatar Andrew Solovay
Browse files

docs: Described why ProgressDialog is now deprecated. 

Per feedback from DevRel, devs should avoid ProgressDialog because
using a modal dialog to show progress is a bad user experience.
Updating the ProgressDialog javadocs to say this; there's a separate
CL (http://cr/160568896) to make a similar note in the Dialogs API
guide.

Doc is staged to:

http://go/dac-stage/reference/android/app/ProgressDialog.html

Test: make ds-docs
Bug: 37565313
Change-Id: I189732fdda4532f248861e3f3d077f743f6387de
parent 564d0bf1

core/java/android/app/ProgressDialog.java

+6 −2
Original line number Diff line number Diff line
@@ -42,8 +42,12 @@ import java.text.NumberFormat; 
 *

 * <p>The progress range is 0 to {@link #getMax() max}.</p>

 *

 * @deprecated Use a progress indicator such as ProgressBar inline inside of

 * an activity rather than using this modal dialog.

 * @deprecated <code>ProgressDialog</code> is a modal dialog, which prevents the

 * user from interacting with the app. Instead of using this class, you should

 * use a progress indicator like {@link android.widget.ProgressBar}, which can

 * be embedded in your app's UI. Alternatively, you can use a

 * <a href="/guide/topics/ui/notifiers/notifications.html">notification</a>

 * to inform the user of the task's progress.

 */

@Deprecated

public class ProgressDialog extends AlertDialog {