Android APIs
java.lang.Object
   ↳ android.app.Dialog
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Base class for Dialogs.

Note: Activities provide a facility to manage the creation, saving and restoring of dialogs. See onCreateDialog(int), onPrepareDialog(int, Dialog), showDialog(int), and dismissDialog(int). If these methods are used, getOwnerActivity() will return the Activity that managed this dialog.

Often you will want to have a Dialog display on top of the current input method, because there is no reason for it to accept text. You can do this by setting the WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM window flag (assuming your Dialog takes input focus, as it the default) with the following code:

 getWindow().setFlags(WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM,
         WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM);

Developer Guides

For more information about creating dialogs, read the Dialogs developer guide.

Summary

[Expand]
Inherited Constants
From interface android.content.DialogInterface
Public Constructors
Dialog(Context context)
Create a Dialog window that uses the default dialog frame style.
Dialog(Context context, int theme)
Create a Dialog window that uses a custom dialog style.
Protected Constructors
Dialog(Context context, boolean cancelable, DialogInterface.OnCancelListener cancelListener)
Public Methods
void addContentView(View view, ViewGroup.LayoutParams params)
Add an additional content view to the screen.
void cancel()
Cancel the dialog.
void closeOptionsMenu()
void dismiss()
Dismiss this dialog, removing it from the screen.
boolean dispatchGenericMotionEvent(MotionEvent ev)
Called to process generic motion events.
boolean dispatchKeyEvent(KeyEvent event)
Called to process key events.
boolean dispatchKeyShortcutEvent(KeyEvent event)
Called to process a key shortcut event.
boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event)
Called to process population of AccessibilityEvents.
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().
ActionBar getActionBar()
Retrieve the ActionBar attached to this dialog, if present.
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.
LayoutInflater getLayoutInflater()
final Activity getOwnerActivity()
Returns the Activity that owns this Dialog.
final int getVolumeControlStream()
Window getWindow()
Retrieve the current Window for the activity.
void hide()
Hide the dialog, but do not dismiss it.
void invalidateOptionsMenu()
boolean isShowing()
void onActionModeFinished(ActionMode mode)
Called when an action mode has been finished. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeFinished(mode).
void onActionModeStarted(ActionMode mode)
Called when an action mode has been started. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeStarted(mode).
void onAttachedToWindow()
Called when the window has been attached to the window manager.
void onBackPressed()
Called when the dialog has detected the user's press of the back key.
void onContentChanged()
This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).
boolean onContextItemSelected(MenuItem item)
void onContextMenuClosed(Menu menu)
void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)
Called when the context menu for this view is being built.
boolean onCreateOptionsMenu(Menu menu)
It is usually safe to proxy this call to the owner activity's onCreateOptionsMenu(Menu) if the client desires the same menu for this Dialog.
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'.
void onDetachedFromWindow()
Called when the window has been attached to the window manager.
boolean onGenericMotionEvent(MotionEvent event)
Called when a generic motion event was not handled by any of the views inside of the dialog.
boolean onKeyDown(int keyCode, KeyEvent event)
A key was pressed down.
boolean onKeyLongPress(int keyCode, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event).
boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).
boolean onKeyShortcut(int keyCode, KeyEvent event)
Called when a key shortcut event is not handled by any of the views in the Dialog.
boolean onKeyUp(int keyCode, KeyEvent event)
A key was released.
boolean onMenuItemSelected(int featureId, MenuItem item)
Called when a panel's menu item has been selected by the user.
boolean onMenuOpened(int featureId, Menu menu)
Called when a panel's menu is opened by the user.
boolean onOptionsItemSelected(MenuItem item)
void onOptionsMenuClosed(Menu menu)
void onPanelClosed(int featureId, Menu menu)
Called when a panel is being closed.
boolean onPrepareOptionsMenu(Menu menu)
It is usually safe to proxy this call to the owner activity's onPrepareOptionsMenu(Menu) if the client desires the same menu for this Dialog.
boolean onPreparePanel(int featureId, View view, Menu menu)
Prepare a panel to be displayed.
void onRestoreInstanceState(Bundle savedInstanceState)
Restore the state of the dialog from a previously saved bundle.
Bundle onSaveInstanceState()
Saves the state of the dialog into a bundle.
boolean onSearchRequested()
This hook is called when the user signals the desire to start a search.
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(WindowManager.LayoutParams params)
This is called whenever the current window attributes change.
abstract void onWindowDismissed()
Called when a window is dismissed.
void onWindowFocusChanged(boolean hasFocus)
This hook is called whenever the window focus changes.
ActionMode onWindowStartingActionMode(ActionMode.Callback callback)
Called when an action mode is being started for this window.
void openContextMenu(View view)
void openOptionsMenu()
void registerForContextMenu(View view)
final boolean requestWindowFeature(int featureId)
Enable extended window features.
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 setCanceledOnTouchOutside(boolean cancel)
Sets whether this dialog is canceled when touched outside the window's bounds.
void setContentView(View view)
Set the screen content to an explicit view.
void setContentView(int layoutResID)
Set the screen content from a layout resource.
void setContentView(View view, ViewGroup.LayoutParams params)
Set the screen content to an explicit view.
void setDismissMessage(Message msg)
Set a message to be sent when the dialog is dismissed.
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 setOnCancelListener(DialogInterface.OnCancelListener listener)
Set a listener to be invoked when the dialog is canceled.
void setOnDismissListener(DialogInterface.OnDismissListener listener)
Set a listener to be invoked when the dialog is dismissed.
void setOnKeyListener(DialogInterface.OnKeyListener onKeyListener)
Sets the callback that will be called if a key is dispatched to the dialog.
void setOnShowListener(DialogInterface.OnShowListener listener)
Sets a listener to be invoked when the dialog is shown.
final void setOwnerActivity(Activity activity)
Sets the Activity that owns this dialog.
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.
final void setVolumeControlStream(int streamType)
By default, this will use the owner Activity's suggested stream type.
void show()
Start the dialog and display it on screen.
void takeKeyEvents(boolean get)
Request that key events come to this dialog.
void unregisterForContextMenu(View view)
Protected Methods
void onCreate(Bundle savedInstanceState)
Similar to onCreate(Bundle), you should initialize your dialog in this method, including calling setContentView(View).
void onStart()
Called when the dialog is starting.
void onStop()
Called to tell you that you're stopping.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.content.DialogInterface
From interface android.view.KeyEvent.Callback
From interface android.view.View.OnCreateContextMenuListener
From interface android.view.Window.Callback

