Unit addContentView(view: View, params: ViewGroup.LayoutParams?)

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

Unit cancel()

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

Unit closeOptionsMenu() Unit create()

Forces immediate creation of the dialog.

Note that you should not override this method to perform dialog creation. Rather, override onCreate(Bundle).

Unit dismiss()

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.

Boolean dispatchGenericMotionEvent(ev: MotionEvent)

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.

Boolean dispatchKeyEvent(event: KeyEvent)

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.

Boolean dispatchKeyShortcutEvent(event: KeyEvent)

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.

Boolean dispatchPopulateAccessibilityEvent(event: AccessibilityEvent)

Called to process population of AccessibilityEvents.

Boolean dispatchTouchEvent(ev: MotionEvent)

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.

Boolean dispatchTrackballEvent(ev: MotionEvent)

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.

T findViewById(id: Int)

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

Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.

ActionBar? getActionBar()

Retrieve the ActionBar attached to this dialog, if present.

Context getContext()

Retrieve the Context this Dialog is running in.

View? getCurrentFocus()

Call android.view.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.

Activity? getOwnerActivity()

Returns the Activity that owns this Dialog. For example, if Activity.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.

SearchEvent? getSearchEvent()

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

Int getVolumeControlStream() Window? getWindow()

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.

Unit hide()

Hide the dialog, but do not dismiss it.

Unit invalidateOptionsMenu() Boolean isShowing() Unit onActionModeFinished(mode: ActionMode!)

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).
If you override this method you must call through to the superclass implementation.

Unit onActionModeStarted(mode: ActionMode!)

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).
If you override this method you must call through to the superclass implementation.

Unit onAttachedToWindow()

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

Unit onBackPressed()

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.

If you target version android.os.Build.VERSION_CODES#TIRAMISU or later, you should not use this method but register an OnBackInvokedCallback on an OnBackInvokedDispatcher that you can retrieve using getOnBackInvokedDispatcher(). You should also set android:enableOnBackInvokedCallback="true" in the application manifest.

Alternatively, you can use androidx.activity.ComponentDialog#getOnBackPressedDispatcher() for backward compatibility.

Unit 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(item: MenuItem) Unit onContextMenuClosed(menu: Menu) Unit onCreateContextMenu(menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo!) 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(featureId: Int, menu: Menu) View? onCreatePanelView(featureId: Int) Unit onDetachedFromWindow()

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

Boolean onGenericMotionEvent(event: MotionEvent)

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 android.view.InputDevice#SOURCE_CLASS_POINTER are delivered to the view under the pointer. All other generic motion events are delivered to the focused view.

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

Boolean onKeyLongPress(keyCode: Int, event: KeyEvent)

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

Boolean onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent)

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

Boolean onKeyShortcut(keyCode: Int, event: KeyEvent)

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.

Boolean onMenuItemSelected(featureId: Int, item: MenuItem) Boolean onMenuOpened(featureId: Int, menu: Menu) Boolean onOptionsItemSelected(item: MenuItem) Unit onOptionsMenuClosed(menu: Menu) Unit onPanelClosed(featureId: Int, menu: Menu) 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(featureId: Int, view: View?, menu: Menu) Unit onRestoreInstanceState(savedInstanceState: Bundle)

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.

Bundle onSaveInstanceState()

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.

Boolean onSearchRequested()

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

Boolean onSearchRequested(searchEvent: SearchEvent)

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

Unit onStart()

Called when the dialog is starting.

Unit onStop()

Called to tell you that you're stopping.

Boolean onTouchEvent(event: MotionEvent)

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.

Boolean onTrackballEvent(event: MotionEvent)

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.

Unit onWindowAttributesChanged(params: WindowManager.LayoutParams!)

This is called whenever the current window attributes change.

Unit onWindowFocusChanged(hasFocus: Boolean)

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

ActionMode? onWindowStartingActionMode(callback: ActionMode.Callback!)

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. This is equivalent to onWindowStartingActionMode(android.view.ActionMode.Callback,int) with type ActionMode.TYPE_PRIMARY.

ActionMode? onWindowStartingActionMode(callback: ActionMode.Callback!, type: Int)

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.

Unit openContextMenu(view: View) Unit openOptionsMenu() Unit registerForContextMenu(view: View) Boolean requestWindowFeature(featureId: Int)

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

T requireViewById(id: Int)

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

Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.

Unit setCancelMessage(msg: Message?)

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

Unit setCancelable(flag: Boolean)

Sets whether this dialog is cancelable with the BACK key.

Unit setCanceledOnTouchOutside(cancel: Boolean)

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.

Unit setContentView(view: View)

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

Unit setContentView(view: View, params: ViewGroup.LayoutParams?)

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

Unit setContentView(layoutResID: Int)

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

Unit setDismissMessage(msg: Message?)

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

Unit setFeatureDrawable(featureId: Int, drawable: Drawable?)

Convenience for calling android.view.Window.setFeatureDrawable(int,Drawable).

Unit setFeatureDrawableAlpha(featureId: Int, alpha: Int)

Convenience for calling android.view.Window#setFeatureDrawableAlpha.

Unit setFeatureDrawableResource(featureId: Int, resId: Int)

Convenience for calling android.view.Window#setFeatureDrawableResource.

Unit setFeatureDrawableUri(featureId: Int, uri: Uri?)

Convenience for calling android.view.Window#setFeatureDrawableUri.

Unit setOnCancelListener(listener: DialogInterface.OnCancelListener?)

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.

Unit setOnDismissListener(listener: DialogInterface.OnDismissListener?)

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

Unit setOnKeyListener(onKeyListener: DialogInterface.OnKeyListener?)

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

Unit setOnShowListener(listener: DialogInterface.OnShowListener?)

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

Unit setOwnerActivity(activity: Activity)

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

Unit setTitle(titleId: Int)

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

Unit setVolumeControlStream(streamType: Int)

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

Unit show()

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.

Unit takeKeyEvents(get: Boolean)

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.

Unit unregisterForContextMenu(view: View)