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

`open Unit`	`cancel()`
`open Unit`	`closeOptionsMenu()`
`open Unit`	`create()`
`open Unit`	`dismiss()`
`open Boolean`	`dispatchGenericMotionEvent(p0: MotionEvent)`
`open Boolean`	`dispatchKeyEvent(p0: KeyEvent)`
`open Boolean`	`dispatchKeyShortcutEvent(p0: KeyEvent)`
`open Boolean`	`dispatchPopulateAccessibilityEvent(p0: AccessibilityEvent)`
`open Boolean`	`dispatchTouchEvent(p0: MotionEvent)`
`open Boolean`	`dispatchTrackballEvent(p0: MotionEvent)`
`open T`	`<T : View> findViewById(p0: Int)`
`open ActionBar?`	`getActionBar()`
`Context`	`getContext()`
`open View?`	`getCurrentFocus()`
`open LayoutInflater`	`getLayoutInflater()`
`open OnBackInvokedDispatcher`	`getOnBackInvokedDispatcher()`
`Activity?`	`getOwnerActivity()`
`SearchEvent?`	`getSearchEvent()`
`Int`	`getVolumeControlStream()`
`open Window?`	`getWindow()`
`open Unit`	`hide()`
`open Unit`	`invalidateOptionsMenu()`
`open Boolean`	`isShowing()`
`open Unit`	`onActionModeFinished(p0: ActionMode)`
`open Unit`	`onActionModeStarted(p0: ActionMode)`
`open Unit`	`onAttachedToWindow()`
`open Unit`	`onContentChanged()`
`open Boolean`	`onContextItemSelected(p0: MenuItem)`
`open Unit`	`onContextMenuClosed(p0: Menu)`
`open Unit`	`onCreateContextMenu( p0: ContextMenu, p1: View, p2: ContextMenu.ContextMenuInfo )`
`open Boolean`	`onCreateOptionsMenu(p0: Menu)`
`open Boolean`	`onCreatePanelMenu(p0: Int, p1: Menu)`
`open View?`	`onCreatePanelView(p0: Int)`
`open Unit`	`onDetachedFromWindow()`
`open Boolean`	`onGenericMotionEvent(p0: MotionEvent)`
`open Boolean`	`onKeyDown(p0: Int, p1: KeyEvent)`
`open Boolean`	`onKeyLongPress(p0: Int, p1: KeyEvent)`
`open Boolean`	`onKeyMultiple(p0: Int, p1: Int, p2: KeyEvent)`
`open Boolean`	`onKeyShortcut(p0: Int, p1: KeyEvent)`
`open Boolean`	`onKeyUp(p0: Int, p1: KeyEvent)`
`open Boolean`	`onMenuItemSelected(p0: Int, p1: MenuItem)`
`open Boolean`	`onMenuOpened(p0: Int, p1: Menu)`
`open Boolean`	`onOptionsItemSelected(p0: MenuItem)`
`open Unit`	`onOptionsMenuClosed(p0: Menu)`
`open Unit`	`onPanelClosed(p0: Int, p1: Menu)`
`open Boolean`	`onPrepareOptionsMenu(p0: Menu)`
`open Boolean`	`onPreparePanel(p0: Int, p1: View?, p2: Menu)`
`open Unit`	`onRestoreInstanceState(p0: Bundle)`
`open Boolean`	`onSearchRequested()`
`open Boolean`	`onSearchRequested(p0: SearchEvent)`
`open Boolean`	`onTouchEvent(p0: MotionEvent)`
`open Boolean`	`onTrackballEvent(p0: MotionEvent)`
`open Unit`	`onWindowAttributesChanged(p0: WindowManager.LayoutParams)`
`open Unit`	`onWindowFocusChanged(p0: Boolean)`
`open ActionMode?`	`onWindowStartingActionMode(p0: ActionMode.Callback)`
`open ActionMode?`	`onWindowStartingActionMode(p0: ActionMode.Callback, p1: Int)`
`open Unit`	`openContextMenu(p0: View)`
`open Unit`	`openOptionsMenu()`
`open Unit`	`registerForContextMenu(p0: View)`
`Boolean`	`requestWindowFeature(p0: Int)`
`T`	`<T : View> requireViewById(p0: Int)`
`open Unit`	`setCancelMessage(p0: Message?)`
`open Unit`	`setCancelable(p0: Boolean)`
`open Unit`	`setCanceledOnTouchOutside(p0: Boolean)`
`open Unit`	`setDismissMessage(p0: Message?)`
`Unit`	`setFeatureDrawable(p0: Int, p1: Drawable?)`
`Unit`	`setFeatureDrawableAlpha(p0: Int, p1: Int)`
`Unit`	`setFeatureDrawableResource(p0: Int, p1: Int)`
`Unit`	`setFeatureDrawableUri(p0: Int, p1: Uri?)`
`open Unit`	`setOnCancelListener(p0: DialogInterface.OnCancelListener?)`
`open Unit`	`setOnDismissListener(p0: DialogInterface.OnDismissListener?)`
`open Unit`	`setOnKeyListener(p0: DialogInterface.OnKeyListener?)`
`open Unit`	`setOnShowListener(p0: DialogInterface.OnShowListener?)`
`Unit`	`setOwnerActivity(p0: Activity)`
`open Unit`	`setTitle(p0: CharSequence?)`
`open Unit`	`setTitle(p0: Int)`
`Unit`	`setVolumeControlStream(p0: Int)`
`open Unit`	`show()`
`open Unit`	`takeKeyEvents(p0: Boolean)`
`open Unit`	`unregisterForContextMenu(p0: View)`

From android.view.Window.Callback

`open Unit`	`onPointerCaptureChanged(p0: Boolean)`
`open Unit`	`onProvideKeyboardShortcuts( p0: MutableList<KeyboardShortcutGroup>, p1: Menu?, p2: Int )`

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-alpha03

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