Public Constructors

public Dialog (Context context)

Added in API level 1

Create a Dialog window that uses the default dialog frame style.

Parameters
context The Context the Dialog is to run it. In particular, it uses the window manager and theme in this context to present its UI.

public Dialog (Context context, int theme)

Added in API level 1

Create a Dialog window that uses a custom dialog style.

Parameters
context The Context in which the Dialog should run. In particular, it uses the window manager and theme from this context to present its UI.
theme A style resource describing the theme to use for the window. See Style and Theme Resources for more information about defining and using styles. This theme is applied on top of the current theme in context. If 0, the default dialog theme will be used.

Protected Constructors

protected Dialog (Context context, boolean cancelable, DialogInterface.OnCancelListener cancelListener)

Added in API level 1

Public Methods

public void addContentView (View view, ViewGroup.LayoutParams params)

Added in API level 1

Add an additional content view to the screen. Added after any existing ones in the screen -- existing views are NOT removed.

Parameters
view The desired content to display.
params Layout parameters for the view.

public void cancel ()

Added in API level 1

Cancel the dialog. This is essentially the same as calling dismiss(), but it will also call your DialogInterface.OnCancelListener (if registered).

public void closeOptionsMenu ()

Added in API level 1

public void dismiss ()

Added in API level 1

Dismiss this dialog, removing it from the screen. This method can be invoked safely from any thread. Note that you should not override this method to do cleanup when the dialog is dismissed, instead implement that in onStop().

public boolean dispatchGenericMotionEvent (MotionEvent ev)

Added in API level 12

Called to process generic motion events. You can override this to intercept all generic motion events before they are dispatched to the window. Be sure to call this implementation for generic motion events that should be handled normally.

