ProgressDialog

Kotlin | Java

public class ProgressDialog

extends AlertDialog

This class was deprecated in API level 26.

ProgressDialog 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 ProgressBar , which can be embedded in your app's UI. Alternatively, you can use a notification to inform the user of the task's progress.

A dialog showing a progress indicator and an optional text message or view. Only a text message or a view can be used at the same time.

The dialog can be made cancelable on back key press.

The progress range is 0 to max .

Summary

Constants int STYLE_HORIZONTAL Creates a ProgressDialog with a horizontal progress bar. int STYLE_SPINNER Creates a ProgressDialog with a circular, spinning progress bar.

Inherited constants android.app.AlertDialog From class int THEME_DEVICE_DEFAULT_DARK This constant was deprecated in API level 23. Use R.style.Theme_DeviceDefault_Dialog_Alert . int THEME_DEVICE_DEFAULT_LIGHT This constant was deprecated in API level 23. Use R.style.Theme_DeviceDefault_Light_Dialog_Alert . int THEME_HOLO_DARK This constant was deprecated in API level 23. Use R.style.Theme_Material_Dialog_Alert . int THEME_HOLO_LIGHT This constant was deprecated in API level 23. Use R.style.Theme_Material_Light_Dialog_Alert . int THEME_TRADITIONAL This constant was deprecated in API level 23. Use R.style.Theme_Material_Dialog_Alert . android.content.DialogInterface From interface int BUTTON1 This constant was deprecated in API level 15. Use BUTTON_POSITIVE int BUTTON2 This constant was deprecated in API level 15. Use BUTTON_NEGATIVE int BUTTON3 This constant was deprecated in API level 15. Use BUTTON_NEUTRAL int BUTTON_NEGATIVE The identifier for the negative button. int BUTTON_NEUTRAL The identifier for the neutral button. int BUTTON_POSITIVE The identifier for the positive button.

Public constructors ProgressDialog(Context context) Creates a Progress dialog. ProgressDialog(Context context, int theme) Creates a Progress dialog.

Public methods int getMax() Gets the maximum allowed progress value. int getProgress() Gets the current progress. int getSecondaryProgress() Gets the current secondary progress. void incrementProgressBy(int diff) Increments the current progress value. void incrementSecondaryProgressBy(int diff) Increments the current secondary progress value. boolean isIndeterminate() Whether this ProgressDialog is in indeterminate mode. void onStart() Called when the dialog is starting. void setIndeterminate(boolean indeterminate) Change the indeterminate mode for this ProgressDialog. void setIndeterminateDrawable(Drawable d) Sets the drawable to be used to display the indeterminate progress value. void setMax(int max) Sets the maximum allowed progress value. void setMessage(CharSequence message) void setProgress(int value) Sets the current progress. void setProgressDrawable(Drawable d) Sets the drawable to be used to display the progress value. void setProgressNumberFormat(String format) Change the format of the small text showing current and maximum units of progress. void setProgressPercentFormat(NumberFormat format) Change the format of the small text showing the percentage of progress. void setProgressStyle(int style) Sets the style of this ProgressDialog, either STYLE_SPINNER or STYLE_HORIZONTAL . void setSecondaryProgress(int secondaryProgress) Sets the secondary progress. static ProgressDialog show(Context context, CharSequence title, CharSequence message) Creates and shows a ProgressDialog. static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable, DialogInterface.OnCancelListener cancelListener) Creates and shows a ProgressDialog. static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable) Creates and shows a ProgressDialog. static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate) Creates and shows a ProgressDialog.

Protected methods void onCreate(Bundle savedInstanceState) Similar to Activity#onCreate , you should initialize your dialog in this method, including calling setContentView(View) . void onStop() Called to tell you that you're stopping.

Constants

STYLE_HORIZONTAL

Deprecated in Added in API level 1 Deprecated in API level 26 public static final int STYLE_HORIZONTAL Creates a ProgressDialog with a horizontal progress bar. Constant Value: 1 (0x00000001)

STYLE_SPINNER

Deprecated in Added in API level 1 Deprecated in API level 26 public static final int STYLE_SPINNER Creates a ProgressDialog with a circular, spinning progress bar. This is the default. Constant Value: 0 (0x00000000)

Public constructors

ProgressDialog Added in API level 1 public ProgressDialog (Context context) Creates a Progress dialog. Parameters context Context : the parent context

ProgressDialog Added in API level 1 public ProgressDialog (Context context, int theme) Creates a Progress dialog. Parameters context Context : the parent context theme int : the resource ID of the theme against which to inflate this dialog, or 0 to use the parent context 's default alert dialog theme

Public methods

getMax

Deprecated in Added in API level 1 Deprecated in API level 26 public int getMax () Gets the maximum allowed progress value. The default value is 100. Returns int the maximum value

getProgress

Deprecated in Added in API level 1 Deprecated in API level 26 public int getProgress () Gets the current progress. Returns int the current progress, a value between 0 and getMax()

getSecondaryProgress

Deprecated in Added in API level 1 Deprecated in API level 26 public int getSecondaryProgress () Gets the current secondary progress. Returns int the current secondary progress, a value between 0 and getMax()

incrementProgressBy

