PreferenceDialogFragment

Kotlin |Java

public abstract class PreferenceDialogFragment
extends DialogFragment implements DialogInterface.OnClickListener

java.lang.Object
↳	android.app.Fragment
	↳	android.app.DialogFragment
		↳	androidx.preference.PreferenceDialogFragment

Known direct subclasses

EditTextPreferenceDialogFragment, ListPreferenceDialogFragment, MultiSelectListPreferenceDialogFragment

EditTextPreferenceDialogFragment	This class is deprecated. Use `EditTextPreferenceDialogFragmentCompat` instead
ListPreferenceDialogFragment	This class is deprecated. Use `ListPreferenceDialogFragmentCompat` instead
MultiSelectListPreferenceDialogFragment	This class is deprecated. Use `MultiSelectListPreferenceDialogFragmentCompat` instead

This class is deprecated.
Use PreferenceDialogFragmentCompat instead

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(Bundle) and saved/restored in the saved instance state. Custom subclasses should also follow this pattern.

Summary

Constants
`String`	`ARG_KEY` This constant is deprecated. Use `PreferenceDialogFragmentCompat` instead

Inherited constants

From class android.app.DialogFragment

`int`	`STYLE_NORMAL`
`int`	`STYLE_NO_FRAME`
`int`	`STYLE_NO_INPUT`
`int`	`STYLE_NO_TITLE`

From interface android.content.ComponentCallbacks2

`int`	`TRIM_MEMORY_BACKGROUND`
`int`	`TRIM_MEMORY_COMPLETE`
`int`	`TRIM_MEMORY_MODERATE`
`int`	`TRIM_MEMORY_RUNNING_CRITICAL`
`int`	`TRIM_MEMORY_RUNNING_LOW`
`int`	`TRIM_MEMORY_RUNNING_MODERATE`
`int`	`TRIM_MEMORY_UI_HIDDEN`

Public constructors
`PreferenceDialogFragment()` This constructor is deprecated. Use `PreferenceDialogFragmentCompat` instead

Public methods
`DialogPreference`	`getPreference()` This method is deprecated. Use `PreferenceDialogFragmentCompat` instead
`void`	`onClick(DialogInterface dialog, int which)` This method is deprecated. Use `PreferenceDialogFragmentCompat` instead
`void`	`onCreate(Bundle savedInstanceState)`
`Dialog`	`onCreateDialog(Bundle savedInstanceState)`
`abstract void`	`onDialogClosed(boolean positiveResult)` This method is deprecated. Use `PreferenceDialogFragmentCompat` instead
`void`	`onDismiss(DialogInterface dialog)`
`void`	`onSaveInstanceState(Bundle outState)`

Protected methods
`void`	`onBindDialogView(View view)` This method is deprecated. Use `PreferenceDialogFragmentCompat` instead
`View`	`onCreateDialogView(Context context)` This method is deprecated. Use `PreferenceDialogFragmentCompat` instead
`void`	`onPrepareDialogBuilder(AlertDialog.Builder builder)` This method is deprecated. Use `PreferenceDialogFragmentCompat` instead

Inherited methods

From class


        
          android.app.DialogFragment

`void`	`dismiss()`
`void`	`dismissAllowingStateLoss()`
`void`	`dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)`
`Dialog`	`getDialog()`
`boolean`	`getShowsDialog()`
`int`	`getTheme()`
`boolean`	`isCancelable()`
`void`	`onActivityCreated(Bundle arg0)`
`void`	`onAttach(Context arg0)`
`void`	`onCancel(DialogInterface arg0)`
`void`	`onCreate(Bundle arg0)`
`Dialog`	`onCreateDialog(Bundle arg0)`
`void`	`onDestroyView()`
`void`	`onDetach()`
`void`	`onDismiss(DialogInterface arg0)`
`LayoutInflater`	`onGetLayoutInflater(Bundle arg0)`
`void`	`onSaveInstanceState(Bundle arg0)`
`void`	`onStart()`
`void`	`onStop()`
`void`	`setCancelable(boolean arg0)`
`void`	`setShowsDialog(boolean arg0)`
`void`	`setStyle(int arg0, int arg1)`
`void`	`show(FragmentManager arg0, String arg1)`
`int`	`show(FragmentTransaction arg0, String arg1)`

From class


        
          android.app.Fragment