Parameters
ev The generic motion event.
Returns
  • boolean Return true if this event was consumed.

public boolean dispatchKeyEvent (KeyEvent event)

Added in API level 1

Called to process key events. You can override this to intercept all key events before they are dispatched to the window. Be sure to call this implementation for key events that should be handled normally.

Parameters
event The key event.
Returns
  • boolean Return true if this event was consumed.

public boolean dispatchKeyShortcutEvent (KeyEvent event)

Added in API level 11

Called to process a key shortcut event. You can override this to intercept all key shortcut events before they are dispatched to the window. Be sure to call this implementation for key shortcut events that should be handled normally.

Parameters
event The key shortcut event.
Returns
  • True if this event was consumed.

public boolean dispatchPopulateAccessibilityEvent (AccessibilityEvent event)

Added in API level 4

Called to process population of AccessibilityEvents.

Parameters
event The event.
Returns
  • boolean Return true if event population was completed.

public boolean dispatchTouchEvent (MotionEvent ev)

Added in API level 1

Called to process touch screen events. You can override this to intercept all touch screen events before they are dispatched to the window. Be sure to call this implementation for touch screen events that should be handled normally.

Parameters
ev The touch screen event.
Returns
  • boolean Return true if this event was consumed.

public boolean dispatchTrackballEvent (MotionEvent ev)

Added in API level 1

Called to process trackball events. You can override this to intercept all trackball events before they are dispatched to the window. Be sure to call this implementation for trackball events that should be handled normally.

Parameters
ev The trackball event.
Returns
  • boolean Return true if this event was consumed.

public View findViewById (int id)

Added in API level 1

Finds a view that was identified by the id attribute from the XML that was processed in onStart().

Parameters
id the identifier of the view to find
Returns
  • The view if found or null otherwise.

public ActionBar getActionBar ()

Added in API level 11

Retrieve the ActionBar attached to this dialog, if present.

Returns
  • The ActionBar attached to the dialog or null if no ActionBar is present.

public final Context getContext ()

Added in API level 1

Retrieve the Context this Dialog is running in.

Returns
  • Context The Context used by the Dialog.

public View getCurrentFocus ()

Added in API level 1

Call getCurrentFocus() on the Window if this Activity to return the currently focused view.

Returns
  • View The current View with focus or null.

public LayoutInflater getLayoutInflater ()

Added in API level 1

public final Activity getOwnerActivity ()

Added in API level 1

Returns the Activity that owns this Dialog. For example, if showDialog(int) is used to show this Dialog, that Activity will be the owner (by default). Depending on how this dialog was created, this may return null.

Returns
  • The Activity that owns this Dialog.

public final int getVolumeControlStream ()

Added in API level 1

public Window getWindow ()

Added in API level 1

Retrieve the current Window for the activity. This can be used to directly access parts of the Window API that are not available through Activity/Screen.

Returns
  • Window The current window, or null if the activity is not visual.

public void hide ()

Added in API level 1

Hide the dialog, but do not dismiss it.

public void invalidateOptionsMenu ()

Added in API level 11

public boolean isShowing ()

Added in API level 1

Returns
  • Whether the dialog is currently showing.

public void onActionModeFinished (ActionMode mode)

Added in API level 11

Called when an action mode has been finished. The appropriate mode callback method will have already been invoked. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeFinished(mode).

Parameters
mode The mode that was just finished.

public void onActionModeStarted (ActionMode mode)

Added in API level 11

Called when an action mode has been started. The appropriate mode callback method will have already been invoked. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeStarted(mode).

Parameters
mode The new mode that has just been started.

public void onAttachedToWindow ()

Added in API level 5

Called when the window has been attached to the window manager. See View.onAttachedToWindow() for more information.

public void onBackPressed ()

Added in API level 5

Called when the dialog has detected the user's press of the back key. The default implementation simply cancels the dialog (only if it is cancelable), but you can override this to do whatever you want.

public void onContentChanged ()

Added in API level 1

This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).

public boolean onContextItemSelected (MenuItem item)

Added in API level 1

public void onContextMenuClosed (Menu menu)

Added in API level 1

public void onCreateContextMenu (ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)

Added in API level 1

