Android - An Open Handset Alliance Project

android.app
public class

android.app.ProgressDialog

java.lang.Object
	android.app.Dialog		DialogInterface KeyEvent.Callback Window.Callback
		android.app.ProgressDialog

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..10000.

Summary

Constants inherited from interface android.content.DialogInterface

BUTTON1, BUTTON2, BUTTON3

		Value
int	BUTTON1	-1	0xffffffff
int	BUTTON2	-2	0xfffffffe
int	BUTTON3	-3	0xfffffffd

Fields inherited from class android.app.Dialog

mCancelMessage, mCancelable

Public Constructors

					ProgressDialog(Context context)
					ProgressDialog(Context context, int theme)

Public Methods

	void	dismiss()
		Dismiss this dialog, removing it from the screen.
	void	onStart()
		Called when the dialog is starting.
	void	setContentView(View contentView)
		Set the screen content to an explicit view.
	void	setIndeterminate(boolean indeterminate)
	void	setMessage(CharSequence message)
	void	setProgress(int value)
	void	setTitle(CharSequence title)
		Set the title text for this dialog's window.
static	ProgressDialog	show(Context context, CharSequence title, CharSequence message)
static	ProgressDialog	show(Context context, CharSequence title, CharSequence message, boolean indeterminate)
static	ProgressDialog	show(Context context, CharSequence title, View contentView, boolean indeterminate, boolean cancelable, OnCancelListener cancelListener)
static	ProgressDialog	show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable)
static	ProgressDialog	show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable, OnCancelListener cancelListener)
static	ProgressDialog	show(Context context, CharSequence title, View contentView)
static	ProgressDialog	show(Context context, CharSequence title, View contentView, boolean indeterminate)
static	ProgressDialog	show(Context context, CharSequence title, View contentView, boolean indeterminate, boolean cancelable)

Methods inherited from class android.app.Dialog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

				boolean	dispatchKeyEvent(KeyEvent event)
					Called to process key events.
				boolean	dispatchTouchEvent(MotionEvent event)
					Called to process touch screen events.
				boolean	dispatchTrackballEvent(MotionEvent event)
					Called to process trackball events.
				void	onContentChanged()
					This hook is called whenever the content view of the screen changes (due to a call to setContentView().
				boolean	onCreatePanelMenu(int featureId, Menu menu)
					Initialize the contents of the menu for panel 'featureId'.
				View	onCreatePanelView(int featureId)
					Instantiate the view to display in the panel for 'featureId'.
				boolean	onMenuItemSelected(int featureId, Item item)
					Called when a panel's menu item has been selected by the user.
				void	onPanelClosed(int featureId, Menu menu)
					Called when a panel is being closed.
				boolean	onPreparePanel(int featureId, View view, Menu menu)
					Prepare a panel to be displayed.
				boolean	onSearchRequested()
					Called when the user signals the desire to start a search.
				void	onWindowAttributesChanged(LayoutParams attrs)
					This is called whenever the current window attributes change.
				void	onWindowFocusChanged(boolean hasFocus)
					This hook is called whenever the window focus changes.

Details

Public Constructors

public ProgressDialog(Context context)

public ProgressDialog(Context context, int theme)

Public Methods

public void dismiss()

Dismiss this dialog, removing it from the screen. This method can be invoked safely from any thread.

public void onStart()

Called when the dialog is starting.

public void setContentView(View contentView)

Set the screen content to an explicit view. This view is placed directly into the screen's view hierarchy. It can itself be a complex view hierarhcy.

Parameters

contentView	The desired content to display.

public void setIndeterminate(boolean indeterminate)

public void setMessage(CharSequence message)

public void setProgress(int value)

public void setTitle(CharSequence title)

Set the title text for this dialog's window.

Parameters

title	The new text to display in the title.

public static ProgressDialog show(Context context, CharSequence title, CharSequence message)

public static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate)

public static ProgressDialog show(Context context, CharSequence title, View contentView, boolean indeterminate, boolean cancelable, OnCancelListener cancelListener)

public static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable)

public static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable, OnCancelListener cancelListener)

				boolean	onKeyDown(int keyCode, KeyEvent event)
					Called when a key down event has occurred.
				boolean	onKeyMultiple(int keyCode, int count, KeyEvent event)
					Called when multiple down/up pairs of the same key have occurred in a row.
				boolean	onKeyUp(int keyCode, KeyEvent event)
					Called when a key up event has occurred.

Android - An Open Handset Alliance Project

Documentation

Goodies

android.app.ProgressDialog

Summary

Constants inherited from interface android.content.DialogInterface

Fields inherited from class android.app.Dialog

Public Constructors

Public Methods

Methods inherited from class android.app.Dialog

Methods inherited from class java.lang.Object

Methods inherited from interface android.content.DialogInterface

Methods inherited from interface android.view.KeyEvent.Callback

Methods inherited from interface android.view.Window.Callback

Details

Public Constructors

