added in API level 1
Deprecated since API level O

ProgressDialog

public class ProgressDialog
extends AlertDialog

java.lang.Object
↳	android.app.Dialog
	↳	android.app.AlertDialog
		↳	android.app.ProgressDialog

This class was deprecated in API level O.
Use a progress indicator such as ProgressBar inline inside of an activity rather than using this modal dialog.

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

From class


    android.app.AlertDialog

From interface


    android.content.DialogInterface

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 `onCreate(Bundle)`, you should initialize your dialog in this method, including calling `setContentView(View)`.
`void`	`onStop()` Called to tell you that you're stopping.

Inherited methods

From class


  
    android.app.AlertDialog

From class


  
    android.app.Dialog

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.content.DialogInterface

From interface


  
    android.view.Window.Callback

From interface


  
    android.view.KeyEvent.Callback

From interface


  
    android.view.View.OnCreateContextMenuListener

Constants

STYLE_HORIZONTAL

added in API level 1

int STYLE_HORIZONTAL

Creates a ProgressDialog with a horizontal progress bar.

Constant Value: 1 (0x00000001)

STYLE_SPINNER

added in API level 1

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

ProgressDialog (Context context)

Creates a Progress dialog.

Parameters
`context`	`Context`: the parent context

ProgressDialog

added in API level 1

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

added in API level 1

int getMax ()

Gets the maximum allowed progress value. The default value is 100.

Returns
`int`	the maximum value

getProgress

added in API level 1

int getProgress ()

Gets the current progress.

Returns
`int`	the current progress, a value between 0 and `getMax()`

getSecondaryProgress

added in API level 1

int getSecondaryProgress ()

Gets the current secondary progress.

Returns
`int`	the current secondary progress, a value between 0 and `getMax()`

incrementProgressBy

added in API level 1

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

added in API level 1

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

added in API level 1

boolean isIndeterminate ()

Whether this ProgressDialog is in indeterminate mode.

Returns
`boolean`	true if the dialog is in indeterminate mode, false otherwise

onStart

added in API level 1

void onStart ()

Called when the dialog is starting.

setIndeterminate

added in API level 1

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

added in API level 1

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:

setMax

added in API level 1

void setMax (int max)

Sets the maximum allowed progress value.

Parameters
`max`	`int`

setMessage

added in API level 1

void setMessage (CharSequence message)

Parameters
`message`	`CharSequence`

setProgress

added in API level 1

void setProgress (int value)

Sets the current progress.

Parameters
`value`	`int`: the current progress, a value between 0 and `getMax()`

See also:

setProgress(int)

setProgressDrawable

added in API level 1

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:

setProgressDrawable(Drawable)

setProgressNumberFormat

added in API level 11

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

added in API level 11

void setProgressPercentFormat (NumberFormat format)

Change the format of the small text showing the percentage of progress. The default is NumberFormat.getPercentageInstnace(). 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.

setProgressStyle

added in API level 1

void setProgressStyle (int style)

Sets the style of this ProgressDialog, either STYLE_SPINNER or STYLE_HORIZONTAL. The default is STYLE_SPINNER.

Note: A ProgressDialog with style STYLE_SPINNER is always indeterminate and will ignore the indeterminate setting.

Parameters
`style`	`int`: the style of this ProgressDialog, either `STYLE_SPINNER` or `STYLE_HORIZONTAL`

setSecondaryProgress

added in API level 1

void setSecondaryProgress (int secondaryProgress)

Sets the secondary progress.

Parameters
`secondaryProgress`	`int`: the current secondary progress, a value between 0 and `getMax()`

See also:

setSecondaryProgress(int)

show

added in API level 1

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

added in API level 1

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

added in API level 1

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

added in API level 1

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

added in API level 1

void onCreate (Bundle savedInstanceState)

Similar to onCreate(Bundle), 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 `onSaveInstanceState()`, or null if this is the first time.

onStop

added in API level 1

void onStop ()

Called to tell you that you're stopping.

ProgressDialog

Summary

Constants

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods

Constants

STYLE_HORIZONTAL

STYLE_SPINNER

Public constructors

ProgressDialog

ProgressDialog

Public methods

getMax

getProgress

getSecondaryProgress

incrementProgressBy

incrementSecondaryProgressBy

isIndeterminate

onStart

setIndeterminate

setIndeterminateDrawable

setMax

setMessage

setProgress

setProgressDrawable

setProgressNumberFormat

setProgressPercentFormat

setProgressStyle

setSecondaryProgress

show

show

show

show

Protected methods

onCreate

onStop

Interfaces

Classes

Exceptions