FragmentController

public void attachHost(@Nullable Fragment parent)

Attaches the host to the FragmentManager for this controller. The host must be attached before the FragmentManager can be used to manage Fragments.

public static @NonNull FragmentController createController(@NonNull FragmentHostCallback<@NonNull ?> callbacks)

Returns a FragmentController.

public void dispatchActivityCreated()

Moves all Fragments managed by the controller's FragmentManager into the activity created state.

Call when Fragments should be informed their host has been created.

public void dispatchConfigurationChanged(@NonNull Configuration newConfig)

Lets all Fragments managed by the controller's FragmentManager know a configuration change occurred.

Call when there is a configuration change.

public boolean dispatchContextItemSelected(@NonNull MenuItem item)

Sends a context item selection event to the Fragments managed by the controller's FragmentManager. Once the event has been consumed, no additional handling will be performed.

Call immediately after an options menu item has been selected

public void dispatchCreate()

Moves all Fragments managed by the controller's FragmentManager into the create state.

Call when Fragments should be created.

public boolean dispatchCreateOptionsMenu(
    @NonNull Menu menu,
    @NonNull MenuInflater inflater
)

Lets all Fragments managed by the controller's FragmentManager know they should create an options menu.

Call when the Fragment should create an options menu.

public void dispatchDestroy()

Moves Fragments managed by the controller's FragmentManager into the destroy state.

If the androidx.fragment.app.FragmentHostCallback is an instance of ViewModelStoreOwner, then retained Fragments and any other non configuration state such as any androidx.lifecycle.ViewModel attached to Fragments will only be destroyed if clear is called prior to this method.

Otherwise, the FragmentManager will look to see if the host's Context is an Activity and if isChangingConfigurations returns true. In only that case will non configuration state be retained.

Call when Fragments should be destroyed.

public void dispatchDestroyView()

Moves all Fragments managed by the controller's FragmentManager into the destroy view state.

Call when the Fragment's views should be destroyed.

public void dispatchLowMemory()

Lets all Fragments managed by the controller's FragmentManager know the device is in a low memory condition.

Call when the device is low on memory and Fragment's should trim their memory usage.

public void dispatchMultiWindowModeChanged(boolean isInMultiWindowMode)

Lets all Fragments managed by the controller's FragmentManager know the multi-window mode of the activity changed.

Call when the multi-window mode of the activity changed.

public boolean dispatchOptionsItemSelected(@NonNull MenuItem item)

Sends an option item selection event to the Fragments managed by the controller's FragmentManager. Once the event has been consumed, no additional handling will be performed.

Call immediately after an options menu item has been selected

public void dispatchOptionsMenuClosed(@NonNull Menu menu)

Lets all Fragments managed by the controller's FragmentManager know their options menu has closed.

Call immediately after closing the Fragment's options menu.

public void dispatchPause()

Moves all Fragments managed by the controller's FragmentManager into the pause state.

Call when Fragments should be paused.

public void dispatchPictureInPictureModeChanged(boolean isInPictureInPictureMode)

Lets all Fragments managed by the controller's FragmentManager know the picture-in-picture mode of the activity changed.

Call when the picture-in-picture mode of the activity changed.

public boolean dispatchPrepareOptionsMenu(@NonNull Menu menu)

Lets all Fragments managed by the controller's FragmentManager know they should prepare their options menu for display.

Call immediately before displaying the Fragment's options menu.

public void dispatchResume()

Moves all Fragments managed by the controller's FragmentManager into the resume state.

Call when Fragments should be resumed.

public void dispatchStart()

Moves all Fragments managed by the controller's FragmentManager into the start state.

Call when Fragments should be started.

public void dispatchStop()

Moves all Fragments managed by the controller's FragmentManager into the stop state.

Call when Fragments should be stopped.

public void doLoaderDestroy()

Destroys the loaders and, if their state is not being retained, removes them.

public void doLoaderRetain()

Retains the state of each of the loaders.

public void doLoaderStart()

Starts the loaders.

public void doLoaderStop(boolean retain)

Stops the loaders, optionally retaining their state. This is useful for keeping the loader state across configuration changes.

public void dumpLoaders(
    @NonNull String prefix,
    @Nullable FileDescriptor fd,
    @NonNull PrintWriter writer,
    @Nullable String[] args
)

Dumps the current state of the loaders.

public boolean execPendingActions()

Execute any pending actions for the Fragments managed by the controller's FragmentManager.

Call when queued actions can be performed [eg when the Fragment moves into a start or resume state].

public @Nullable Fragment findFragmentByWho(@NonNull String who)

Returns a fragment with the given identifier.

public @NonNull List<Fragment> getActiveFragments(List<Fragment> actives)

Returns the list of active fragments.

public int getActiveFragmentsCount()

Returns the number of active fragments.

public @NonNull FragmentManager getSupportFragmentManager()

Returns a FragmentManager for this controller.

public LoaderManager getSupportLoaderManager()

Returns a LoaderManager.

public void noteStateNotSaved()

Marks the fragment state as unsaved. This allows for "state loss" detection.

public @Nullable View onCreateView(
    @Nullable View parent,
    @NonNull String name,
    @NonNull Context context,
    @NonNull AttributeSet attrs
)

Instantiates a Fragment's view.

public void reportLoaderStart()

Lets the loaders know the host is ready to receive notifications.

public void restoreAllState(
    @Nullable Parcelable state,
    @Nullable FragmentManagerNonConfig nonConfig
)

Restores the saved state for all Fragments. The given FragmentManagerNonConfig are Fragment instances retained across configuration changes, including nested fragments

public void restoreAllState(
    @Nullable Parcelable state,
    @Nullable List<Fragment> nonConfigList
)

Restores the saved state for all Fragments. The given Fragment list are Fragment instances retained across configuration changes.

public void restoreLoaderNonConfig(
    SimpleArrayMap<String, LoaderManager> loaderManagers
)

Restores the saved state for all LoaderManagers. The given LoaderManager list are LoaderManager instances retained across configuration changes.

public void restoreSaveState(@Nullable Parcelable state)

Restores the saved state for all Fragments.

public @Nullable SimpleArrayMap<String, LoaderManager> retainLoaderNonConfig()

Returns a list of LoaderManagers that have opted to retain their instance across configuration changes.

public @Nullable FragmentManagerNonConfig retainNestedNonConfig()

Returns a nested tree of Fragments that have opted to retain their instance across configuration changes.

public @Nullable List<Fragment> retainNonConfig()

Returns a list of Fragments that have opted to retain their instance across configuration changes.

public @Nullable Parcelable saveAllState()

Saves the state for all Fragments.