# Print output for @column tags ?>
public
class
ProgressDialog
extends AlertDialog
java.lang.Object | |||
↳ | android.app.Dialog | ||
↳ | android.app.AlertDialog | ||
↳ | android.app.ProgressDialog |
This class is deprecated.
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
.
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 |
---|
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 |
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 |
void
|
onStop()
Called to tell you that you're stopping. |
Inherited methods | |
---|---|
public static final int STYLE_HORIZONTAL
Creates a ProgressDialog with a horizontal progress bar.
Constant Value: 1 (0x00000001)
public static final int STYLE_SPINNER
Creates a ProgressDialog with a circular, spinning progress bar. This is the default.
Constant Value: 0 (0x00000000)
public ProgressDialog (Context context)
Creates a Progress dialog.
Parameters | |
---|---|
context |
Context : the parent context |
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 int getMax ()
Gets the maximum allowed progress value. The default value is 100.
Returns | |
---|---|
int |
the maximum value |
public int getProgress ()
Gets the current progress.
Returns | |
---|---|
int |
the current progress, a value between 0 and getMax() |
public int getSecondaryProgress ()
Gets the current secondary progress.
Returns | |
---|---|
int |
the current secondary progress, a value between 0 and getMax() |
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() |
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() |
public boolean isIndeterminate ()
Whether this ProgressDialog is in indeterminate mode.
Returns | |
---|---|
boolean |
true if the dialog is in indeterminate mode, false otherwise |
public void onStart ()
Called when the dialog is starting.
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:
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 |
public void setMax (int max)
Sets the maximum allowed progress value.
Parameters | |
---|---|
max |
int |
public void setProgress (int value)
Sets the current progress.
Parameters | |
---|---|
value |
int : the current progress, a value between 0 and getMax() |
See also:
public void setProgressDrawable (Drawable d)
Sets the drawable to be used to display the progress value.
Parameters | |
---|---|
d |
Drawable : the drawable to be used |
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. |
public 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. |
public 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 |
public void setSecondaryProgress (int secondaryProgress)
Sets the secondary progress.
Parameters | |
---|---|
secondaryProgress |
int : the current secondary progress, a value between 0 and
getMax() |
See also:
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 |
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 |
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 |
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 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. |
protected void onStop ()
Called to tell you that you're stopping.