AppCompatDialogFragment

Added in 1.1.0

Kotlin |Java

public class AppCompatDialogFragment extends DialogFragment

java.lang.Object
↳	androidx.fragment.app.Fragment
	↳	androidx.fragment.app.DialogFragment
		↳	androidx.appcompat.app.AppCompatDialogFragment

A special version of DialogFragment which uses an AppCompatDialog in place of a platform-styled dialog.

See also
`DialogFragment`

Summary

Public constructors
`AppCompatDialogFragment()`
`AppCompatDialogFragment(@LayoutRes int contentLayoutId)`

Public methods
`@NonNull Dialog`	`onCreateDialog(@Nullable Bundle savedInstanceState)` Override to build your own custom Dialog container.

Inherited Constants

From androidx.fragment.app.DialogFragment

`static final int`	`STYLE_NORMAL = 0` Style for `setStyle`: a basic, normal dialog.
`static final int`	`STYLE_NO_FRAME = 2` Style for `setStyle`: don't draw any frame at all; the view hierarchy returned by `onCreateView` is entirely responsible for drawing the dialog.
`static final int`	`STYLE_NO_INPUT = 3` Style for `setStyle`: like `STYLE_NO_FRAME`, but also disables all input to the dialog.
`static final int`	`STYLE_NO_TITLE = 1` Style for `setStyle`: don't include a title area.

Inherited methods

Returns whether the the return transition and reenter transition overlap or not.

Return a private FragmentManager for placing and managing Fragments inside of this Fragment.

Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.

This has been removed in favor of getParentFragmentManager() which throws an IllegalStateException if the FragmentManager is null.

Return the FragmentManager for interacting with fragments associated with this fragment's activity.

Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.

Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.

Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.

Returns the Transition that will be used for shared elements transferred into the content Scene.

Return the Transition that will be used for shared elements transferred back during a pop of the back stack.

Return a localized string from the application's package's default string table.

Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter and format.

Return a localized, styled CharSequence from the application's package's default string table.

Get the root view for the fragment's layout (the one returned by onCreateView), if provided.

Returns true if this fragment is added and its state has already been saved by its host.

This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an ActivityResultContract and the prebuilt contracts for common intents available in androidx.activity.result.contract.ActivityResultContracts, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.

The responsibility for listening for fragments being attached has been moved to FragmentManager.

androidx.activity.ComponentActivity now implements MenuHost, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.

Called when the hidden state (as returned by isHidden of the fragment or another fragment in its hierarchy has changed.

Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.

Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.

Called by the system when the activity changes to and from picture-in-picture mode.

Called immediately after onCreateView has returned, but before any saved state has been restored in to the view.

Registers a context menu to be shown for the given view (multiple views can show the context menu).

This has been renamed to getParentFragmentManager() to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.

Get the root view for the fragment's layout (the one returned by onCreateView).

When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.

When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.

Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.

This method is no longer needed when using a MenuProvider to provide a Menu to your activity, which replaces onCreateOptionsMenu as the recommended way to provide a consistent, optionally Lifecycle-aware, and modular way to handle menu creation and item selection.

Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.

Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.

Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.

Sets the Transition that will be used for shared elements transferred into the content Scene.

Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.

`abstract void`	`onConfigurationChanged(Configuration p)`
`abstract void`	`onLowMemory()` This method is deprecated.

`void`	`dismiss()` Dismiss the fragment and its dialog.
`void`	`dismissAllowingStateLoss()` Version of `dismiss` that uses `FragmentTransaction.commitAllowingStateLoss()`.
`void`	`@MainThread dismissNow()` Version of `dismiss` that uses `commitNow`.
`@Nullable Dialog`	`getDialog()` Return the `Dialog` this fragment is currently controlling.
`boolean`	`getShowsDialog()` Return the current value of `setShowsDialog`.
`@StyleRes int`	`getTheme()`
`boolean`	`isCancelable()` Return the current value of `setCancelable`.
`void`	`@MainThread onActivityCreated(@Nullable Bundle savedInstanceState)` This method is deprecated. use `onCreateDialog` for code touching the dialog created by `onCreateDialog`, `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`void`	`@MainThread onAttach(@NonNull Context context)` Called when a fragment is first attached to its context.
`void`	`onCancel(@NonNull DialogInterface dialog)`
`void`	`@MainThread onCreate(@Nullable Bundle savedInstanceState)` Called to do initial creation of a fragment.
`void`	`@MainThread onDestroyView()` Remove dialog.
`void`	`@MainThread onDetach()` Called when the fragment is no longer attached to its activity.
`void`	`@CallSuper onDismiss(@NonNull DialogInterface dialog)`
`@NonNull LayoutInflater`	`onGetLayoutInflater(@Nullable Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`@MainThread onSaveInstanceState(@NonNull Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
`void`	`@MainThread onStart()` Called when the Fragment is visible to the user.
`void`	`@MainThread onStop()` Called when the Fragment is no longer started.
`void`	`@MainThread onViewStateRestored(@Nullable Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`final @NonNull ComponentDialog`	`requireComponentDialog()` Return the `ComponentDialog` this fragment is currently controlling.
`final @NonNull Dialog`	`requireDialog()` Return the `Dialog` this fragment is currently controlling.
`void`	`setCancelable(boolean cancelable)` Control whether the shown Dialog is cancelable.
`void`	`setShowsDialog(boolean showsDialog)` Controls whether this fragment should be shown in a dialog.
`void`	`setStyle(int style, @StyleRes int theme)` Call to customize the basic appearance and behavior of the fragment's dialog.
`void`	`show(@NonNull FragmentManager manager, @Nullable String tag)` Display the dialog, adding the fragment to the given FragmentManager.
`int`	`show(@NonNull FragmentTransaction transaction, @Nullable String tag)` Display the dialog, adding the fragment using an existing transaction and then `committing` the transaction.
`void`	`showNow(@NonNull FragmentManager manager, @Nullable String tag)` Display the dialog, immediately adding the fragment to the given FragmentManager.

`CreationExtras`	`getDefaultViewModelCreationExtras()` Returns the default `CreationExtras` that should be passed into `ViewModelProvider.Factory.create` when no overriding `CreationExtras` were passed to the `ViewModelProvider` constructors.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors.

AppCompatDialogFragment

Summary

Public constructors

Public methods

Inherited Constants

Inherited methods

Public constructors