`void`	`dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)`
`final boolean`	`equals(Object arg0)`
`final Activity`	`getActivity()`
`boolean`	`getAllowEnterTransitionOverlap()`
`boolean`	`getAllowReturnTransitionOverlap()`
`final Bundle`	`getArguments()`
`final FragmentManager`	`getChildFragmentManager()`
`Context`	`getContext()`
`Transition`	`getEnterTransition()`
`Transition`	`getExitTransition()`
`final FragmentManager`	`getFragmentManager()`
`final Object`	`getHost()`
`final int`	`getId()`
`final LayoutInflater`	`getLayoutInflater()`
`LoaderManager`	`getLoaderManager()`
`final Fragment`	`getParentFragment()`
`Transition`	`getReenterTransition()`
`final Resources`	`getResources()`
`final boolean`	`getRetainInstance()`
`Transition`	`getReturnTransition()`
`Transition`	`getSharedElementEnterTransition()`
`Transition`	`getSharedElementReturnTransition()`
`final String`	`getString(int arg0, Object... arg1)`
`final String`	`getString(int arg0)`
`final String`	`getTag()`
`final Fragment`	`getTargetFragment()`
`final int`	`getTargetRequestCode()`
`final CharSequence`	`getText(int arg0)`
`boolean`	`getUserVisibleHint()`
`View`	`getView()`
`final int`	`hashCode()`
`static Fragment`	`instantiate(Context arg0, String arg1)`
`static Fragment`	`instantiate(Context arg0, String arg1, Bundle arg2)`
`final boolean`	`isAdded()`
`final boolean`	`isDetached()`
`final boolean`	`isHidden()`
`final boolean`	`isInLayout()`
`final boolean`	`isRemoving()`
`final boolean`	`isResumed()`
`final boolean`	`isStateSaved()`
`final boolean`	`isVisible()`
`void`	`onActivityCreated(Bundle arg0)`
`void`	`onActivityResult(int arg0, int arg1, Intent arg2)`
`void`	`onAttach(Activity arg0)`
`void`	`onAttach(Context arg0)`
`void`	`onAttachFragment(Fragment arg0)`
`void`	`onConfigurationChanged(Configuration arg0)`
`boolean`	`onContextItemSelected(MenuItem arg0)`
`void`	`onCreate(Bundle arg0)`
`Animator`	`onCreateAnimator(int arg0, boolean arg1, int arg2)`
`void`	`onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)`
`void`	`onCreateOptionsMenu(Menu arg0, MenuInflater arg1)`
`View`	`onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2)`
`void`	`onDestroy()`
`void`	`onDestroyOptionsMenu()`
`void`	`onDestroyView()`
`void`	`onDetach()`
`LayoutInflater`	`onGetLayoutInflater(Bundle arg0)`
`void`	`onHiddenChanged(boolean arg0)`
`void`	`onInflate(AttributeSet arg0, Bundle arg1)`
`void`	`onInflate(Activity arg0, AttributeSet arg1, Bundle arg2)`
`void`	`onInflate(Context arg0, AttributeSet arg1, Bundle arg2)`
`void`	`onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean arg0)`
`void`	`onMultiWindowModeChanged(boolean arg0, Configuration arg1)`
`boolean`	`onOptionsItemSelected(MenuItem arg0)`
`void`	`onOptionsMenuClosed(Menu arg0)`
`void`	`onPause()`
`void`	`onPictureInPictureModeChanged(boolean arg0, Configuration arg1)`
`void`	`onPictureInPictureModeChanged(boolean arg0)`
`void`	`onPrepareOptionsMenu(Menu arg0)`
`void`	`onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2)`
`void`	`onResume()`
`void`	`onSaveInstanceState(Bundle arg0)`
`void`	`onStart()`
`void`	`onStop()`
`void`	`onTrimMemory(int arg0)`
`void`	`onViewCreated(View arg0, Bundle arg1)`
`void`	`onViewStateRestored(Bundle arg0)`
`void`	`postponeEnterTransition()`
`void`	`registerForContextMenu(View arg0)`
`final void`	`requestPermissions(String[] arg0, int arg1)`
`void`	`setAllowEnterTransitionOverlap(boolean arg0)`
`void`	`setAllowReturnTransitionOverlap(boolean arg0)`
`void`	`setArguments(Bundle arg0)`
`void`	`setEnterSharedElementCallback(SharedElementCallback arg0)`
`void`	`setEnterTransition(Transition arg0)`
`void`	`setExitSharedElementCallback(SharedElementCallback arg0)`
`void`	`setExitTransition(Transition arg0)`
`void`	`setHasOptionsMenu(boolean arg0)`
`void`	`setInitialSavedState(Fragment.SavedState arg0)`
`void`	`setMenuVisibility(boolean arg0)`
`void`	`setReenterTransition(Transition arg0)`
`void`	`setRetainInstance(boolean arg0)`
`void`	`setReturnTransition(Transition arg0)`
`void`	`setSharedElementEnterTransition(Transition arg0)`
`void`	`setSharedElementReturnTransition(Transition arg0)`
`void`	`setTargetFragment(Fragment arg0, int arg1)`
`void`	`setUserVisibleHint(boolean arg0)`
`boolean`	`shouldShowRequestPermissionRationale(String arg0)`
`void`	`startActivity(Intent arg0)`
`void`	`startActivity(Intent arg0, Bundle arg1)`
`void`	`startActivityForResult(Intent arg0, int arg1)`
`void`	`startActivityForResult(Intent arg0, int arg1, Bundle arg2)`
`void`	`startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6)`
`void`	`startPostponedEnterTransition()`
`String`	`toString()`
`void`	`unregisterForContextMenu(View arg0)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          android.content.DialogInterface.OnCancelListener

abstract void onCancel(DialogInterface arg0)

From interface


        
          android.content.DialogInterface.OnDismissListener

abstract void onDismiss(DialogInterface arg0)

From interface


        
          android.content.ComponentCallbacks2

abstract void onTrimMemory(int arg0)

From interface


        
          android.view.View.OnCreateContextMenuListener

abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)

From interface


        
          android.content.DialogInterface.OnClickListener

abstract void onClick(DialogInterface arg0, int arg1)

From interface


        
          android.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration arg0)`
