PreferenceDialogFragment

Artifact: androidx.preference:preference

View Source

Added in 1.0.0

Deprecated in 1.1.0

---

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

Summary

Constants
static final String	ARG_KEY = "key" This field is deprecated. Use PreferenceDialogFragmentCompat instead

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

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

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

Inherited Constants
From android.content.ComponentCallbacks2 static final int TRIM_MEMORY_BACKGROUND = 40 static final int TRIM_MEMORY_COMPLETE = 80 static final int TRIM_MEMORY_MODERATE = 60 static final int TRIM_MEMORY_RUNNING_CRITICAL = 15 static final int TRIM_MEMORY_RUNNING_LOW = 10 static final int TRIM_MEMORY_RUNNING_MODERATE = 5 static final int TRIM_MEMORY_UI_HIDDEN = 20
From android.app.DialogFragment static final int STYLE_NORMAL = 0 This field is deprecated. static final int STYLE_NO_FRAME = 2 This field is deprecated. static final int STYLE_NO_INPUT = 3 This field is deprecated. static final int STYLE_NO_TITLE = 1 This field is deprecated.

Inherited methods
From android.app.DialogFragment void dismiss() This method is deprecated. void dismissAllowingStateLoss() This method is deprecated. void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) This method is deprecated. Dialog getDialog() This method is deprecated. boolean getShowsDialog() This method is deprecated. int getTheme() This method is deprecated. boolean isCancelable() This method is deprecated. void onActivityCreated(Bundle savedInstanceState) This method is deprecated. void onAttach(Context context) This method is deprecated. void onCancel(DialogInterface dialog) This method is deprecated. void onDestroyView() This method is deprecated. void onDetach() This method is deprecated. LayoutInflater onGetLayoutInflater(Bundle savedInstanceState) This method is deprecated. void onStart() This method is deprecated. void onStop() This method is deprecated. void setCancelable(boolean cancelable) This method is deprecated. void setShowsDialog(boolean showsDialog) This method is deprecated. void setStyle(int style, int theme) This method is deprecated. void show(FragmentManager manager, String tag) This method is deprecated. int show(FragmentTransaction transaction, String tag) This method is deprecated.
From android.app.Fragment final boolean equals(Object o) This method is deprecated. final Activity getActivity() This method is deprecated. boolean getAllowEnterTransitionOverlap() This method is deprecated. boolean getAllowReturnTransitionOverlap() This method is deprecated. final Bundle getArguments() This method is deprecated. final FragmentManager getChildFragmentManager() This method is deprecated. Context getContext() This method is deprecated. Transition getEnterTransition() This method is deprecated. Transition getExitTransition() This method is deprecated. final FragmentManager getFragmentManager() This method is deprecated. final Object getHost() This method is deprecated. final int getId() This method is deprecated. final LayoutInflater getLayoutInflater() This method is deprecated. LoaderManager getLoaderManager() This method is deprecated. final Fragment getParentFragment() This method is deprecated. Transition getReenterTransition() This method is deprecated. final Resources getResources() This method is deprecated. final boolean getRetainInstance() This method is deprecated. Transition getReturnTransition() This method is deprecated. Transition getSharedElementEnterTransition() This method is deprecated. Transition getSharedElementReturnTransition() This method is deprecated. final String getString(int resId) This method is deprecated. final String getTag() This method is deprecated. final Fragment getTargetFragment() This method is deprecated. final int getTargetRequestCode() This method is deprecated. final CharSequence getText(int resId) This method is deprecated. boolean getUserVisibleHint() This method is deprecated. View getView() This method is deprecated. final int hashCode() This method is deprecated. static Fragment instantiate(Context context, String fname) This method is deprecated. final boolean isAdded() This method is deprecated. final boolean isDetached() This method is deprecated. final boolean isHidden() This method is deprecated. final boolean isInLayout() This method is deprecated. final boolean isRemoving() This method is deprecated. final boolean isResumed() This method is deprecated. final boolean isStateSaved() This method is deprecated. final boolean isVisible() This method is deprecated. void onActivityResult(int requestCode, int resultCode, Intent data) This method is deprecated. void onAttachFragment(Fragment childFragment) This method is deprecated. void onConfigurationChanged(Configuration newConfig) This method is deprecated. boolean onContextItemSelected(MenuItem item) This method is deprecated. Animator onCreateAnimator(int transit, boolean enter, int nextAnim) This method is deprecated. void onCreateContextMenu(     ContextMenu menu,     View v,     ContextMenu.ContextMenuInfo menuInfo ) This method is deprecated. void onCreateOptionsMenu(Menu menu, MenuInflater inflater) This method is deprecated. View onCreateView(     LayoutInflater inflater,     ViewGroup container,     Bundle savedInstanceState ) This method is deprecated. void onDestroy() This method is deprecated. void onDestroyOptionsMenu() This method is deprecated. void onHiddenChanged(boolean hidden) This method is deprecated. void onInflate(AttributeSet attrs, Bundle savedInstanceState) This method is deprecated. void onLowMemory() This method is deprecated. void onMultiWindowModeChanged(     boolean isInMultiWindowMode,     Configuration newConfig ) This method is deprecated. boolean onOptionsItemSelected(MenuItem item) This method is deprecated. void onOptionsMenuClosed(Menu menu) This method is deprecated. void onPause() This method is deprecated. void onPictureInPictureModeChanged(     boolean isInPictureInPictureMode,     Configuration newConfig ) This method is deprecated. void onPrepareOptionsMenu(Menu menu) This method is deprecated. void onRequestPermissionsResult(     int requestCode,     String[] permissions,     int[] grantResults ) This method is deprecated. void onResume() This method is deprecated. void onTrimMemory(int level) This method is deprecated. void onViewCreated(View view, Bundle savedInstanceState) This method is deprecated. void onViewStateRestored(Bundle savedInstanceState) This method is deprecated. void postponeEnterTransition() This method is deprecated. void registerForContextMenu(View view) This method is deprecated. final void requestPermissions(String[] permissions, int requestCode) This method is deprecated. void setAllowEnterTransitionOverlap(boolean allow) This method is deprecated. void setAllowReturnTransitionOverlap(boolean allow) This method is deprecated. void setArguments(Bundle args) This method is deprecated. void setEnterSharedElementCallback(SharedElementCallback callback) This method is deprecated. void setEnterTransition(Transition transition) This method is deprecated. void setExitSharedElementCallback(SharedElementCallback callback) This method is deprecated. void setExitTransition(Transition transition) This method is deprecated. void setHasOptionsMenu(boolean hasMenu) This method is deprecated. void setInitialSavedState(Fragment.SavedState state) This method is deprecated. void setMenuVisibility(boolean menuVisible) This method is deprecated. void setReenterTransition(Transition transition) This method is deprecated. void setRetainInstance(boolean retain) This method is deprecated. void setReturnTransition(Transition transition) This method is deprecated. void setSharedElementEnterTransition(Transition transition) This method is deprecated. void setSharedElementReturnTransition(Transition transition) This method is deprecated. void setTargetFragment(Fragment fragment, int requestCode) This method is deprecated. void setUserVisibleHint(boolean isVisibleToUser) This method is deprecated. boolean shouldShowRequestPermissionRationale(String permission) This method is deprecated. void startActivity(Intent intent) This method is deprecated. void startActivityForResult(Intent intent, int requestCode) This method is deprecated. void startIntentSenderForResult(     IntentSender intent,     int requestCode,     Intent fillInIntent,     int flagsMask,     int flagsValues,     int extraFlags,     Bundle options ) This method is deprecated. void startPostponedEnterTransition() This method is deprecated. String toString() This method is deprecated. void unregisterForContextMenu(View view) This method is deprecated.

