PreferenceDialogFragmentCompat

abstract class PreferenceDialogFragmentCompat : DialogFragment, DialogInterface.OnClickListener

kotlin.Any
   ↳ androidx.fragment.app.Fragment
     ↳ androidx.fragment.app.DialogFragment
       ↳ androidx.preference.PreferenceDialogFragmentCompat
Known direct subclasses

Abstract base class which presents a dialog associated with a DialogPreference. Since the preference object may not be available during fragment re-creation, the necessary information for displaying the dialog is read once during the initial call to onCreate and saved/restored in the saved instance state. Custom subclasses should also follow this pattern.

Summary

Constants
const String!
ARG_KEY = "key"

Public constructors

Public functions
DialogPreference!

Get the preference that requested this dialog.
Unit
onClick(dialog: DialogInterface, which: Int)
Unit
onCreate(savedInstanceState: Bundle?)

Called to do initial creation of a fragment.
Dialog
onCreateDialog(savedInstanceState: Bundle?)

Override to build your own custom Dialog container.
abstract Unit
onDialogClosed(positiveResult: Boolean)
Unit
Unit

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.

Protected functions
Unit

Binds views in the content view of the dialog to data.
View?

Creates the content view for the dialog (if a custom content view is required).
Unit

Prepares the dialog builder to be shown when the preference is clicked.

Inherited Constants
From androidx.fragment.app.DialogFragment
const Int

Style for setStyle: a basic, normal dialog.
const Int

Style for setStyle: don't draw any frame at all; the view hierarchy returned by onCreateView is entirely responsible for drawing the dialog.
const Int

Style for setStyle: like STYLE_NO_FRAME, but also disables all input to the dialog.
const Int

Style for setStyle: don't include a title area.

Inherited functions
From androidx.activity.result.ActivityResultCaller
abstract ActivityResultLauncher<I!>!
<I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>!,
    callback: ActivityResultCallback<O!>!
)

Register a request to start an activity for result, designated by the given contract.
From android.content.ComponentCallbacks
abstract Unit
abstract Unit
From androidx.fragment.app.DialogFragment
Unit

Dismiss the fragment and its dialog.
Unit

Version of dismiss that uses FragmentTransaction.commitAllowingStateLoss().
Unit

Version of dismiss that uses commitNow.
Dialog?

Return the Dialog this fragment is currently controlling.
Boolean

Return the current value of setShowsDialog.
@StyleRes Int
Boolean

Return the current value of setCancelable.
Unit
@MainThread
onActivityCreated(savedInstanceState: Bundle?)

This function 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.
Unit

Called when a fragment is first attached to its context.
Unit
Unit

Remove dialog.
Unit

Called when the fragment is no longer attached to its activity.
LayoutInflater
onGetLayoutInflater(savedInstanceState: Bundle?)

Returns the LayoutInflater used to inflate Views of this Fragment.
Unit

Called when the Fragment is visible to the user.
Unit

Called when the Fragment is no longer started.
Unit
@MainThread
onViewStateRestored(savedInstanceState: Bundle?)

Called when all saved state has been restored into the view hierarchy of the fragment.
ComponentDialog

Return the ComponentDialog this fragment is currently controlling.
Dialog

Return the Dialog this fragment is currently controlling.
Unit
setCancelable(cancelable: Boolean)

Control whether the shown Dialog is cancelable.
Unit
setShowsDialog(showsDialog: Boolean)

Controls whether this fragment should be shown in a dialog.
Unit
setStyle(style: Int, theme: @StyleRes Int)

Call to customize the basic appearance and behavior of the fragment's dialog.
Unit
show(manager: FragmentManager, tag: String?)

Display the dialog, adding the fragment to the given FragmentManager.
Int
show(transaction: FragmentTransaction, tag: String?)

Display the dialog, adding the fragment using an existing transaction and then committing the transaction.
Unit
showNow(manager: FragmentManager, tag: String?)