`abstract void`	`onLowMemory()`

Constants

ARG_KEY

protected static final String ARG_KEY

This constant is deprecated.
Use PreferenceDialogFragmentCompat instead

Constant Value: "key"

Public constructors

PreferenceDialogFragment

public PreferenceDialogFragment ()

This constructor is deprecated.
Use PreferenceDialogFragmentCompat instead

Public methods

getPreference

public DialogPreference getPreference ()

This method is deprecated.
Use PreferenceDialogFragmentCompat instead

Get the preference that requested this dialog. Available after onCreate(Bundle) has been called on the PreferenceFragment which launched this dialog.

Returns
`DialogPreference`	The `DialogPreference` associated with this dialog

onClick

public void onClick (DialogInterface dialog, 
                int which)

This method is deprecated.
Use PreferenceDialogFragmentCompat instead

Parameters
`dialog`	`DialogInterface`
`which`	`int`

onCreate

public void onCreate (Bundle savedInstanceState)

Parameters
`savedInstanceState`	`Bundle`

onCreateDialog

public Dialog onCreateDialog (Bundle savedInstanceState)

Parameters
`savedInstanceState`	`Bundle`

Returns
`Dialog`

onDialogClosed

public abstract void onDialogClosed (boolean positiveResult)

This method is deprecated.
Use PreferenceDialogFragmentCompat instead

Parameters
`positiveResult`	`boolean`

onDismiss

public void onDismiss (DialogInterface dialog)

Parameters
`dialog`	`DialogInterface`

onSaveInstanceState

public void onSaveInstanceState (Bundle outState)

Parameters
`outState`	`Bundle`

Protected methods

onBindDialogView

protected void onBindDialogView (View view)

This method is deprecated.
Use PreferenceDialogFragmentCompat instead

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

protected View onCreateDialogView (Context context)

This method is deprecated.
Use PreferenceDialogFragmentCompat instead

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.

Parameters
`context`	`Context`

Returns
`View`	The content view for the dialog

See also:

Preference.setLayoutResource(int)

onPrepareDialogBuilder

protected void onPrepareDialogBuilder (AlertDialog.Builder builder)

This method is deprecated.
Use PreferenceDialogFragmentCompat instead

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

Do not AlertDialog.Builder.create() or AlertDialog.Builder.show().

Parameters
`builder`	`AlertDialog.Builder`