public ProgressDialog(Context context)

public ProgressDialog(Context context, int theme)

Public Methods

public void dismiss()

public void onStart()

public void setContentView(View contentView)

Parameters

public void setIndeterminate(boolean indeterminate)

public void setMessage(CharSequence message)

public void setProgress(int value)

public void setTitle(CharSequence title)

Parameters

public static ProgressDialog show(Context context, CharSequence title, CharSequence message)

public static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate)

public static ProgressDialog show(Context context, CharSequence title, View contentView, boolean indeterminate, boolean cancelable, OnCancelListener cancelListener)

public static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable)

public static ProgressDialog show(Context context, CharSequence title, CharSequence message, boolean indeterminate, boolean cancelable, OnCancelListener cancelListener)

public static ProgressDialog show(Context context, CharSequence title, View contentView)

public static ProgressDialog show(Context context, CharSequence title, View contentView, boolean indeterminate)

public static ProgressDialog show(Context context, CharSequence title, View contentView, boolean indeterminate, boolean cancelable)

	void	addContentView(View view, LayoutParams params)
		Add an additional content view to the screen.
	void	cancel()
		Cancel (i.e.
	void	dismiss()
		Dismiss this dialog, removing it from the screen.
	boolean	dispatchKeyEvent(KeyEvent event)
		Called to process key events.
	boolean	dispatchTouchEvent(MotionEvent ev)
		Called to process touch screen events.
	boolean	dispatchTrackballEvent(MotionEvent ev)
		Called to process trackball events.
	View	findViewById(int id)
		Finds a view that was identified by the id attribute from the XML that was processed in onStart().
final	Context	getContext()
		Retrieve the Context this Dialog is running in.
	View	getCurrentFocus()
		Call getCurrentFocus() on the Window if this Activity to return the currently focused view.
	ViewInflate	getViewInflate()
	Window	getWindow()
		Retrieve the current Window for the activity.
	void	onContentChanged()
		This hook is called whenever the content view of the screen changes (due to a call to setContentView().
	boolean	onCreatePanelMenu(int featureId, Menu menu)
		Initialize the contents of the menu for panel 'featureId'.
	View	onCreatePanelView(int featureId)
		Instantiate the view to display in the panel for 'featureId'.
	boolean	onKeyDown(int keyCode, KeyEvent event)
		A key was pressed down.
	boolean	onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)
		Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).
	boolean	onKeyUp(int keyCode, KeyEvent event)
		A key was released.
	boolean	onMenuItemSelected(int featureId, Item item)
		Called when a panel's menu item has been selected by the user.
	void	onPanelClosed(int featureId, Menu menu)
		Called when a panel is being closed.
	boolean	onPreparePanel(int featureId, View view, Menu menu)
		Prepare a panel to be displayed.
	boolean	onSearchRequested()
		This hook is called when the user signals the desire to start a search.
	void	onStart()
		Called when the dialog is starting.
	void	onStop()
		Called to tell you that you're stopping.
	boolean	onTouchEvent(MotionEvent event)
		Called when a touch screen event was not handled by any of the views under it.
	boolean	onTrackballEvent(MotionEvent event)
		Called when the trackball was moved and not handled by any of the views inside of the activity.
	void	onWindowAttributesChanged(LayoutParams params)
		This is called whenever the current window attributes change.
	void	onWindowFocusChanged(boolean hasFocus)
		This hook is called whenever the window focus changes.
final	boolean	requestWindowFeature(int featureId)
		Enable extended window features.
	void	setCancelListener(OnCancelListener listener)
		Set a listener to be invoked when the dialog is canceled.
	void	setCancelMessage(Message msg)
		Set a message to be sent when the dialog is canceled.
	void	setCancelable(boolean flag)
		Sets whether this dialog is cancelable with the BACK key.
	void	setContentView(View view, LayoutParams params)
		Set the screen content to an explicit view.
	void	setContentView(View view)
		Set the screen content to an explicit view.
	void	setContentView(int layoutResID)
		Set the screen content from a layout resource.
final	void	setFeatureDrawable(int featureId, Drawable drawable)
		Convenience for calling setFeatureDrawable(int, Drawable).
final	void	setFeatureDrawableAlpha(int featureId, int alpha)
		Convenience for calling setFeatureDrawableAlpha(int, int).
final	void	setFeatureDrawableResource(int featureId, int resId)
		Convenience for calling setFeatureDrawableResource(int, int).
final	void	setFeatureDrawableUri(int featureId, Uri uri)
		Convenience for calling setFeatureDrawableUri(int, Uri).
	void	setTitle(int titleId)
		Set the title text for this dialog's window.
	void	setTitle(CharSequence title)
		Set the title text for this dialog's window.
	void	show()
		Start the dialog and display it on screen.
	void	takeKeyEvents(boolean get)
		Request that key events come to this dialog.


e.g. "intent" or "activity"

protected			Message	mCancelMessage
protected			boolean	mCancelable