Display the dialog, immediately adding the fragment to the given FragmentManager.
From android.content.DialogInterface.OnCancelListener
abstract Unit
From android.content.DialogInterface.OnDismissListener
abstract Unit
From androidx.fragment.app.Fragment
Unit
dump(
    prefix: String,
    fd: FileDescriptor?,
    writer: PrintWriter,
    args: Array<String!>?
)

Print the Fragments's state into the given stream.
Boolean
equals(o: Any?)

Subclasses can not override equals().
FragmentActivity?

Return the FragmentActivity this fragment is currently associated with.
Boolean

Returns whether the the exit transition and enter transition overlap or not.
Boolean

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

Return the arguments supplied when the fragment was instantiated, if any.
FragmentManager

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

Return the Context this fragment is currently associated with.
CreationExtras

The Fragment's arguments when this is first called will be used as the defaults to any androidx.lifecycle.SavedStateHandle passed to a view model created using this extra.
ViewModelProvider.Factory
Any?

Returns the Transition that will be used to move Views into the initial scene.
Any?

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.
FragmentManager?

This function is deprecated.

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

Return the host object of this fragment.
Int

Return the identifier this fragment is known by.
LayoutInflater

Returns the cached LayoutInflater used to inflate Views of this Fragment.
Lifecycle

Overriding this method is no longer supported and this method will be made final in a future version of Fragment.
LoaderManager

This function is deprecated.

Use LoaderManager.getInstance(this).
Fragment?

Returns the parent Fragment containing this Fragment.
FragmentManager

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

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

Return requireActivity().getResources().
Boolean

This function is deprecated.

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

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.
SavedStateRegistry
Any?

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

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

Return a localized string from the application's package's default string table.
String
getString(resId: @StringRes Int, formatArgs: Array<Any!>?)

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.
String?

Get the tag name of the fragment, if specified.
Fragment?

This function is deprecated.

Instead of using a target fragment to pass results, use setFragmentResult to deliver results to FragmentResultListener instances registered by other fragments via setFragmentResultListener.
Int

This function is deprecated.

When using the target fragment replacement of setFragmentResultListener and setFragmentResult, consider using setArguments to pass a requestKey if you need to support dynamic request keys.
CharSequence

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

This function is deprecated.

Use setMaxLifecycle instead.
View?

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

Get a LifecycleOwner that represents the Fragment's View lifecycle.
LiveData<LifecycleOwner!>

Retrieve a LiveData which allows you to observe the lifecycle of the Fragment's View.
ViewModelStore

Returns the ViewModelStore associated with this Fragment

Int

Subclasses can not override hashCode().
java-static Fragment
instantiate(context: Context, fname: String)

This function is deprecated.

Use getFragmentFactory and instantiate
java-static Fragment
instantiate(context: Context, fname: String, args: Bundle?)

This function is deprecated.

Use getFragmentFactory and instantiate, manually calling setArguments on the returned Fragment.
Boolean

Return true if the fragment is currently added to its activity.
Boolean

Return true if the fragment has been explicitly detached from the UI.
Boolean

Return true if the fragment has been hidden.
Boolean

Return true if the layout is included as part of an activity view hierarchy via the tag.
Boolean

Return true if this fragment is currently being removed from its activity.
Boolean

Return true if the fragment is in the resumed state.
Boolean

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

Return true if the fragment is currently visible to the user.
Unit
onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)

This function is deprecated.

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

This function is deprecated.

See onAttach.
Unit

This function is deprecated.

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

This hook is called whenever an item in a context menu is selected.
Animation?
@MainThread
onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)

Called when a fragment loads an animation.
Animator?
@MainThread
onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)

Called when a fragment loads an animator.
Unit
@MainThread
onCreateContextMenu(
    menu: ContextMenu,
    v: View,
    menuInfo: ContextMenu.ContextMenuInfo?
)

Called when a context menu for the view is about to be shown.
Unit

This function is deprecated.

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.
View?
@MainThread
onCreateView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
)

Called to have the fragment instantiate its user interface view.
Unit

Called when the fragment is no longer in use.
Unit

