PreferenceDialogFragmentCompat

Kotlin |Java

abstract class PreferenceDialogFragmentCompat : DialogFragment, OnClickListener

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.fragment.app.DialogFragment
		↳	androidx.preference.PreferenceDialogFragmentCompat

Known Direct Subclasses EditTextPreferenceDialogFragmentCompat, ListPreferenceDialogFragmentCompat, MultiSelectListPreferenceDialogFragmentCompat EditTextPreferenceDialogFragmentCompat ListPreferenceDialogFragmentCompat MultiSelectListPreferenceDialogFragmentCompat

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
static String	ARG_KEY

Inherited constants

From class DialogFragment Int STYLE_NORMAL Style for setStyle(int, int): a basic, normal dialog. Int STYLE_NO_FRAME Style for setStyle(int, int): don't draw any frame at all; the view hierarchy returned by onCreateView is entirely responsible for drawing the dialog. Int STYLE_NO_INPUT Style for setStyle(int, int): like STYLE_NO_FRAME, but also disables all input to the dialog. The user can not touch it, and its window will not receive input focus. Int STYLE_NO_TITLE Style for setStyle(int, int): don't include a title area.

Public constructors
<init>() Abstract base class which presents a dialog associated with a DialogPreference.

Public methods
open DialogPreference!	getPreference() Get the preference that requested this dialog.
open Unit	onClick(dialog: DialogInterface!, which: Int)
open Unit	onCreate(savedInstanceState: Bundle?)
open Dialog	onCreateDialog(savedInstanceState: Bundle?)
abstract Unit	onDialogClosed(positiveResult: Boolean)
open Unit	onDismiss(@NonNull dialog: DialogInterface)
open Unit	onSaveInstanceState(@NonNull outState: Bundle)

Protected methods
open Unit	onBindDialogView(view: View!) Binds views in the content view of the dialog to data.
open View!	onCreateDialogView(context: Context!) Creates the content view for the dialog (if a custom content view is required).
open Unit	onPrepareDialogBuilder(builder: AlertDialog.Builder!) Prepares the dialog builder to be shown when the preference is clicked.