Deprecated in Added in API level 1 Deprecated in API level 26 public void incrementProgressBy (int diff) Increments the current progress value. Parameters diff int : the amount by which the current progress will be incremented, up to getMax()

incrementSecondaryProgressBy

Deprecated in Added in API level 1 Deprecated in API level 26 public void incrementSecondaryProgressBy (int diff) Increments the current secondary progress value. Parameters diff int : the amount by which the current secondary progress will be incremented, up to getMax()

isIndeterminate

Deprecated in Added in API level 1 Deprecated in API level 26 public boolean isIndeterminate () Whether this ProgressDialog is in indeterminate mode. Returns boolean true if the dialog is in indeterminate mode, false otherwise

onStart

Deprecated in Added in API level 1 Deprecated in API level 26 public void onStart () Called when the dialog is starting.

setIndeterminate

Deprecated in Added in API level 1 Deprecated in API level 26 public void setIndeterminate (boolean indeterminate) Change the indeterminate mode for this ProgressDialog. In indeterminate mode, the progress is ignored and the dialog shows an infinite animation instead. Note: A ProgressDialog with style STYLE_SPINNER is always indeterminate and will ignore this setting. Parameters indeterminate boolean : true to enable indeterminate mode, false otherwise See also: setProgressStyle(int)

setIndeterminateDrawable

Deprecated in Added in API level 1 Deprecated in API level 26 public void setIndeterminateDrawable (Drawable d) Sets the drawable to be used to display the indeterminate progress value. Parameters d Drawable : the drawable to be used See also: ProgressBar.setProgressDrawable(Drawable)

setIndeterminate(boolean)

setMax

Deprecated in Added in API level 1 Deprecated in API level 26 public void setMax (int max) Sets the maximum allowed progress value. Parameters max int

setProgressDrawable

Deprecated in Added in API level 1 Deprecated in API level 26 public void setProgressDrawable (Drawable d) Sets the drawable to be used to display the progress value. Parameters d Drawable : the drawable to be used See also: ProgressBar.setProgressDrawable(Drawable)

setProgressNumberFormat

Deprecated in Added in API level 11 Deprecated in API level 26 public void setProgressNumberFormat (String format) Change the format of the small text showing current and maximum units of progress. The default is "%1d/%2d". Should not be called during the number is progressing. Parameters format String : A string passed to String#format ; use "%1d" for the current number and "%2d" for the maximum. If null, nothing will be shown.

setProgressPercentFormat

Deprecated in Added in API level 11 Deprecated in API level 26 public void setProgressPercentFormat (NumberFormat format) Change the format of the small text showing the percentage of progress. The default is NumberFormat#getPercentInstance() Should not be called during the number is progressing. Parameters format NumberFormat : An instance of a NumberFormat to generate the percentage text. If null, nothing will be shown.

setSecondaryProgress

Deprecated in Added in API level 1 Deprecated in API level 26 public void setSecondaryProgress (int secondaryProgress) Sets the secondary progress. Parameters secondaryProgress int : the current secondary progress, a value between 0 and getMax() See also: ProgressBar.setSecondaryProgress(int)

show

Deprecated in Added in API level 1 Deprecated in API level 26 public static ProgressDialog show (Context context, CharSequence title, CharSequence message) Creates and shows a ProgressDialog. Parameters context Context : the parent context title CharSequence : the title text for the dialog's window message CharSequence : the text to be displayed in the dialog Returns ProgressDialog the ProgressDialog

show

Deprecated in Added in API level 1 Deprecated in API level 26 public static ProgressDialog show (Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable, DialogInterface.OnCancelListener cancelListener) Creates and shows a ProgressDialog. Parameters context Context : the parent context title CharSequence : the title text for the dialog's window message CharSequence : the text to be displayed in the dialog indeterminate boolean : true if the dialog should be indeterminate , false otherwise cancelable boolean : true if the dialog is cancelable , false otherwise cancelListener DialogInterface.OnCancelListener : the listener to be invoked when the dialog is canceled Returns ProgressDialog the ProgressDialog

show

Deprecated in Added in API level 1 Deprecated in API level 26 public static ProgressDialog show (Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable) Creates and shows a ProgressDialog. Parameters context Context : the parent context title CharSequence : the title text for the dialog's window message CharSequence : the text to be displayed in the dialog indeterminate boolean : true if the dialog should be indeterminate , false otherwise cancelable boolean : true if the dialog is cancelable , false otherwise Returns ProgressDialog the ProgressDialog

show

Deprecated in Added in API level 1 Deprecated in API level 26 public static ProgressDialog show (Context context, CharSequence title, CharSequence message, boolean indeterminate) Creates and shows a ProgressDialog. Parameters context Context : the parent context title CharSequence : the title text for the dialog's window message CharSequence : the text to be displayed in the dialog indeterminate boolean : true if the dialog should be indeterminate , false otherwise Returns ProgressDialog the ProgressDialog

Protected methods

onCreate

Deprecated in Added in API level 1 Deprecated in API level 26 protected void onCreate (Bundle savedInstanceState) Similar to Activity#onCreate , you should initialize your dialog in this method, including calling setContentView(View) . Parameters savedInstanceState Bundle : If this dialog is being reinitialized after a the hosting activity was previously shut down, holds the result from the most recent call to Dialog.onSaveInstanceState() , or null if this is the first time.