PreferenceHeaderFragmentCompat

Artifact: androidx.preference:preference

Added in 1.2.0

Kotlin |Java

public abstract class PreferenceHeaderFragmentCompat extends Fragment implements PreferenceFragmentCompat.OnPreferenceStartFragmentCallback

java.lang.Object
↳	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 methods
`final @NonNull SlidingPaneLayout`	`getSlidingPaneLayout()` Return the `SlidingPaneLayout` this fragment is currently controlling.
`void`	`@CallSuper onAttach(@NonNull Context context)` Called when a fragment is first attached to its context.
`Fragment`	`onCreateInitialDetailFragment()` Override this method to set initial detail fragment that to be shown.
`abstract @NonNull PreferenceFragmentCompat`	`onCreatePreferenceHeader()` Called to supply the preference header for this fragment.
`@NonNull View`	`@CallSuper onCreateView( @NonNull LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState )` Called to have the fragment instantiate its user interface view.
`boolean`	`@CallSuper onPreferenceStartFragment( @NonNull PreferenceFragmentCompat caller, @NonNull Preference pref )` Called when the user has clicked on a preference that has a fragment class name associated with it.
`void`	`@CallSuper onViewCreated(@NonNull View view, Bundle savedInstanceState)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`void`	`onViewStateRestored(Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.

Inherited methods

From androidx.activity.result.ActivityResultCaller

`final @NonNull ActivityResultLauncher<@NonNull I>`	`@MainThread <I extends Object, O extends Object> registerForActivityResult( @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract, @NonNull ActivityResultCallback<@NonNull O> callback )` Register a request to `start an activity for result`, designated by the given `contract`.
`final @NonNull ActivityResultLauncher<@NonNull I>`	`@MainThread <I extends Object, O extends Object> registerForActivityResult( @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract, @NonNull ActivityResultRegistry registry, @NonNull ActivityResultCallback<@NonNull O> callback )` Register a request to `start an activity for result`, designated by the given `contract`.

From android.content.ComponentCallbacks

`void`	`@CallSuper onConfigurationChanged(@NonNull Configuration newConfig)`
`void`	`@MainThread @CallSuper onLowMemory()` This method is deprecated.

From androidx.activity.contextaware.ContextAware

`void`	`addOnContextAvailableListener( @NonNull OnContextAvailableListener listener )` Add a new `OnContextAvailableListener` for receiving a callback for when this class is associated with a `android.content.Context`.
`@Nullable Context`	`peekAvailableContext()` Get the `Context` if it is currently available.
`void`	`removeOnContextAvailableListener( @NonNull OnContextAvailableListener listener )` Remove a `OnContextAvailableListener` previously added via `addOnContextAvailableListener`.

From androidx.fragment.app.Fragment

`void`	`dump( @NonNull String prefix, @Nullable FileDescriptor fd, @NonNull PrintWriter writer, String[] args )` Print the Fragments's state into the given stream.
`final @Nullable FragmentActivity`	`getActivity()`
`boolean`	`getAllowEnterTransitionOverlap()`
`boolean`	`getAllowReturnTransitionOverlap()`
`final @Nullable Bundle`	`getArguments()`
`final @NonNull FragmentManager`	`getChildFragmentManager()`
`@Nullable Context`	`getContext()`
`@NonNull CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()`
`@NonNull ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`@Nullable Object`	`getEnterTransition()`
`@Nullable Object`	`getExitTransition()`
`final @Nullable FragmentManager`	`getFragmentManager()` This method is deprecated. Deprecated in Java
`final @Nullable Object`	`getHost()`
`final int`	`getId()`
`final @NonNull LayoutInflater`	`getLayoutInflater()`
`@NonNull Lifecycle`	`getLifecycle()`
`@NonNull LoaderManager`	`getLoaderManager()` This method is deprecated. Deprecated in Java
`final @Nullable Fragment`	`getParentFragment()`
`final @NonNull FragmentManager`	`getParentFragmentManager()`
`@Nullable Object`	`getReenterTransition()`
`final @NonNull Resources`	`getResources()`
`final boolean`	`getRetainInstance()` This method is deprecated. Deprecated in Java
`@Nullable Object`	`getReturnTransition()`
`final @NonNull SavedStateRegistry`	`getSavedStateRegistry()`
`@Nullable Object`	`getSharedElementEnterTransition()`
`@Nullable Object`	`getSharedElementReturnTransition()`
`final @NonNull String`	`getString(@StringRes int resId)` Return a localized string from the application's package's default string table.
`final @NonNull String`	`getString(@StringRes int resId, @NonNull Object... formatArgs)` 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.
`final @Nullable String`	`getTag()`
`final @Nullable Fragment`	`getTargetFragment()` This method is deprecated. Deprecated in Java
`final int`	`getTargetRequestCode()` This method is deprecated. Deprecated in Java
`final @NonNull CharSequence`	`getText(@StringRes int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()` This method is deprecated. Deprecated in Java
`@Nullable View`	`getView()`
`@NonNull LifecycleOwner`	`@MainThread getViewLifecycleOwner()`
`@NonNull LiveData<@NonNull LifecycleOwner>`	`getViewLifecycleOwnerLiveData()`
`@NonNull ViewModelStore`	`getViewModelStore()`
`final boolean`	`isAdded()`
`final boolean`	`isDetached()`
`final boolean`	`isHidden()`
`final boolean`	`isInLayout()`
`final boolean`	`isRemoving()`
`final boolean`	`isResumed()`
`final boolean`	`isStateSaved()`
`final boolean`	`isVisible()`
`void`	`@MainThread @CallSuper onActivityCreated(@Nullable Bundle savedInstanceState)` This method is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`void`	`onActivityResult(int requestCode, int resultCode, @Nullable Intent data)` This method 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.
`void`	`@MainThread @CallSuper onAttach(@NonNull Activity activity)` This method is deprecated. See `onAttach`.
`void`	`@MainThread onAttachFragment(@NonNull Fragment childFragment)` This method is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`boolean`	`@MainThread onContextItemSelected(@NonNull MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`@MainThread @CallSuper onCreate(@Nullable Bundle savedInstanceState)` Called to do initial creation of a fragment.
`@Nullable Animation`	`@MainThread onCreateAnimation(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`@Nullable Animator`	`@MainThread onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator.
`void`	`@MainThread onCreateOptionsMenu(@NonNull Menu menu, @NonNull MenuInflater inflater)` This method 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.
`void`	`@MainThread @CallSuper onDestroy()` Called when the fragment is no longer in use.
`void`	`@MainThread onDestroyOptionsMenu()` This method 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.
`void`	`@MainThread @CallSuper onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
`void`	`@MainThread @CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`@NonNull LayoutInflater`	`onGetLayoutInflater(@Nullable Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`@MainThread onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`void`	`@UiThread @CallSuper onInflate( @NonNull Activity activity, @NonNull AttributeSet attrs, @Nullable Bundle savedInstanceState )` This method is deprecated. See `onInflate`.
`void`	`@UiThread @CallSuper onInflate( @NonNull Context context, @NonNull AttributeSet attrs, @Nullable Bundle savedInstanceState )` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`@MainThread onOptionsItemSelected(@NonNull MenuItem item)` This method 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.
`void`	`@MainThread onOptionsMenuClosed(@NonNull Menu menu)` This method 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.
`void`	`@MainThread @CallSuper onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`@MainThread onPrepareOptionsMenu(@NonNull Menu menu)` This method 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.
`void`	`@MainThread onPrimaryNavigationFragmentChanged( boolean isPrimaryNavigationFragment )` Callback for when the primary navigation state of this Fragment has changed.
`void`	`onRequestPermissionsResult( int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults )` This method 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.
`void`	`@MainThread @CallSuper onResume()` Called when the fragment is visible to the user and actively running.
`void`	`@MainThread onSaveInstanceState(@NonNull Bundle outState)` 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.
`void`	`@MainThread @CallSuper onStart()` Called when the Fragment is visible to the user.
`void`	`@MainThread @CallSuper onStop()` Called when the Fragment is no longer started.
`void`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition` or `executePendingTransactions` has been called.
`final void`	`postponeEnterTransition(long duration, @NonNull TimeUnit timeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition`.
`void`	`registerForContextMenu(@NonNull View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(@NonNull String[] permissions, int requestCode)` This method 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.
`final @NonNull FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`final @NonNull Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`final @NonNull Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`final @NonNull FragmentManager`	`requireFragmentManager()` This method 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.
`final @NonNull Object`	`requireHost()` Return the host object of this fragment.
`final @NonNull Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`final @NonNull View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`void`	`setAllowEnterTransitionOverlap(boolean allow)`
`void`	`setAllowReturnTransitionOverlap(boolean allow)`
`void`	`setArguments(@Nullable Bundle args)`
`void`	`setEnterSharedElementCallback(@Nullable SharedElementCallback callback)` 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.
`void`	`setEnterTransition(@Nullable Object transition)`
`void`	`setExitSharedElementCallback(@Nullable SharedElementCallback callback)` 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.
`void`	`setExitTransition(@Nullable Object transition)`
`void`	`setHasOptionsMenu(boolean hasMenu)` This method 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.
`void`	`setInitialSavedState(@Nullable Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(@Nullable Object transition)`
`void`	`setRetainInstance(boolean retain)` This method is deprecated. Deprecated in Java
`void`	`setReturnTransition(@Nullable Object transition)`
`void`	`setSharedElementEnterTransition(@Nullable Object transition)`
`void`	`setSharedElementReturnTransition(@Nullable Object transition)`
`void`	`setTargetFragment(@Nullable Fragment fragment, int requestCode)` This method 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`.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated. Deprecated in Java
`boolean`	`shouldShowRequestPermissionRationale(@NonNull String permission)` Gets whether you should show UI with rationale before requesting a permission.
`void`	`startActivity(@NonNull Intent intent)` Call startActivity from the fragment's containing Activity.
`void`	`startActivity(@NonNull Intent intent, @Nullable Bundle options)` Call startActivity from the fragment's containing Activity.
`void`	`startActivityForResult(@NonNull Intent intent, int requestCode)` This method 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.
`void`	`startActivityForResult( @NonNull Intent intent, int requestCode, @Nullable Bundle options )` This method 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.
`void`	`startIntentSenderForResult( @NonNull IntentSender intent, int requestCode, @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, @Nullable Bundle options )` This method 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.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`void`	`unregisterForContextMenu(@NonNull View view)` Prevents a context menu to be shown for the given view.

From android.view.View.OnCreateContextMenuListener

void

@MainThread
onCreateContextMenu(
    @NonNull ContextMenu menu,
    @NonNull View v,
    @Nullable ContextMenu.ContextMenuInfo menuInfo
)

Called when a context menu for the view is about to be shown.

Public constructors

PreferenceHeaderFragmentCompat

Added in 1.2.0

public PreferenceHeaderFragmentCompat()

Public methods

getSlidingPaneLayout

Added in 1.2.0

public final @NonNull SlidingPaneLayout getSlidingPaneLayout()

Return the SlidingPaneLayout this fragment is currently controlling.

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

onAttach

@CallSuper
public void onAttach(@NonNull Context context)

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

onCreateInitialDetailFragment

Added in 1.2.0

public Fragment onCreateInitialDetailFragment()

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

public abstract @NonNull PreferenceFragmentCompat onCreatePreferenceHeader()

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
public @NonNull View onCreateView(
    @NonNull LayoutInflater inflater,
    ViewGroup container,
    Bundle savedInstanceState
)

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
`@NonNull LayoutInflater inflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`ViewGroup container`	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.
`Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

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

onPreferenceStartFragment

Added in 1.3.0-alpha01

@CallSuper
public boolean onPreferenceStartFragment(
    @NonNull PreferenceFragmentCompat caller,
    @NonNull Preference pref
)

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
`@NonNull PreferenceFragmentCompat caller`	The fragment requesting navigation
`@NonNull Preference pref`	The preference requesting the fragment

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

onViewCreated

@CallSuper
public void onViewCreated(@NonNull View view, Bundle savedInstanceState)

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
`@NonNull View view`	The View returned by `onCreateView`.
`Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

onViewStateRestored

public void onViewStateRestored(Bundle savedInstanceState)

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
`Bundle savedInstanceState`	If the fragment is being re-created from a previous saved state, this is the state.