Called when the context menu for this view is being built. It is not safe to hold onto the menu after this method returns.

Parameters
menu The context menu that is being built
v The view for which the context menu is being built
menuInfo Extra information about the item for which the context menu should be shown. This information will vary depending on the class of v.

public boolean onCreateOptionsMenu (Menu menu)

Added in API level 1

It is usually safe to proxy this call to the owner activity's onCreateOptionsMenu(Menu) if the client desires the same menu for this Dialog.

public boolean onCreatePanelMenu (int featureId, Menu menu)

Added in API level 1

Initialize the contents of the menu for panel 'featureId'. This is called if onCreatePanelView() returns null, giving you a standard menu in which you can place your items. It is only called once for the panel, the first time it is shown.

You can safely hold on to menu (and any items created from it), making modifications to it as desired, until the next time onCreatePanelMenu() is called for this feature.

Parameters
featureId The panel being created.
menu The menu inside the panel.
Returns
  • boolean You must return true for the panel to be displayed; if you return false it will not be shown.

public View onCreatePanelView (int featureId)

Added in API level 1

Instantiate the view to display in the panel for 'featureId'. You can return null, in which case the default content (typically a menu) will be created for you.

Parameters
featureId Which panel is being created.
Returns
  • view The top-level view to place in the panel.

public void onDetachedFromWindow ()

Added in API level 5

Called when the window has been attached to the window manager. See View.onDetachedFromWindow() for more information.

public boolean onGenericMotionEvent (MotionEvent event)

Added in API level 12

Called when a generic motion event was not handled by any of the views inside of the dialog.

Generic motion events describe joystick movements, mouse hovers, track pad touches, scroll wheel movements and other input events. The source of the motion event specifies the class of input that was received. Implementations of this method must examine the bits in the source before processing the event. The following code example shows how this is done.

Generic motion events with source class SOURCE_CLASS_POINTER are delivered to the view under the pointer. All other generic motion events are delivered to the focused view.

See onGenericMotionEvent(MotionEvent) for an example of how to handle this event.

Parameters
event The generic motion event being processed.
Returns
  • Return true if you have consumed the event, false if you haven't. The default implementation always returns false.

public boolean onKeyDown (int keyCode, KeyEvent event)

Added in API level 1

A key was pressed down.

If the focused view didn't want this event, this method is called.

The default implementation consumed the KEYCODE_BACK to later handle it in onKeyUp(int, KeyEvent).

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onKeyLongPress (int keyCode, KeyEvent event)

Added in API level 5

Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event).

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onKeyMultiple (int keyCode, int repeatCount, KeyEvent event)

Added in API level 1

Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).

Parameters
keyCode The value in event.getKeyCode().
repeatCount Number of pairs as returned by event.getRepeatCount().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onKeyShortcut (int keyCode, KeyEvent event)

Added in API level 11

Called when a key shortcut event is not handled by any of the views in the Dialog. Override this method to implement global key shortcuts for the Dialog. Key shortcuts can also be implemented by setting the shortcut property of menu items.

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • True if the key shortcut was handled.

public boolean onKeyUp (int keyCode, KeyEvent event)

Added in API level 1

A key was released.

The default implementation handles KEYCODE_BACK to close the dialog.

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onMenuItemSelected (int featureId, MenuItem item)

Added in API level 1

Called when a panel's menu item has been selected by the user.

Parameters
featureId The panel that the menu is in.
item The menu item that was selected.
Returns
  • boolean Return true to finish processing of selection, or false to perform the normal menu handling (calling its Runnable or sending a Message to its target Handler).

public boolean onMenuOpened (int featureId, Menu menu)

Added in API level 1

Called when a panel's menu is opened by the user. This may also be called when the menu is changing from one type to another (for example, from the icon menu to the expanded menu).

Parameters
featureId The panel that the menu is in.
menu The menu that is opened.
Returns
  • Return true to allow the menu to open, or false to prevent the menu from opening.

public boolean onOptionsItemSelected (MenuItem item)

Added in API level 1

public void onOptionsMenuClosed (Menu menu)

Added in API level 1

public void onPanelClosed (int featureId, Menu menu)

Added in API level 1

