ComponentDialog

Added in 1.5.0

Kotlin |Java

open class ComponentDialog : Dialog, LifecycleOwner, OnBackPressedDispatcherOwner, NavigationEventDispatcherOwner, SavedStateRegistryOwner

kotlin.Any
↳	android.app.Dialog
	↳	androidx.activity.ComponentDialog

Known direct subclasses

AppCompatDialog

AppCompatDialog

Base class for AppCompat themed android.app.Dialogs.

Known indirect subclasses

AlertDialog, MediaRouteChooserDialog, MediaRouteControllerDialog

`AlertDialog`	A subclass of Dialog that can display one, two or three buttons.
`MediaRouteChooserDialog`	This class implements the route chooser dialog for `MediaRouter`.
`MediaRouteControllerDialog`	This class implements the route controller dialog for `MediaRouter`.

Base class for dialogs that enables composition of higher level components.

Summary

Public constructors
`ComponentDialog(context: Context, themeResId: @StyleRes Int)`

Public functions
`open Unit`	`addContentView(view: View, params: ViewGroup.LayoutParams?)`
`open Unit`	`@CallSuper initializeViewTreeOwners()` Sets the view tree owners before setting the content view so that the inflation process and attach listeners will see them already present.
`open Unit`	`@CallSuper onBackPressed()` This function is deprecated. This method has been deprecated in favor of using the {@link OnBackPressedDispatcher} via {@link #getOnBackPressedDispatcher()}.
`open Bundle`	`onSaveInstanceState()`
`open Unit`	`setContentView(layoutResID: Int)`
`open Unit`	`setContentView(view: View)`
`open Unit`	`setContentView(view: View, params: ViewGroup.LayoutParams?)`

Protected functions
`open Unit`	`@CallSuper onCreate(savedInstanceState: Bundle?)`
`open Unit`	`@CallSuper onStart()`
`open Unit`	`@CallSuper onStop()`

Public properties
`open Lifecycle`	`lifecycle`
`open NavigationEventDispatcher`	`navigationEventDispatcher` Lazily provides a `NavigationEventDispatcher` for back navigation handling, including support for predictive back gestures introduced in Android 13 (API 33+).
`final OnBackPressedDispatcher`	`onBackPressedDispatcher` Retrieve the `OnBackPressedDispatcher` that will be triggered when `onBackPressed` is called.
`open SavedStateRegistry`	`savedStateRegistry`

Inherited functions

From android.app.Dialog

`Unit`	`cancel()`
`Unit`	`closeOptionsMenu()`
`Unit`	`create()`
`Unit`	`dismiss()`
`Boolean`	`dispatchGenericMotionEvent(ev: MotionEvent)`
`Boolean`	`dispatchKeyEvent(event: KeyEvent)`
`Boolean`	`dispatchKeyShortcutEvent(event: KeyEvent)`
`Boolean`	`dispatchPopulateAccessibilityEvent(event: AccessibilityEvent)`
`Boolean`	`dispatchTouchEvent(ev: MotionEvent)`
`Boolean`	`dispatchTrackballEvent(ev: MotionEvent)`
`T`	`<T : View> findViewById(id: Int)`
`Unit`	`hide()`
`Unit`	`invalidateOptionsMenu()`
`Unit`	`onActionModeFinished(mode: ActionMode)`
`Unit`	`onActionModeStarted(mode: ActionMode)`
`Unit`	`onAttachedToWindow()`
`Unit`	`onContentChanged()`
`Boolean`	`onContextItemSelected(item: MenuItem)`
`Unit`	`onContextMenuClosed(menu: Menu)`
`Unit`	`onCreateContextMenu( menu: ContextMenu, v: View, menuInfo: ContextMenu.ContextMenuInfo )`
`Boolean`	`onCreateOptionsMenu(menu: Menu)`
`Boolean`	`onCreatePanelMenu(featureId: Int, menu: Menu)`
`View?`	`onCreatePanelView(featureId: Int)`
`Unit`	`onDetachedFromWindow()`
`Boolean`	`onGenericMotionEvent(event: MotionEvent)`
`Boolean`	`onKeyDown(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyLongPress(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent)`
`Boolean`	`onKeyShortcut(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyUp(keyCode: Int, event: KeyEvent)`
`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)`
`Boolean`	`onPreparePanel(featureId: Int, view: View?, menu: Menu)`
`Unit`	`onRestoreInstanceState(savedInstanceState: Bundle)`
`Boolean`	`onSearchRequested()`
`Boolean`	`onSearchRequested(searchEvent: SearchEvent)`
`Boolean`	`onTouchEvent(event: MotionEvent)`
`Boolean`	`onTrackballEvent(event: MotionEvent)`
`Unit`	`onWindowAttributesChanged(params: WindowManager.LayoutParams)`
`Unit`	`onWindowFocusChanged(hasFocus: Boolean)`
`ActionMode?`	`onWindowStartingActionMode(callback: ActionMode.Callback)`
`ActionMode?`	`onWindowStartingActionMode(callback: ActionMode.Callback, type: Int)`
`Unit`	`openContextMenu(view: View)`
`Unit`	`openOptionsMenu()`
`Unit`	`registerForContextMenu(view: View)`
`Boolean`	`requestWindowFeature(featureId: Int)`
`T`	`<T : View> requireViewById(id: Int)`
`Unit`	`setCancelMessage(msg: Message?)`
`Unit`	`setCancelable(flag: Boolean)`
`Unit`	`setCanceledOnTouchOutside(cancel: Boolean)`
`Unit`	`setDismissMessage(msg: Message?)`
`Unit`	`setFeatureDrawable(featureId: Int, drawable: Drawable?)`
`Unit`	`setFeatureDrawableAlpha(featureId: Int, alpha: Int)`
`Unit`	`setFeatureDrawableResource(featureId: Int, resId: Int)`
`Unit`	`setFeatureDrawableUri(featureId: Int, uri: Uri?)`
`Unit`	`setOnCancelListener(listener: DialogInterface.OnCancelListener?)`
`Unit`	`setOnDismissListener(listener: DialogInterface.OnDismissListener?)`
`Unit`	`setOnKeyListener(onKeyListener: DialogInterface.OnKeyListener?)`
`Unit`	`setOnShowListener(listener: DialogInterface.OnShowListener?)`
`Unit`	`setOwnerActivity(activity: Activity)`
`Unit`	`setTitle(title: CharSequence?)`
`Unit`	`setTitle(titleId: Int)`
`Unit`	`show()`
`Unit`	`takeKeyEvents(get: Boolean)`
`Unit`	`unregisterForContextMenu(view: View)`

From android.view.Window.Callback

`Unit`	`onPointerCaptureChanged(hasCapture: Boolean)`
`Unit`	`onProvideKeyboardShortcuts( data: MutableList<KeyboardShortcutGroup>, menu: Menu?, deviceId: Int )`

Inherited properties

From android.app.Dialog

`open ActionBar?`	`actionBar`
`Context`	`context`
`open View?`	`currentFocus`
`open Boolean`	`isShowing`
`open LayoutInflater`	`layoutInflater`
`open OnBackInvokedDispatcher`	`onBackInvokedDispatcher`
`Activity?`	`ownerActivity`
`SearchEvent?`	`searchEvent`
`Int`	`volumeControlStream`
`open Window?`	`window`

Public constructors

ComponentDialog

Added in 1.5.0

ComponentDialog(context: Context, themeResId: @StyleRes Int = 0)

Public functions

addContentView

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

initializeViewTreeOwners

Added in 1.8.0

@CallSuper
open fun initializeViewTreeOwners(): Unit

Sets the view tree owners before setting the content view so that the inflation process and attach listeners will see them already present.

onBackPressed

Added in 1.6.0

@CallSuper
open fun onBackPressed(): Unit

onSaveInstanceState

open fun onSaveInstanceState(): Bundle

setContentView

open fun setContentView(layoutResID: Int): Unit

setContentView

open fun setContentView(view: View): Unit

setContentView

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

Protected functions

onCreate

@CallSuper
protected open fun onCreate(savedInstanceState: Bundle?): Unit

onStart

@CallSuper
protected open fun onStart(): Unit

onStop

@CallSuper
protected open fun onStop(): Unit

Public properties

lifecycle

Added in 1.5.0

open val lifecycle: Lifecycle

navigationEventDispatcher

Added in 1.12.0

open val navigationEventDispatcher: NavigationEventDispatcher

Lazily provides a NavigationEventDispatcher for back navigation handling, including support for predictive back gestures introduced in Android 13 (API 33+).

This dispatcher acts as the central point for back navigation events. When a navigation event occurs (e.g., a back gesture), it safely invokes ComponentDialog.onBackPressed.

onBackPressedDispatcher

final val onBackPressedDispatcher: OnBackPressedDispatcher

Retrieve the OnBackPressedDispatcher that will be triggered when onBackPressed is called.

Returns
`OnBackPressedDispatcher`	The `OnBackPressedDispatcher` associated with this ComponentDialog.

savedStateRegistry

Added in 1.7.0

open val savedStateRegistry: SavedStateRegistry