This function is deprecated.

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

Called when the hidden state (as returned by isHidden of the fragment or another fragment in its hierarchy has changed.
Unit
@UiThread
@CallSuper
onInflate(
    activity: Activity,
    attrs: AttributeSet,
    savedInstanceState: Bundle?
)

This function is deprecated.

See onInflate.
Unit
@UiThread
@CallSuper
onInflate(
    context: Context,
    attrs: AttributeSet,
    savedInstanceState: Bundle?
)

Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
Unit
Unit
onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

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

This function is deprecated.

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

This function is deprecated.

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

Called when the Fragment is no longer resumed.
Unit
onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

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

This function is deprecated.

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.
Unit
@MainThread
onPrimaryNavigationFragmentChanged(
    isPrimaryNavigationFragment: Boolean
)

Callback for when the primary navigation state of this Fragment has changed.
Unit
onRequestPermissionsResult(
    requestCode: Int,
    permissions: Array<String!>,
    grantResults: IntArray
)

This function is deprecated.

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

Called when the fragment is visible to the user and actively running.
Unit
@MainThread
onViewCreated(view: View, savedInstanceState: Bundle?)

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

Postpone the entering Fragment transition until startPostponedEnterTransition or executePendingTransactions has been called.
Unit
postponeEnterTransition(duration: Long, timeUnit: TimeUnit)

Postpone the entering Fragment transition for a given amount of time and then call startPostponedEnterTransition.
ActivityResultLauncher<I!>
@MainThread
<I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>,
    callback: ActivityResultCallback<O!>
)

Register a request to start an activity for result, designated by the given contract.
ActivityResultLauncher<I!>
@MainThread
<I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>,
    registry: ActivityResultRegistry,
    callback: ActivityResultCallback<O!>
)

Register a request to start an activity for result, designated by the given contract.
Unit

Registers a context menu to be shown for the given view (multiple views can show the context menu).
Unit
requestPermissions(permissions: Array<String!>, requestCode: Int)

This function is deprecated.

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

Return the FragmentActivity this fragment is currently associated with.
Bundle

Return the arguments supplied when the fragment was instantiated.
Context

Return the Context this fragment is currently associated with.
FragmentManager

This function is deprecated.

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

Return the host object of this fragment.
Fragment

Returns the parent Fragment containing this Fragment.
View

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

Sets whether the the exit transition and enter transition overlap or not.
Unit

Sets whether the the return transition and reenter transition overlap or not.
Unit

Supply the construction arguments for this fragment.
Unit

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.
Unit
setEnterTransition(transition: Any?)

Sets the Transition that will be used to move Views into the initial scene.
Unit

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.
Unit
setExitTransition(transition: Any?)

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

This function is deprecated.

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

Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by FragmentManager.saveFragmentInstanceState.
Unit
setMenuVisibility(menuVisible: Boolean)

Set a hint for whether this fragment's menu should be visible.
Unit
setReenterTransition(transition: Any?)

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

This function is deprecated.

Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
Unit
setReturnTransition(transition: Any?)

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

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

Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
Unit
setTargetFragment(fragment: Fragment?, requestCode: Int)

This function is deprecated.

Instead of using a target fragment to pass results, the fragment requesting a result should use setFragmentResultListener to register a FragmentResultListener with a requestKey using its parent fragment manager.
Unit
setUserVisibleHint(isVisibleToUser: Boolean)

This function is deprecated.

If you are manually calling this method, use setMaxLifecycle instead.
Boolean

Gets whether you should show UI with rationale before requesting a permission.
Unit

Call startActivity from the fragment's containing Activity.
Unit
startActivity(intent: Intent, options: Bundle?)

Call startActivity from the fragment's containing Activity.
Unit
startActivityForResult(intent: Intent, requestCode: Int)

This function is deprecated.

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.
Unit
startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)

This function is deprecated.

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.
Unit
startIntentSenderForResult(
    intent: IntentSender,
    requestCode: Int,
    fillInIntent: Intent?,
    flagsMask: Int,
    flagsValues: Int,
    extraFlags: Int,
    options: Bundle?
)