Called when a panel is being closed. If another logical subsequent panel is being opened (and this panel is being closed to make room for the subsequent panel), this method will NOT be called.

Parameters
featureId The panel that is being displayed.
menu If onCreatePanelView() returned null, this is the Menu being displayed in the panel.

public boolean onPrepareOptionsMenu (Menu menu)

Added in API level 1

It is usually safe to proxy this call to the owner activity's onPrepareOptionsMenu(Menu) if the client desires the same menu for this Dialog.

public boolean onPreparePanel (int featureId, View view, Menu menu)

Added in API level 1

Prepare a panel to be displayed. This is called right before the panel window is shown, every time it is shown.

Parameters
featureId The panel that is being displayed.
view The View that was returned by onCreatePanelView().
menu If onCreatePanelView() returned null, this is the Menu being displayed in the panel.
Returns
  • boolean You must return true for the panel to be displayed; if you return false it will not be shown.

public void onRestoreInstanceState (Bundle savedInstanceState)

Added in API level 1

Restore the state of the dialog from a previously saved bundle. The default implementation restores the state of the dialog's view hierarchy that was saved in the default implementation of onSaveInstanceState(), so be sure to call through to super when overriding unless you want to do all restoring of state yourself.

Parameters
savedInstanceState The state of the dialog previously saved by onSaveInstanceState().

public Bundle onSaveInstanceState ()

Added in API level 1

Saves the state of the dialog into a bundle. The default implementation saves the state of its view hierarchy, so you'll likely want to call through to super if you override this to save additional state.

Returns
  • A bundle with the state of the dialog.

public boolean onSearchRequested ()

Added in API level 1

This hook is called when the user signals the desire to start a search.

Returns
  • true if search launched, false if activity refuses (blocks)

public boolean onTouchEvent (MotionEvent event)

Added in API level 1

Called when a touch screen event was not handled by any of the views under it. This is most useful to process touch events that happen outside of your window bounds, where there is no view to receive it.

Parameters
event The touch screen event being processed.
Returns
  • Return true if you have consumed the event, false if you haven't. The default implementation will cancel the dialog when a touch happens outside of the window bounds.

public boolean onTrackballEvent (MotionEvent event)

Added in API level 1

Called when the trackball was moved and not handled by any of the views inside of the activity. So, for example, if the trackball moves while focus is on a button, you will receive a call here because buttons do not normally do anything with trackball events. The call here happens before trackball movements are converted to DPAD key events, which then get sent back to the view hierarchy, and will be processed at the point for things like focus navigation.

Parameters
event The trackball event being processed.
Returns
  • Return true if you have consumed the event, false if you haven't. The default implementation always returns false.

public void onWindowAttributesChanged (WindowManager.LayoutParams params)

Added in API level 1

This is called whenever the current window attributes change.

public abstract void onWindowDismissed ()

Called when a window is dismissed. This informs the callback that the window is gone, and it should finish itself.

public void onWindowFocusChanged (boolean hasFocus)

Added in API level 1

This hook is called whenever the window focus changes. See View.onWindowFocusChanged(boolean) for more information.

Parameters
hasFocus Whether the window now has focus.

public ActionMode onWindowStartingActionMode (ActionMode.Callback callback)

Added in API level 11

Called when an action mode is being started for this window. Gives the callback an opportunity to handle the action mode in its own unique and beautiful way. If this method returns null the system can choose a way to present the mode or choose not to start the mode at all.

Parameters
callback Callback to control the lifecycle of this action mode
Returns
  • The ActionMode that was started, or null if the system should present it

public void openContextMenu (View view)

Added in API level 1

public void openOptionsMenu ()

Added in API level 1

public void registerForContextMenu (View view)

Added in API level 1

public final boolean requestWindowFeature (int featureId)

Added in API level 1

Enable extended window features. This is a convenience for calling getWindow().requestFeature().

Parameters
featureId The desired feature as defined in Window.
Returns
  • Returns true if the requested feature is supported and now enabled.

public void setCancelMessage (Message msg)

Added in API level 1

Set a message to be sent when the dialog is canceled.

Parameters
msg The msg to send when the dialog is canceled.

