void addContentView(View view, ViewGroup.LayoutParams params)

Add an additional content view to the screen.

void cancel()

Cancel the dialog.

void closeOptionsMenu() void create()

Forces immediate creation of the dialog.

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.

<T extends View> T findViewById(int id)

Finds the first descendant view with the given ID or null if the ID is invalid (< 0), there is no matching view in the hierarchy, or the dialog has not yet been fully created (for example, via show() or create()).

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 Window.getCurrentFocus() on the Window if this Activity to return the currently focused view.

LayoutInflater getLayoutInflater() OnBackInvokedDispatcher getOnBackInvokedDispatcher()

Returns the OnBackInvokedDispatcher instance associated with the window that this dialog is attached to.

final Activity getOwnerActivity()

Returns the Activity that owns this Dialog.

final SearchEvent getSearchEvent()

During the onSearchRequested() callbacks, this function will return the SearchEvent that triggered the callback, if it exists.

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()

This method was deprecated in API level 33. Use OnBackInvokedCallback or androidx.activity.OnBackPressedCallback to handle back navigation instead.

Starting from Android 13 (API level 33), back event handling is moving to an ahead-of-time model and onBackPressed() and KeyEvent.KEYCODE_BACK should not be used to handle back events (back gesture or back button click). Instead, an OnBackInvokedCallback should be registered using Dialog.getOnBackInvokedDispatcher() .registerOnBackInvokedCallback(priority, callback).

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 onCreate(Bundle savedInstanceState)

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

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 Activity.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 detached from 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 Activity.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(SearchEvent searchEvent)

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

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(WindowManager.LayoutParams params)

This is called whenever the current window attributes change.

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.

ActionMode onWindowStartingActionMode(ActionMode.Callback callback, int type)

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.

final <T extends View> T requireViewById(int id)

Finds the first descendant view with the given ID or throws an IllegalArgumentException if the ID is invalid (< 0), there is no matching view in the hierarchy, or the dialog has not yet been fully created (for example, via show() or create()).

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(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 setContentView(View view)

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 android.view.Window.setFeatureDrawable(int,Drawable).

final void setFeatureDrawableAlpha(int featureId, int alpha)

Convenience for calling Window.setFeatureDrawableAlpha(int, int).

final void setFeatureDrawableResource(int featureId, int resId)

Convenience for calling Window.setFeatureDrawableResource(int, int).

final void setFeatureDrawableUri(int featureId, Uri uri)

Convenience for calling Window.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(CharSequence title)

Set the title text for this dialog's window.

void setTitle(int titleId)

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)