PreferenceHeaderFragmentCompat

Artifact: androidx.preference:preference

Added in 1.2.0

Kotlin |Java

abstract class PreferenceHeaderFragmentCompat : Fragment, PreferenceFragmentCompat.OnPreferenceStartFragmentCallback

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.preference.PreferenceHeaderFragmentCompat

PreferenceHeaderFragmentCompat implements a two-pane fragment for preferences. The list pane is a container of preference headers. Tapping on a preference header swaps out the fragment shown in the detail pane. Subclasses are expected to implement onCreatePreferenceHeader to provide your own PreferenceFragmentCompat in the list pane. The preference header hierarchy is defined by either providing an XML resource or build in code through PreferenceFragmentCompat. In both cases, users need to use a PreferenceScreen as the root component in the hierarchy.

Usage:

class TwoPanePreference : PreferenceHeaderFragmentCompat() {
    override fun onCreatePreferenceHeader(): PreferenceFragmentCompat {
        return PreferenceHeader()
    }
}

PreferenceHeaderFragmentCompat handles the fragment transaction when users defines a fragment or intent associated with the preference header. By default, the initial state fragment for the detail pane is set to the associated fragment that first found in preference headers. You can override onCreateInitialDetailFragment to provide the custom empty state fragment for the detail pane.

Summary

Public constructors
`PreferenceHeaderFragmentCompat()`