public void setCancelable (boolean flag)

Added in API level 1

Sets whether this dialog is cancelable with the BACK key.

public void setCanceledOnTouchOutside (boolean cancel)

Added in API level 1

Sets whether this dialog is canceled when touched outside the window's bounds. If setting to true, the dialog is set to be cancelable if not already set.

Parameters
cancel Whether the dialog should be canceled when touched outside the window.

public void setContentView (View view)

Added in API level 1

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
view The desired content to display.

public void setContentView (int layoutResID)

Added in API level 1

Set the screen content from a layout resource. The resource will be inflated, adding all top-level views to the screen.

Parameters
layoutResID Resource ID to be inflated.

public void setContentView (View view, ViewGroup.LayoutParams params)

Added in API level 1

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
view The desired content to display.
params Layout parameters for the view.

public void setDismissMessage (Message msg)

Added in API level 1

Set a message to be sent when the dialog is dismissed.

Parameters
msg The msg to send when the dialog is dismissed.

public final void setFeatureDrawable (int featureId, Drawable drawable)

Added in API level 1

Convenience for calling setFeatureDrawable(int, Drawable).

public final void setFeatureDrawableAlpha (int featureId, int alpha)

Added in API level 1

Convenience for calling setFeatureDrawableAlpha(int, int).

public final void setFeatureDrawableResource (int featureId, int resId)

Added in API level 1

Convenience for calling setFeatureDrawableResource(int, int).

public final void setFeatureDrawableUri (int featureId, Uri uri)

Added in API level 1

Convenience for calling setFeatureDrawableUri(int, Uri).

public void setOnCancelListener (DialogInterface.OnCancelListener listener)

Added in API level 1

Set a listener to be invoked when the dialog is canceled.

This will only be invoked when the dialog is canceled. Cancel events alone will not capture all ways that the dialog might be dismissed. If the creator needs to know when a dialog is dismissed in general, use setOnDismissListener(DialogInterface.OnDismissListener).

Parameters
listener The DialogInterface.OnCancelListener to use.

public void setOnDismissListener (DialogInterface.OnDismissListener listener)

Added in API level 1

Set a listener to be invoked when the dialog is dismissed.

Parameters
listener The DialogInterface.OnDismissListener to use.

public void setOnKeyListener (DialogInterface.OnKeyListener onKeyListener)

Added in API level 1

Sets the callback that will be called if a key is dispatched to the dialog.

public void setOnShowListener (DialogInterface.OnShowListener listener)

Added in API level 8

Sets a listener to be invoked when the dialog is shown.

Parameters
listener The DialogInterface.OnShowListener to use.

public final void setOwnerActivity (Activity activity)

Added in API level 1

Sets the Activity that owns this dialog. An example use: This Dialog will use the suggested volume control stream of the Activity.

Parameters
activity The Activity that owns this dialog.

public void setTitle (int titleId)

Added in API level 1

Set the title text for this dialog's window. The text is retrieved from the resources with the supplied identifier.

Parameters
titleId the title's text resource identifier

public void setTitle (CharSequence title)

Added in API level 1

Set the title text for this dialog's window.

Parameters
title The new text to display in the title.

public final void setVolumeControlStream (int streamType)

Added in API level 1

By default, this will use the owner Activity's suggested stream type.

public void show ()

Added in API level 1

Start the dialog and display it on screen. The window is placed in the application layer and opaque. Note that you should not override this method to do initialization when the dialog is shown, instead implement that in onStart().

public void takeKeyEvents (boolean get)

Added in API level 1

Request that key events come to this dialog. Use this if your dialog has no views with focus, but the dialog still wants a chance to process key events.

Parameters
get true if the dialog should receive key events, false otherwise

public void unregisterForContextMenu (View view)

Added in API level 1

Protected Methods

protected void onCreate (Bundle savedInstanceState)

Added in API level 1

Similar to onCreate(Bundle), you should initialize your dialog in this method, including calling setContentView(View).

Parameters
savedInstanceState If this dialog is being reinitalized 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.

protected void onStart ()

Added in API level 1

Called when the dialog is starting.

protected void onStop ()

Added in API level 1

Called to tell you that you're stopping.