Inherited functions
From class DialogFragment Unit dismiss() Dismiss the fragment and its dialog. If the fragment was added to the back stack, all back stack state up to and including this entry will be popped. Otherwise, a new transaction will be committed to remove the fragment. Unit dismissAllowingStateLoss() Version of dismiss() that uses FragmentTransaction.commitAllowingStateLoss(). See linked documentation for further details. Dialog? getDialog() Return the Dialog this fragment is currently controlling. Boolean getShowsDialog() Return the current value of setShowsDialog(boolean). Int getTheme() Boolean isCancelable() Return the current value of setCancelable(boolean). Unit onAttach(@NonNull context: Context) Unit onCancel(@NonNull dialog: DialogInterface) Unit onDestroyView() Remove dialog. Unit onDetach() LayoutInflater onGetLayoutInflater(@Nullable savedInstanceState: Bundle?) Returns the LayoutInflater used to inflate Views of this Fragment. The default implementation will throw an exception if the Fragment is not attached. If this is called from within onCreateDialog(Bundle), the layout inflater from Fragment#onGetLayoutInflater(Bundle), without the dialog theme, will be returned. Unit onStart() Unit onStop() Unit onViewStateRestored(@Nullable savedInstanceState: Bundle?) Dialog requireDialog() Return the Dialog this fragment is currently controlling. Unit setCancelable(cancelable: Boolean) Control whether the shown Dialog is cancelable. Use this instead of directly calling Dialog.setCancelable(boolean), because DialogFragment needs to change its behavior based on this. Unit setShowsDialog(showsDialog: Boolean) Controls whether this fragment should be shown in a dialog. If not set, no Dialog will be created in onActivityCreated(Bundle), and the fragment's view hierarchy will thus not be added to it. This allows you to instead use it as a normal fragment (embedded inside of its activity). This is normally set for you based on whether the fragment is associated with a container view ID passed to FragmentTransaction.add(int, Fragment). If the fragment was added with a container, setShowsDialog will be initialized to false; otherwise, it will be true. Unit setStyle(style: Int, @StyleRes theme: Int) Call to customize the basic appearance and behavior of the fragment's dialog. This can be used for some common dialog behaviors, taking care of selecting flags, theme, and other options for you. The same effect can be achieve by manually setting Dialog and Window attributes yourself. Calling this after the fragment's Dialog is created will have no effect. Unit show(@NonNull manager: FragmentManager, @Nullable tag: String?) Display the dialog, adding the fragment to the given FragmentManager. This is a convenience for explicitly creating a transaction, adding the fragment to it with the given tag, and committing it. This does not add the transaction to the fragment back stack. When the fragment is dismissed, a new transaction will be executed to remove it from the activity. Int show(@NonNull transaction: FragmentTransaction, @Nullable tag: String?) Display the dialog, adding the fragment using an existing transaction and then committing the transaction. Unit showNow(@NonNull manager: FragmentManager, @Nullable tag: String?) Display the dialog, immediately adding the fragment to the given FragmentManager. This is a convenience for explicitly creating a transaction, adding the fragment to it with the given tag, and calling FragmentTransaction#commitNow(). This does not add the transaction to the fragment back stack. When the fragment is dismissed, a new transaction will be executed to remove it from the activity.
From class Fragment Unit dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?) Print the Fragments's state into the given stream. Boolean equals(@Nullable other: Any?) Subclasses can not override equals(). FragmentActivity? getActivity() Return the FragmentActivity this fragment is currently associated with. May return null if the fragment is associated with a Context instead. Boolean getAllowEnterTransitionOverlap() Returns whether the the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting. Boolean getAllowReturnTransitionOverlap() Returns whether the the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting. Bundle? getArguments() Return the arguments supplied when the fragment was instantiated, if any. FragmentManager getChildFragmentManager() Return a private FragmentManager for placing and managing Fragments inside of this Fragment. Context? getContext() Return the Context this fragment is currently associated with. ViewModelProvider.Factory getDefaultViewModelProviderFactory() Returns the default ViewModelProvider.Factory that should be used when no custom Factory is provided to the ViewModelProvider constructors. 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 factory. Any? getEnterTransition() Returns the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#INVISIBLE to View#VISIBLE. Any? getExitTransition() 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected. FragmentManager? getFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will be non-null slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). Any? getHost() Return the host object of this fragment. May return null if the fragment isn't currently being hosted. Int getId() Return the identifier this fragment is known by. This is either the android:id value supplied in a layout or the container view ID supplied when adding the fragment. LayoutInflater getLayoutInflater() Returns the cached LayoutInflater used to inflate Views of this Fragment. If onGetLayoutInflater(Bundle) has not been called onGetLayoutInflater(Bundle) will be called with a null argument and that value will be cached. The cached LayoutInflater will be replaced immediately prior to onCreateView(LayoutInflater, ViewGroup, Bundle) and cleared immediately after onDetach(). Lifecycle getLifecycle() Returns the Lifecycle of the provider. Overriding this method is no longer supported and this method will be made final in a future version of Fragment. LoaderManager getLoaderManager() Return the LoaderManager for this fragment. Fragment? getParentFragment() Returns the parent Fragment containing this Fragment. If this Fragment is attached directly to an Activity, returns null. FragmentManager getParentFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). Any? getReenterTransition() Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If nothing is set, the default will be to use the same transition as getExitTransition(). Resources getResources() Return requireActivity().getResources(). Boolean getRetainInstance() Returns true if this fragment instance's state will be retained across configuration changes, and false if it will not. Any? getReturnTransition() 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If nothing is set, the default will be to use the same transition as getEnterTransition(). SavedStateRegistry getSavedStateRegistry() Any? getSharedElementEnterTransition() Returns the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. Any? getSharedElementReturnTransition() Return the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as setSharedElementEnterTransition(Object). String getString(@StringRes resId: Int) Return a localized string from the application's package's default string table. String getString(@StringRes resId: Int, @Nullable vararg formatArgs: 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 java.lang.String#format. String? getTag() Get the tag name of the fragment, if specified. Fragment? getTargetFragment() Return the target fragment set by setTargetFragment. Int getTargetRequestCode() Return the target request code set by setTargetFragment. CharSequence getText(@StringRes resId: Int) Return a localized, styled CharSequence from the application's package's default string table. Boolean getUserVisibleHint() View? getView() Get the root view for the fragment's layout (the one returned by onCreateView), if provided. LifecycleOwner getViewLifecycleOwner() Get a LifecycleOwner that represents the Fragment's View lifecycle. In most cases, this mirrors the lifecycle of the Fragment itself, but in cases of detached Fragments, the lifecycle of the Fragment can be considerably longer than the lifecycle of the View itself. Namely, the lifecycle of the Fragment's View is: created after onViewStateRestored(Bundle) started after onStart() resumed after onResume() paused before onPause() stopped before onStop() destroyed before onDestroyView() The first method where it is safe to access the view lifecycle is onCreateView(LayoutInflater, ViewGroup, Bundle) under the condition that you must return a non-null view (an IllegalStateException will be thrown if you access the view lifecycle but don't return a non-null view). The view lifecycle remains valid through the call to onDestroyView(), after which getView() will return null, the view lifecycle will be destroyed, and this method will throw an IllegalStateException. Consider using getViewLifecycleOwnerLiveData() or FragmentTransaction#runOnCommit(Runnable) to receive a callback for when the Fragment's view lifecycle is available. This should only be called on the main thread. Overriding this method is no longer supported and this method will be made final in a future version of Fragment. LiveData<LifecycleOwner!> getViewLifecycleOwnerLiveData() Retrieve a LiveData which allows you to observe the lifecycle of the Fragment's View. This will be set to the new LifecycleOwner after onCreateView returns a non-null View and will set to null after onDestroyView(). Overriding this method is no longer supported and this method will be made final in a future version of Fragment. ViewModelStore getViewModelStore() Returns the ViewModelStore associated with this Fragment Overriding this method is no longer supported and this method will be made final in a future version of Fragment. Int hashCode() Subclasses can not override hashCode(). Fragment instantiate(@NonNull context: Context, @NonNull fname: String) Like instantiate(Context, String, Bundle) but with a null argument Bundle. Fragment instantiate(@NonNull context: Context, @NonNull fname: String, @Nullable args: Bundle?) Create a new instance of a Fragment with the given class name. This is the same as calling its empty constructor, setting the ClassLoader on the supplied arguments, then calling setArguments(Bundle). Boolean isAdded() Return true if the fragment is currently added to its activity. Boolean isDetached() Return true if the fragment has been explicitly detached from the UI. That is, FragmentTransaction.detach(Fragment) has been used on it. Boolean isHidden() Return true if the fragment has been hidden. By default fragments are shown. You can find out about changes to this state with onHiddenChanged. Note that the hidden state is orthogonal to other states -- that is, to be visible to the user, a fragment must be both started and not hidden. Boolean isInLayout() Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. This will always be true when fragments are created through the <fragment> tag, except in the case where an old fragment is restored from a previous state and it does not appear in the layout of the current state. Boolean isRemoving() Return true if this fragment is currently being removed from its activity. This is not whether its activity is finishing, but rather whether it is in the process of being removed from its activity. Boolean isResumed() Return true if the fragment is in the resumed state. This is true for the duration of onResume() and onPause() as well. Boolean isStateSaved() Returns true if this fragment is added and its state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true, and some operations such as setArguments(Bundle) will fail. Boolean isVisible() Return true if the fragment is currently visible to the user. This means it: (1) has been added, (2) has its view attached to the window, and (3) is not hidden. Unit onActivityCreated(@Nullable savedInstanceState: Bundle?) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. It can be used to do final initialization once these pieces are in place, such as retrieving views or restoring state. It is also useful for fragments that use setRetainInstance(boolean) to retain their instance, as this callback tells the fragment when it is fully associated with the new activity instance. This is called after onCreateView and before onViewStateRestored(Bundle). Unit onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?) Receive the result from a previous call to startActivityForResult(Intent, int). This follows the related Activity API as described there in Activity#onActivityResult(int, int, Intent). Unit onAttach(@NonNull activity: Activity) Called when a fragment is first attached to its activity. onCreate(Bundle) will be called after this. Unit onAttachFragment(@NonNull childFragment: Fragment) Called when a fragment is attached as a child of this fragment. This is called after the attached fragment's onAttach and before the attached fragment's onCreate if the fragment has not yet had a previous call to onCreate. Unit onConfigurationChanged(@NonNull newConfig: Configuration) Boolean onContextItemSelected(@NonNull item: MenuItem) This hook is called whenever an item in a context menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Use MenuItem#getMenuInfo() to get extra information set by the View that added this menu item. Derived classes should call through to the base class for it to perform the default menu handling. Animation? onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int) Called when a fragment loads an animation. Note that if FragmentTransaction#setCustomAnimations(int, int) was called with Animator resources instead of Animation resources, nextAnim will be an animator resource. Animator? onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int) Called when a fragment loads an animator. This will be called when onCreateAnimation(int, boolean, int) returns null. Note that if FragmentTransaction#setCustomAnimations(int, int) was called with Animation resources instead of Animator resources, nextAnim will be an animation resource. Unit onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenuInfo?) Called when a context menu for the view is about to be shown. Unlike onCreateOptionsMenu, this will be called every time the context menu is about to be shown and should be populated for the view (or item inside the view for AdapterView subclasses, this can be found in the menuInfo)). Use onContextItemSelected(android.view.MenuItem) to know when an item has been selected. The default implementation calls up to Activity.onCreateContextMenu, though you can not call this implementation if you don't want that behavior. It is not safe to hold onto the context menu after this method returns. Unit onCreateOptionsMenu(@NonNull menu: Menu, @NonNull inflater: MenuInflater) Initialize the contents of the Fragment host's standard options menu. You should place your menu items in to menu. For this method to be called, you must have first called setHasOptionsMenu. See Activity.onCreateOptionsMenu for more information. View? onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?) Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between onCreate(Bundle) and onViewCreated(View, Bundle). A default View can be returned by calling Fragment(int) in your constructor. Otherwise, this method returns null. It is recommended to only inflate the layout in this method and move logic that operates on the returned View to onViewCreated(View, Bundle). If you return a View from here, you will later be called in onDestroyView when the view is being released. Unit onDestroy() Called when the fragment is no longer in use. This is called after onStop() and before onDetach(). Unit onDestroyOptionsMenu() Called when this fragment's option menu items are no longer being included in the overall options menu. Receiving this call means that the menu needed to be rebuilt, but this fragment's items were not included in the newly built menu (its onCreateOptionsMenu(Menu, MenuInflater) was not called). Unit onHiddenChanged(hidden: Boolean) Called when the hidden state (as returned by isHidden() of the fragment has changed. Fragments start out not hidden; this will be called whenever the fragment changes state from that. Unit onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable 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. This may be called immediately after the fragment is created from a FragmentContainerView in a layout file. Note this is before the fragment's onAttach(Context) has been called; all you should do here is parse the attributes and save them away. This is called the first time the fragment is inflated. If it is being inflated into a new instance with saved state, this method will not be called a second time for the restored state fragment. Here is a typical implementation of a fragment that can take parameters both through attributes supplied here as well from getArguments(): Note that parsing the XML attributes uses a "styleable" resource. The declaration for the styleable used here is: The fragment can then be declared within its activity's content layout through a tag like this: This fragment can also be created dynamically from arguments given at runtime in the arguments Bundle; here is an example of doing so at creation of the containing activity: Unit onInflate(@NonNull activity: Activity, @NonNull attrs: AttributeSet, @Nullable 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 onLowMemory() Unit onMultiWindowModeChanged(isInMultiWindowMode: Boolean) Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. This is generally tied to Activity#onMultiWindowModeChanged of the containing Activity. Boolean onOptionsItemSelected(@NonNull item: MenuItem) This hook is called whenever an item in your options menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Derived classes should call through to the base class for it to perform the default menu handling. Unit onOptionsMenuClosed(@NonNull menu: Menu) This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected). Unit onPause() Called when the Fragment is no longer resumed. This is generally tied to Activity.onPause of the containing Activity's lifecycle. Unit onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean) Called by the system when the activity changes to and from picture-in-picture mode. This is generally tied to Activity#onPictureInPictureModeChanged of the containing Activity. Unit onPrepareOptionsMenu(@NonNull menu: Menu) Prepare the Fragment host's standard options menu to be displayed. This is called right before the menu is shown, every time it is shown. You can use this method to efficiently enable/disable items or otherwise dynamically modify the contents. See Activity.onPrepareOptionsMenu for more information. Unit onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean) Callback for when the primary navigation state of this Fragment has changed. This can be the result of the getParentFragmentManager() containing FragmentManager} having its primary navigation fragment changed via androidx.fragment.app.FragmentTransaction#setPrimaryNavigationFragment or due to the primary navigation fragment changing in a parent FragmentManager. Unit onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<String!>, @NonNull grantResults: IntArray) Callback for the result from requesting permissions. This method is invoked for every call on requestPermissions(String[], int). Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation. Unit onResume() Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle. Unit onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?) Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view. This gives subclasses a chance to initialize themselves once they know their view hierarchy has been completely created. The fragment's view hierarchy is not however attached to its parent at this point. Unit postponeEnterTransition() Postpone the entering Fragment transition until startPostponedEnterTransition() or FragmentManager#executePendingTransactions() has been called. This method gives the Fragment the ability to delay Fragment animations until all data is loaded. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called startPostponedEnterTransition(). This method should be called before being added to the FragmentTransaction or in onCreate(Bundle), onAttach(Context), or onCreateView(LayoutInflater, ViewGroup, Bundle)}. startPostponedEnterTransition() must be called to allow the Fragment to start the transitions. When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement. Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if FragmentTransaction reordering is enabled. Unit postponeEnterTransition(duration: Long, @NonNull timeUnit: TimeUnit) Postpone the entering Fragment transition for a given amount of time and then call startPostponedEnterTransition(). This method gives the Fragment the ability to delay Fragment animations for a given amount of time. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called startPostponedEnterTransition(). This method should be called before being added to the FragmentTransaction or in onCreate(Bundle), onAttach(Context), or onCreateView(LayoutInflater, ViewGroup, Bundle)}. When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement. Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if FragmentTransaction reordering is enabled. ActivityResultLauncher<I> prepareCall(@NonNull contract: ActivityResultContract<I, O>, @NonNull callback: ActivityResultCallback<O>) ActivityResultLauncher<I> prepareCall(@NonNull contract: ActivityResultContract<I, O>, @NonNull registry: ActivityResultRegistry, @NonNull callback: ActivityResultCallback<O>) Unit registerForContextMenu(@NonNull view: View) Registers a context menu to be shown for the given view (multiple views can show the context menu). This method will set the OnCreateContextMenuListener on the view to this fragment, so onCreateContextMenu(ContextMenu, View, ContextMenuInfo) will be called when it is time to show the context menu. Unit requestPermissions(@NonNull permissions: Array<String!>, requestCode: Int) Requests permissions to be granted to this application. These permissions must be requested in your manifest, they should not be granted to your app, and they should have protection level #PROTECTION_DANGEROUS dangerous, regardless whether they are declared by the platform or a third-party app. Normal permissions android.content.pm.PermissionInfo#PROTECTION_NORMAL are granted at install time if requested in the manifest. Signature permissions android.content.pm.PermissionInfo#PROTECTION_SIGNATURE are granted at install time if requested in the manifest and the signature of your app matches the signature of the app declaring the permissions. If your app does not have the requested permissions the user will be presented with UI for accepting them. After the user has accepted or rejected the requested permissions you will receive a callback on reporting whether the permissions were granted or not. Note that requesting a permission does not guarantee it will be granted and your app should be able to run without having this permission. This method may start an activity allowing the user to choose which permissions to grant and which to reject. Hence, you should be prepared that your activity may be paused and resumed. Further, granting some permissions may require a restart of you application. In such a case, the system will recreate the activity stack before delivering the result to . When checking whether you have a permission you should use . Calling this API for permissions already granted to your app would show UI to the user to decided whether the app can still hold these permissions. This can be useful if the way your app uses the data guarded by the permissions changes significantly. A sample permissions request looks like this: <code><p> private void showContacts() { if (getActivity().checkSelfPermission(Manifest.permission.READ_CONTACTS) != PackageManager.PERMISSION_GRANTED) { requestPermissions(new String[]{Manifest.permission.READ_CONTACTS}, PERMISSIONS_REQUEST_READ_CONTACTS); } else { doShowContacts(); } } @Override public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) { if (requestCode == PERMISSIONS_REQUEST_READ_CONTACTS &amp;&amp; grantResults[0] == PackageManager.PERMISSION_GRANTED) { doShowContacts(); } } </p></code> FragmentActivity requireActivity() Return the FragmentActivity this fragment is currently associated with. Bundle requireArguments() Return the arguments supplied when the fragment was instantiated. Context requireContext() Return the Context this fragment is currently associated with. FragmentManager requireFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available slightly before getActivity(), during the time from when the fragment is placed in a FragmentTransaction until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's getChildFragmentManager(). Any requireHost() Return the host object of this fragment. Fragment requireParentFragment() Returns the parent Fragment containing this Fragment. View requireView() Get the root view for the fragment's layout (the one returned by onCreateView). Unit setAllowEnterTransitionOverlap(allow: Boolean) Sets whether the the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting. Unit setAllowReturnTransitionOverlap(allow: Boolean) Sets whether the the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting. Unit setArguments(@Nullable args: Bundle?) Supply the construction arguments for this fragment. The arguments supplied here will be retained across fragment destroy and creation. This method cannot be called if the fragment is added to a FragmentManager and if isStateSaved() would return true. Unit setEnterSharedElementCallback(@Nullable callback: SharedElementCallback?) 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(@Nullable transition: Any?) Sets the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#INVISIBLE to View#VISIBLE. If transition is null, entering Views will remain unaffected. Unit setExitSharedElementCallback(@Nullable callback: SharedElementCallback?) 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(@Nullable 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected. Unit setHasOptionsMenu(hasMenu: Boolean) Report that this fragment would like to participate in populating the options menu by receiving a call to onCreateOptionsMenu and related methods. Unit setInitialSavedState(@Nullable state: Fragment.SavedState?) 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. This is useful if you know that a fragment has been placed in your view hierarchy so that the user can not currently seen it, so any menu items it has should also not be shown. Unit setReenterTransition(@Nullable transition: Any?) Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected. If nothing is set, the default will be to use the same transition as getExitTransition(). Unit setRetainInstance(retain: Boolean) Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). If set, the fragment lifecycle will be slightly different when an activity is recreated: onDestroy() will not be called (but onDetach() still will be, because the fragment is being detached from its current activity). onCreate(Bundle) will not be called since the fragment is not being re-created. onAttach(Activity) and onActivityCreated(Bundle) will still be called. Unit setReturnTransition(@Nullable 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. The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup#isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, entering Views will remain unaffected. If nothing is set, the default will be to use the same value as set in setEnterTransition(Object). Unit setSharedElementEnterTransition(@Nullable transition: Any?) Sets the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. Unit setSharedElementReturnTransition(@Nullable transition: Any?) Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as setSharedElementEnterTransition(Object). Unit setTargetFragment(@Nullable fragment: Fragment?, requestCode: Int) Optional target for this fragment. This may be used, for example, if this fragment is being started by another, and when done wants to give a result back to the first. The target set here is retained across instances via FragmentManager.putFragment(). Unit setUserVisibleHint(isVisibleToUser: Boolean) Set a hint to the system about whether this fragment's UI is currently visible to the user. This hint defaults to true and is persistent across fragment instance state save and restore. An app may set this to false to indicate that the fragment's UI is scrolled out of visibility or is otherwise not directly visible to the user. This may be used by the system to prioritize operations such as fragment lifecycle updates or loader ordering behavior. Note: This method may be called outside of the fragment lifecycle. and thus has no ordering guarantees with regard to fragment lifecycle method calls. Boolean shouldShowRequestPermissionRationale(@NonNull permission: String) Gets whether you should show UI with rationale for requesting a permission. You should do this only if you do not have the permission and the context in which the permission is requested does not clearly communicate to the user what would be the benefit from granting this permission. For example, if you write a camera app, requesting the camera permission would be expected by the user and no rationale for why it is requested is needed. If however, the app needs location for tagging photos then a non-tech savvy user may wonder how location is related to taking photos. In this case you may choose to show UI with rationale of requesting this permission. Unit startActivity(intent: Intent!) Call Activity#startActivity(Intent) from the fragment's containing Activity. Unit startActivity(intent: Intent!, @Nullable options: Bundle?) Call Activity#startActivity(Intent, Bundle) from the fragment's containing Activity. Unit startActivityForResult(intent: Intent!, requestCode: Int) Call Activity#startActivityForResult(Intent, int) from the fragment's containing Activity. Unit startActivityForResult(intent: Intent!, requestCode: Int, @Nullable options: Bundle?) Call Activity#startActivityForResult(Intent, int, Bundle) from the fragment's containing Activity. Unit startIntentSenderForResult(intent: IntentSender!, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?) Call Activity#startIntentSenderForResult(IntentSender, int, Intent, int, int, int, * Bundle) from the fragment's containing Activity. Unit startPostponedEnterTransition() Begin postponed transitions after postponeEnterTransition() was called. If postponeEnterTransition() was called, you must call startPostponedEnterTransition() or FragmentManager#executePendingTransactions() to complete the FragmentTransaction. If postponement was interrupted with FragmentManager#executePendingTransactions(), before startPostponedEnterTransition(), animations may not run or may execute improperly. String toString() Unit unregisterForContextMenu(@NonNull view: View) Prevents a context menu to be shown for the given view. This method will remove the OnCreateContextMenuListener on the view.

Constants

ARG_KEY

protected static val ARG_KEY: String

Value: "key"

Public constructors

<init>

PreferenceDialogFragmentCompat()

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.

Public methods

getPreference

open fun getPreference(): DialogPreference!

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

Return
DialogPreference!	The DialogPreference associated with this dialog

onClick

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

onCreate

open fun onCreate(savedInstanceState: Bundle?): Unit

onCreateDialog

@NonNull open fun onCreateDialog(savedInstanceState: Bundle?): Dialog

onDialogClosed

abstract fun onDialogClosed(positiveResult: Boolean): Unit

onDismiss

open fun onDismiss(@NonNull dialog: DialogInterface): Unit

onSaveInstanceState

open fun onSaveInstanceState(@NonNull outState: Bundle): Unit

Protected methods

onBindDialogView

protected open 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

protected open 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.

Return
View!	The content view for the dialog

See Also

• DialogPreference#setLayoutResource(int)

onPrepareDialogBuilder

protected open 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 AlertDialog.Builder#create() or AlertDialog.Builder#show().