FragmentController

fun attachHost(parent: Fragment?): Unit

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

java-static fun createController(callbacks: FragmentHostCallback<Any!>): FragmentController

Returns a FragmentController.

fun dispatchActivityCreated(): Unit

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.

fun dispatchConfigurationChanged(newConfig: Configuration): Unit

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

Call when there is a configuration change.

fun dispatchContextItemSelected(item: MenuItem): Boolean

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

fun dispatchCreate(): Unit

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

Call when Fragments should be created.

fun dispatchCreateOptionsMenu(menu: Menu, inflater: MenuInflater): Boolean

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.

fun dispatchDestroy(): Unit

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.

fun dispatchDestroyView(): Unit

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

Call when the Fragment's views should be destroyed.

fun dispatchLowMemory(): Unit

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.

fun dispatchMultiWindowModeChanged(isInMultiWindowMode: Boolean): Unit

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.

fun dispatchOptionsItemSelected(item: MenuItem): Boolean

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

fun dispatchOptionsMenuClosed(menu: Menu): Unit

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

Call immediately after closing the Fragment's options menu.

fun dispatchPause(): Unit

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

Call when Fragments should be paused.

fun dispatchPictureInPictureModeChanged(isInPictureInPictureMode: Boolean): Unit

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.

fun dispatchPrepareOptionsMenu(menu: Menu): Boolean

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.

fun dispatchReallyStop(): Unit

fun dispatchResume(): Unit

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

Call when Fragments should be resumed.

fun dispatchStart(): Unit

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

Call when Fragments should be started.

fun dispatchStop(): Unit

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

Call when Fragments should be stopped.

fun doLoaderDestroy(): Unit

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

fun doLoaderRetain(): Unit

Retains the state of each of the loaders.

fun doLoaderStart(): Unit

Starts the loaders.

fun doLoaderStop(retain: Boolean): Unit

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

fun dumpLoaders(
    prefix: String,
    fd: FileDescriptor?,
    writer: PrintWriter,
    args: Array<String!>?
): Unit

Dumps the current state of the loaders.

fun execPendingActions(): Boolean

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].

fun findFragmentByWho(who: String): Fragment?

Returns a fragment with the given identifier.

fun getActiveFragments(actives: (Mutable)List<Fragment!>!): (Mutable)List<Fragment!>

Returns the list of active fragments.

fun getActiveFragmentsCount(): Int

Returns the number of active fragments.

fun getSupportFragmentManager(): FragmentManager

Returns a FragmentManager for this controller.

fun getSupportLoaderManager(): LoaderManager!

Returns a LoaderManager.

fun noteStateNotSaved(): Unit

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

fun onCreateView(
    parent: View?,
    name: String,
    context: Context,
    attrs: AttributeSet
): View?

Instantiates a Fragment's view.

fun reportLoaderStart(): Unit

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

fun restoreAllState(state: Parcelable?, nonConfig: FragmentManagerNonConfig?): Unit

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

fun restoreAllState(
    state: Parcelable?,
    nonConfigList: (Mutable)List<Fragment!>?
): Unit

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

fun restoreLoaderNonConfig(
    loaderManagers: SimpleArrayMap<String!, LoaderManager!>!
): Unit

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

fun restoreSaveState(state: Parcelable?): Unit

Restores the saved state for all Fragments.

fun retainLoaderNonConfig(): SimpleArrayMap<String!, LoaderManager!>?

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

fun retainNestedNonConfig(): FragmentManagerNonConfig?

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

fun retainNonConfig(): (Mutable)List<Fragment!>?

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

fun saveAllState(): Parcelable?

Saves the state for all Fragments.