This function is deprecated.

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

Begin postponed transitions after postponeEnterTransition was called.
String
Unit

Prevents a context menu to be shown for the given view.
From androidx.lifecycle.HasDefaultViewModelProviderFactory
CreationExtras!
abstract ViewModelProvider.Factory!
From androidx.lifecycle.LifecycleOwner
abstract Lifecycle!
From androidx.savedstate.SavedStateRegistryOwner
abstract SavedStateRegistry!
From android.view.View.OnCreateContextMenuListener
abstract Unit
onCreateContextMenu(
    p: ContextMenu!,
    p1: View!,
    p2: ContextMenu.ContextMenuInfo!
)
From androidx.lifecycle.ViewModelStoreOwner
abstract ViewModelStore!

Constants

ARG_KEY

Added in 1.0.0
protected const val ARG_KEY = "key": String!

Public constructors

PreferenceDialogFragmentCompat

Added in 1.0.0
PreferenceDialogFragmentCompat()

Public functions

getPreference

Added in 1.0.0
fun getPreference(): DialogPreference!

Get the preference that requested this dialog. Available after onCreate has been called on the PreferenceFragmentCompat which launched this dialog.

Returns
DialogPreference!

The DialogPreference associated with this dialog

onClick

Added in 1.0.0
fun onClick(dialog: DialogInterface, which: Int): Unit

onCreate

fun onCreate(savedInstanceState: Bundle?): Unit

Called to do initial creation of a fragment. This is called after onAttach and before onCreateView.

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, add a androidx.lifecycle.LifecycleObserver on the activity's Lifecycle, removing it when it receives the CREATED callback.

Any restored child fragments will be created before the base Fragment.onCreate method returns.

Parameters
savedInstanceState: Bundle?

If the fragment is being re-created from a previous saved state, this is the state.

onCreateDialog

fun onCreateDialog(savedInstanceState: Bundle?): Dialog

Override to build your own custom Dialog container. This is typically used to show an AlertDialog instead of a generic Dialog; when doing so, onCreateView does not need to be implemented since the AlertDialog takes care of its own content.

This method will be called after onCreate and immediately before onCreateView. The default implementation simply instantiates and returns a Dialog class.

Note: DialogFragment own the Dialog.setOnCancelListener and Dialog.setOnDismissListener callbacks. You must not set them yourself. To find out about these events, override onCancel and onDismiss.

Parameters
savedInstanceState: Bundle?

The last saved instance state of the Fragment, or null if this is a freshly created Fragment.
Returns
Dialog

Return a new Dialog instance to be displayed by the Fragment.

onDialogClosed

Added in 1.0.0
abstract fun onDialogClosed(positiveResult: Boolean): Unit

onDismiss

fun onDismiss(dialog: DialogInterface): Unit

onSaveInstanceState

fun onSaveInstanceState(outState: Bundle): Unit

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. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to onCreate, onCreateView, and onViewCreated.

This corresponds to Activity.onSaveInstanceState(Bundle) and most of the discussion there applies here as well. Note however: this method may be called at any time before onDestroy. There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

Parameters
outState: Bundle

Bundle in which to place your saved state.

Protected functions

onBindDialogView

Added in 1.0.0
protected fun onBindDialogView(view: View): Unit

Binds views in the content view of the dialog to data.

Make sure to call through to the superclass implementation.

Parameters
view: View

The content view of the dialog, if it is custom

onCreateDialogView

Added in 1.0.0
protected fun onCreateDialogView(context: Context): View?

Creates the content view for the dialog (if a custom content view is required). By default, it inflates the dialog layout resource if it is set.

Returns
View?

The content view for the dialog
See also
setLayoutResource

onPrepareDialogBuilder

Added in 1.0.0
protected fun onPrepareDialogBuilder(builder: AlertDialog.Builder): Unit

Prepares the dialog builder to be shown when the preference is clicked. Use this to set custom properties on the dialog.

Do not create or show.