ComponentDialog

Added in 1.5.0

Kotlin |Java

public class ComponentDialog extends Dialog implements LifecycleOwner, OnBackPressedDispatcherOwner, NavigationEventDispatcherOwner, SavedStateRegistryOwner

java.lang.Object
↳	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(@NonNull Context context, @StyleRes int themeResId)`

Public methods
`void`	`addContentView(@NonNull View view, ViewGroup.LayoutParams params)`
`@NonNull Lifecycle`	`getLifecycle()`
`@NonNull NavigationEventDispatcher`	`getNavigationEventDispatcher()` Lazily provides a `NavigationEventDispatcher` for back navigation handling, including support for predictive back gestures introduced in Android 13 (API 33+).
`final @NonNull OnBackPressedDispatcher`	`getOnBackPressedDispatcher()` Retrieve the `OnBackPressedDispatcher` that will be triggered when `onBackPressed` is called.
`@NonNull SavedStateRegistry`	`getSavedStateRegistry()`
`void`	`@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.
`void`	`@CallSuper onBackPressed()`
`@NonNull Bundle`	`onSaveInstanceState()`
`void`	`setContentView(int layoutResID)`
`void`	`setContentView(@NonNull View view)`
`void`	`setContentView(@NonNull View view, ViewGroup.LayoutParams params)`

Protected methods
`void`	`@CallSuper onCreate(Bundle savedInstanceState)`
`void`	`@CallSuper onStart()`
`void`	`@CallSuper onStop()`

Inherited methods

From android.app.Dialog

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

From android.view.Window.Callback

`void`	`onPointerCaptureChanged(boolean p0)`
`void`	`onProvideKeyboardShortcuts( @NonNull List<@NonNull KeyboardShortcutGroup> p0, @Nullable Menu p1, int p2 )`

Public constructors

ComponentDialog

Added in 1.5.0

public ComponentDialog(@NonNull Context context, @StyleRes int themeResId)

Public methods

addContentView

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

getLifecycle

Added in 1.5.0

public @NonNull Lifecycle getLifecycle()

getNavigationEventDispatcher

Added in 1.12.0-alpha01

public @NonNull NavigationEventDispatcher getNavigationEventDispatcher()

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.

getOnBackPressedDispatcher

public final @NonNull OnBackPressedDispatcher getOnBackPressedDispatcher()

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

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

getSavedStateRegistry

Added in 1.7.0

public @NonNull SavedStateRegistry getSavedStateRegistry()

initializeViewTreeOwners

Added in 1.8.0

@CallSuper
public void initializeViewTreeOwners()

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
public void onBackPressed()

onSaveInstanceState

public @NonNull Bundle onSaveInstanceState()

setContentView

public void setContentView(int layoutResID)

setContentView

public void setContentView(@NonNull View view)

setContentView

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

Protected methods

onCreate

@CallSuper
protected void onCreate(Bundle savedInstanceState)

onStart

@CallSuper
protected void onStart()

onStop

@CallSuper
protected void onStop()