Public functions
`open Unit`	`@CallSuper onAttach(context: Context)` Called when a fragment is first attached to its context.
`open Fragment?`	`onCreateInitialDetailFragment()` Override this method to set initial detail fragment that to be shown.
`abstract PreferenceFragmentCompat`	`onCreatePreferenceHeader()` Called to supply the preference header for this fragment.
`open View`	`@CallSuper onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? )` Called to have the fragment instantiate its user interface view.
`open Boolean`	`@CallSuper onPreferenceStartFragment( caller: PreferenceFragmentCompat, pref: Preference )` Called when the user has clicked on a preference that has a fragment class name associated with it.
`open Unit`	`@CallSuper onViewCreated(view: View, savedInstanceState: Bundle?)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`open Unit`	`onViewStateRestored(savedInstanceState: Bundle?)` Called when all saved state has been restored into the view hierarchy of the fragment.

Public properties
`SlidingPaneLayout`	`slidingPaneLayout` Return the `SlidingPaneLayout` this fragment is currently controlling.

Inherited functions

From androidx.fragment.app.Fragment

`open Unit`	`dump( prefix: String, fd: FileDescriptor?, writer: PrintWriter, args: Array<String>? )` Print the Fragments's state into the given stream.
`final operator Boolean`	`equals(other: Any?)` Subclasses can not override equals().
`FragmentActivity?`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`open Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`open Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`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.
`open Context?`	`getContext()` Return the `Context` this fragment is currently associated with.
`open Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`open 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.
`FragmentManager?`	`getFragmentManager()` This function is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null.
`Any?`	`getHost()` Return the host object of this fragment.
`Int`	`getId()` Return the identifier this fragment is known by.
`LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`open LoaderManager`	`getLoaderManager()` This function is deprecated. Use `LoaderManager.getInstance(this)`.
`Fragment?`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`open Any?`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`Resources`	`getResources()` Return `requireActivity().getResources()`.
`Boolean`	`getRetainInstance()` 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.
`open 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.
`open Any?`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`open Any?`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`String`	`getString(resId: @StringRes Int)` Return a localized string from the application's package's default string table.
`String`	`getString(resId: @StringRes Int, 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 format.
`String?`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment?`	`getTargetFragment()` 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`	`getTargetRequestCode()` 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`	`getText(resId: @StringRes Int)` Return a localized, styled CharSequence from the application's package's default string table.
`open Boolean`	`getUserVisibleHint()` This function is deprecated. Use `setMaxLifecycle` instead.
`open View?`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`open LifecycleOwner`	`@MainThread getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
`open LiveData<LifecycleOwner>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
`final Int`	`hashCode()` Subclasses can not override hashCode().
`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.
`Boolean`	`isHidden()` Return true if the fragment has been hidden.
`Boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the tag.
`Boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`Boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`Boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`Boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`open Unit`	`@MainThread @CallSuper onActivityCreated(savedInstanceState: Bundle?)` This function is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`open 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.
`open Unit`	`@MainThread @CallSuper onAttach(activity: Activity)` This function is deprecated. See `onAttach`.
`open Unit`	`@MainThread onAttachFragment(childFragment: Fragment)` This function is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`open Unit`	`@CallSuper onConfigurationChanged(newConfig: Configuration)`
`open Boolean`	`@MainThread onContextItemSelected(item: MenuItem)` This hook is called whenever an item in a context menu is selected.
`open Unit`	`@MainThread @CallSuper onCreate(savedInstanceState: Bundle?)` Called to do initial creation of a fragment.
`open Animation?`	`@MainThread onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation.
`open Animator?`	`@MainThread onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animator.
`open Unit`	`@MainThread onCreateContextMenu( menu: ContextMenu, v: View, menuInfo: ContextMenu.ContextMenuInfo? )` Called when a context menu for the `view` is about to be shown.
`open Unit`	`@MainThread onCreateOptionsMenu(menu: Menu, inflater: MenuInflater)` 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.
`open Unit`	`@MainThread @CallSuper onDestroy()` Called when the fragment is no longer in use.
`open Unit`	`@MainThread onDestroyOptionsMenu()` 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.
`open Unit`	`@MainThread @CallSuper onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
`open Unit`	`@MainThread @CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`open LayoutInflater`	`onGetLayoutInflater(savedInstanceState: Bundle?)` Returns the LayoutInflater used to inflate Views of this Fragment.
`open Unit`	`@MainThread onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`open Unit`	`@UiThread @CallSuper onInflate( activity: Activity, attrs: AttributeSet, savedInstanceState: Bundle? )` This function is deprecated. See `onInflate`.
`open 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.
`open Unit`	`@MainThread @CallSuper onLowMemory()`
`open Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`open Boolean`	`@MainThread onOptionsItemSelected(item: MenuItem)` 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.
`open Unit`	`@MainThread onOptionsMenuClosed(menu: Menu)` 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.
`open Unit`	`@MainThread @CallSuper onPause()` Called when the Fragment is no longer resumed.
`open Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode.
`open Unit`	`@MainThread onPrepareOptionsMenu(menu: Menu)` 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.
`open Unit`	`@MainThread onPrimaryNavigationFragmentChanged( isPrimaryNavigationFragment: Boolean )` Callback for when the primary navigation state of this Fragment has changed.
`open 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.
`open Unit`	`@MainThread @CallSuper onResume()` Called when the fragment is visible to the user and actively running.
`open Unit`	`@MainThread onSaveInstanceState(outState: Bundle)` 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.
`open Unit`	`@MainThread @CallSuper onStart()` Called when the Fragment is visible to the user.
`open Unit`	`@MainThread @CallSuper onStop()` Called when the Fragment is no longer started.
`open Unit`	`postponeEnterTransition()` 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`.
`final ActivityResultLauncher<I>`	`@MainThread <I : Any, O : Any> registerForActivityResult( contract: ActivityResultContract<I, O>, callback: ActivityResultCallback<O> )` Register a request to `start an activity for result`, designated by the given `contract`.
`final ActivityResultLauncher<I>`	`@MainThread <I : Any, O : Any> registerForActivityResult( contract: ActivityResultContract<I, O>, registry: ActivityResultRegistry, callback: ActivityResultCallback<O> )` Register a request to `start an activity for result`, designated by the given `contract`.
`open Unit`	`registerForContextMenu(view: View)` 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`	`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()` 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`	`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`).
`open Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` Sets whether the the exit transition and enter transition overlap or not.
`open Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` Sets whether the the return transition and reenter transition overlap or not.
`open Unit`	`setArguments(args: Bundle?)` Supply the construction arguments for this fragment.
`open Unit`	`setEnterSharedElementCallback(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.
`open Unit`	`setEnterTransition(transition: Any?)` Sets the Transition that will be used to move Views into the initial scene.
`open Unit`	`setExitSharedElementCallback(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.
`open 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.
`open Unit`	`setHasOptionsMenu(hasMenu: Boolean)` 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.
`open Unit`	`setInitialSavedState(state: Fragment.SavedState?)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`open Unit`	`setMenuVisibility(menuVisible: Boolean)` Set a hint for whether this fragment's menu should be visible.
`open 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.
`open Unit`	`setRetainInstance(retain: 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.
`open 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.
`open Unit`	`setSharedElementEnterTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`open Unit`	`setSharedElementReturnTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`open 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`.
`open Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated. If you are manually calling this method, use `setMaxLifecycle` instead.
`open Boolean`	`shouldShowRequestPermissionRationale(permission: String)` Gets whether you should show UI with rationale before requesting a permission.
`open Unit`	`startActivity(intent: Intent)` Call startActivity from the fragment's containing Activity.
`open Unit`	`startActivity(intent: Intent, options: Bundle?)` Call startActivity from the fragment's containing Activity.
`open 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.
`open 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.
`open 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.
`open Unit`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`open String`	`toString()`
`open Unit`	`unregisterForContextMenu(view: View)` Prevents a context menu to be shown for the given view.

Inherited properties

From androidx.fragment.app.Fragment

`open CreationExtras`	`defaultViewModelCreationExtras` 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.
`open ViewModelProvider.Factory`	`defaultViewModelProviderFactory`
`open Lifecycle`	`lifecycle` Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`final SavedStateRegistry`	`savedStateRegistry`
`open ViewModelStore`	`viewModelStore` Returns the `ViewModelStore` associated with this Fragment

Public constructors

PreferenceHeaderFragmentCompat

Added in 1.2.0

PreferenceHeaderFragmentCompat()

Public functions

onAttach

@CallSuper
open fun onAttach(context: Context): Unit

Called when a fragment is first attached to its context. onCreate will be called after this.

onCreateInitialDetailFragment

Added in 1.2.0

open fun onCreateInitialDetailFragment(): Fragment?

Override this method to set initial detail fragment that to be shown. The default implementation returns the first preference that has a fragment defined on it.

Returns
`Fragment?`	Fragment The first fragment that found in the list of preference headers.

onCreatePreferenceHeader

Added in 1.2.0

abstract fun onCreatePreferenceHeader(): PreferenceFragmentCompat

Called to supply the preference header for this fragment. The subclasses are expected to call setPreferenceScreen(PreferenceScreen) either directly or via helper methods such as setPreferenceFromResource(int) to set headers.

onCreateView

@CallSuper
open fun onCreateView(
    inflater: LayoutInflater,
    container: ViewGroup?,
    savedInstanceState: Bundle?
): View

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 and onViewCreated.

A default View can be returned by calling Fragment 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.

If you return a View from here, you will later be called in onDestroyView when the view is being released.

Parameters
`inflater: LayoutInflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`container: ViewGroup?`	If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
`savedInstanceState: Bundle?`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`View`	Return the View for the fragment's UI, or null.

onPreferenceStartFragment

Added in 1.3.0-alpha01

@CallSuper
open fun onPreferenceStartFragment(
    caller: PreferenceFragmentCompat,
    pref: Preference
): Boolean

Called when the user has clicked on a preference that has a fragment class name associated with it. The implementation should instantiate and switch to an instance of the given fragment.

Parameters
`caller: PreferenceFragmentCompat`	The fragment requesting navigation
`pref: Preference`	The preference requesting the fragment

Returns
`Boolean`	`true` if the fragment creation has been handled

onViewCreated

@CallSuper
open fun onViewCreated(view: View, savedInstanceState: Bundle?): Unit

Called immediately after onCreateView 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.

Parameters
`view: View`	The View returned by `onCreateView`.
`savedInstanceState: Bundle?`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

onViewStateRestored

open fun onViewStateRestored(savedInstanceState: Bundle?): Unit

Called when all saved state has been restored into the view hierarchy of the fragment. This can be used to do initialization based on saved state that you are letting the view hierarchy track itself, such as whether check box widgets are currently checked. This is called after onViewCreated and before onStart.

Parameters
`savedInstanceState: Bundle?`	If the fragment is being re-created from a previous saved state, this is the state.

Public properties

slidingPaneLayout

Added in 1.2.0

val slidingPaneLayout: SlidingPaneLayout

Return the SlidingPaneLayout this fragment is currently controlling.

Throws
`kotlin.IllegalStateException`	if the SlidingPaneLayout has not been created by `onCreateView`