Constants

ARG_KEY

Added in 1.0.0

Deprecated in 1.1.0

protected static final String ARG_KEY = "key"

This field is deprecated.

Use PreferenceDialogFragmentCompat instead

Public constructors

PreferenceDialogFragment

Added in 1.0.0

Deprecated in 1.1.0

public PreferenceDialogFragment()

This method is deprecated.

Use PreferenceDialogFragmentCompat instead

Public methods

getPreference

Added in 1.0.0

Deprecated in 1.1.0

public DialogPreference getPreference()

This method is deprecated.

Use PreferenceDialogFragmentCompat instead

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

Returns
DialogPreference	The DialogPreference associated with this dialog

onClick

Added in 1.0.0

Deprecated in 1.1.0

public void onClick(@NonNull DialogInterface dialog, int which)

This method is deprecated.

Use PreferenceDialogFragmentCompat instead

onCreate

Added in 1.0.0

Deprecated in 1.1.0

public void onCreate(@Nullable Bundle savedInstanceState)

This method is deprecated.

onCreateDialog

Added in 1.0.0

Deprecated in 1.1.0

public @NonNull Dialog onCreateDialog(@Nullable Bundle savedInstanceState)

This method is deprecated.

onDialogClosed

Added in 1.0.0

Deprecated in 1.1.0

public abstract void onDialogClosed(boolean positiveResult)

This method is deprecated.

Use PreferenceDialogFragmentCompat instead

onDismiss

Added in 1.0.0

Deprecated in 1.1.0

public void onDismiss(@NonNull DialogInterface dialog)

This method is deprecated.

onSaveInstanceState

Added in 1.0.0

Deprecated in 1.1.0

public void onSaveInstanceState(@NonNull Bundle outState)

This method is deprecated.

Protected methods

onBindDialogView

Added in 1.0.0

Deprecated in 1.1.0

protected void onBindDialogView(@NonNull 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
@NonNull View view	The content view of the dialog, if it is custom

onCreateDialogView

Added in 1.0.0

Deprecated in 1.1.0

protected @Nullable View onCreateDialogView(@NonNull 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.

Returns
@Nullable View	The content view for the dialog

See also
setLayoutResource

onPrepareDialogBuilder

Added in 1.0.0

Deprecated in 1.1.0

protected void onPrepareDialogBuilder(@NonNull 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 create or show.