PreferenceDialogFragment

Artifact: androidx.preference:preference

View Source

Added in 1.0.0

Deprecated in 1.1.0

---

Kotlin |Java

abstract class PreferenceDialogFragment : DialogFragment, DialogInterface.OnClickListener

kotlin.Any
↳	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
const String!	ARG_KEY = "key" This property is deprecated. Use PreferenceDialogFragmentCompat instead

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

Public functions
DialogPreference!	getPreference() This function is deprecated. Use PreferenceDialogFragmentCompat instead
Unit	onClick(dialog: DialogInterface, which: Int) This function is deprecated. Use PreferenceDialogFragmentCompat instead
Unit	onCreate(savedInstanceState: Bundle?) This function is deprecated.
Dialog	onCreateDialog(savedInstanceState: Bundle?) This function is deprecated.
abstract Unit	onDialogClosed(positiveResult: Boolean) This function is deprecated. Use PreferenceDialogFragmentCompat instead
Unit	onDismiss(dialog: DialogInterface) This function is deprecated.
Unit	onSaveInstanceState(outState: Bundle) This function is deprecated.

Protected functions
Unit	onBindDialogView(view: View) This function is deprecated. Use PreferenceDialogFragmentCompat instead
View?	onCreateDialogView(context: Context) This function is deprecated. Use PreferenceDialogFragmentCompat instead
Unit	onPrepareDialogBuilder(builder: AlertDialog.Builder) This function is deprecated. Use PreferenceDialogFragmentCompat instead

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

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

Constants

ARG_KEY

Added in 1.0.0

Deprecated in 1.1.0

protected const val ARG_KEY = "key": String!

This property is deprecated.

Use PreferenceDialogFragmentCompat instead

Public constructors

PreferenceDialogFragment

Added in 1.0.0

Deprecated in 1.1.0

PreferenceDialogFragment()

This function is deprecated.

Use PreferenceDialogFragmentCompat instead

Public functions

getPreference

Added in 1.0.0

Deprecated in 1.1.0

fun getPreference(): DialogPreference!

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

fun onClick(dialog: DialogInterface, which: Int): Unit

This function is deprecated.

Use PreferenceDialogFragmentCompat instead

onCreate

Added in 1.0.0

Deprecated in 1.1.0

fun onCreate(savedInstanceState: Bundle?): Unit

This function is deprecated.

onCreateDialog

Added in 1.0.0

Deprecated in 1.1.0

fun onCreateDialog(savedInstanceState: Bundle?): Dialog

This function is deprecated.

onDialogClosed

Added in 1.0.0

Deprecated in 1.1.0

abstract fun onDialogClosed(positiveResult: Boolean): Unit

This function is deprecated.

Use PreferenceDialogFragmentCompat instead

onDismiss

Added in 1.0.0

Deprecated in 1.1.0

fun onDismiss(dialog: DialogInterface): Unit

This function is deprecated.

onSaveInstanceState

Added in 1.0.0

Deprecated in 1.1.0

fun onSaveInstanceState(outState: Bundle): Unit

This function is deprecated.

Protected functions

onBindDialogView

Added in 1.0.0

Deprecated in 1.1.0

protected fun onBindDialogView(view: View): Unit

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

Added in 1.0.0

Deprecated in 1.1.0

protected fun onCreateDialogView(context: Context): View?

This function 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
View?	The content view for the dialog

See also
setLayoutResource

onPrepareDialogBuilder

Added in 1.0.0

Deprecated in 1.1.0

protected fun onPrepareDialogBuilder(builder: AlertDialog.Builder): Unit

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