Added in API level 23
Deprecated in API level 28

FragmentController

Kotlin |Java

open class FragmentController

kotlin.Any
↳	android.app.FragmentController

Provides integration points with a FragmentManager for a fragment host.

It is the responsibility of the host to take care of the Fragment's lifecycle. The methods provided by FragmentController are for that purpose.

Summary

Public methods
open Unit	`attachHost(parent: Fragment!)` Attaches the host to the FragmentManager for this controller.
static FragmentController!	`createController(callbacks: FragmentHostCallback<*>!)` Returns a `FragmentController`.
open Unit	`dispatchActivityCreated()` Moves all Fragments managed by the controller's FragmentManager into the activity created state.
open Unit	`dispatchConfigurationChanged(newConfig: Configuration!)` Lets all Fragments managed by the controller's FragmentManager know a configuration change occurred.
open Boolean	`dispatchContextItemSelected(item: MenuItem!)` Sends a context item selection event to the Fragments managed by the controller's FragmentManager.
open Unit	`dispatchCreate()` Moves all Fragments managed by the controller's FragmentManager into the create state.
open Boolean	`dispatchCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!)` Lets all Fragments managed by the controller's FragmentManager know they should create an options menu.
open Unit	`dispatchDestroy()` Moves all Fragments managed by the controller's FragmentManager into the destroy state.
open Unit	`dispatchDestroyView()` Moves all Fragments managed by the controller's FragmentManager into the destroy view state.
open Unit	`dispatchLowMemory()` Lets all Fragments managed by the controller's FragmentManager know the device is in a low memory condition.
open Unit	`dispatchMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Lets all Fragments managed by the controller's FragmentManager know the multi-window mode of the activity changed.
open Unit	`dispatchMultiWindowModeChanged(isInMultiWindowMode: Boolean, newConfig: Configuration!)` Lets all Fragments managed by the controller's FragmentManager know the multi-window mode of the activity changed.
open Boolean	`dispatchOptionsItemSelected(item: MenuItem!)` Sends an option item selection event to the Fragments managed by the controller's FragmentManager.
open Unit	`dispatchOptionsMenuClosed(menu: Menu!)` Lets all Fragments managed by the controller's FragmentManager know their options menu has closed.
open Unit	`dispatchPause()` Moves all Fragments managed by the controller's FragmentManager into the pause state.
open Unit	`dispatchPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Lets all Fragments managed by the controller's FragmentManager know the picture-in-picture mode of the activity changed.
open Unit	`dispatchPictureInPictureModeChanged(isInPictureInPictureMode: Boolean, newConfig: Configuration!)` Lets all Fragments managed by the controller's FragmentManager know the picture-in-picture mode of the activity changed.
open Boolean	`dispatchPrepareOptionsMenu(menu: Menu!)` Lets all Fragments managed by the controller's FragmentManager know they should prepare their options menu for display.
open Unit	`dispatchResume()` Moves all Fragments managed by the controller's FragmentManager into the resume state.
open Unit	`dispatchStart()` Moves all Fragments managed by the controller's FragmentManager into the start state.
open Unit	`dispatchStop()` Moves all Fragments managed by the controller's FragmentManager into the stop state.
open Unit	`dispatchTrimMemory(level: Int)` Lets all Fragments managed by the controller's FragmentManager know they should trim their memory usage.
open Unit	`doLoaderDestroy()` Destroys the loaders and, if their state is not being retained, removes them.
open Unit	`doLoaderStart()` Starts the loaders.
open Unit	`doLoaderStop(retain: Boolean)` Stops the loaders, optionally retaining their state.
open Unit	`dumpLoaders(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)` Dumps the current state of the loaders.
open Boolean	`execPendingActions()` Execute any pending actions for the Fragments managed by the controller's FragmentManager.
open Fragment?	`findFragmentByWho(who: String!)` Returns a fragment with the given identifier.
open FragmentManager!	`getFragmentManager()` Returns a `FragmentManager` for this controller.
open LoaderManager!	`getLoaderManager()` Returns a `LoaderManager`.
open Unit	`noteStateNotSaved()` Marks the fragment state as unsaved.
open View!	`onCreateView(parent: View!, name: String!, context: Context!, attrs: AttributeSet!)` Instantiates a Fragment's view.
open Unit	`reportLoaderStart()` Lets the loaders know the host is ready to receive notifications.
open Unit	`restoreAllState(state: Parcelable!, nonConfigList: MutableList<Fragment!>!)` Restores the saved state for all Fragments.
open Unit	`restoreAllState(state: Parcelable!, nonConfig: FragmentManagerNonConfig!)` Restores the saved state for all Fragments.
open Unit	`restoreLoaderNonConfig(loaderManagers: ArrayMap<String!, LoaderManager!>!)` Restores the saved state for all LoaderManagers.
open ArrayMap<String!, LoaderManager!>!	`retainLoaderNonConfig()` Returns a list of LoaderManagers that have opted to retain their instance across configuration changes.
open FragmentManagerNonConfig!	`retainNestedNonConfig()` Returns a nested tree of Fragments that have opted to retain their instance across configuration changes.
open MutableList<Fragment!>!	`retainNonConfig()` Returns a list of Fragments that have opted to retain their instance across configuration changes.
open Parcelable!	`saveAllState()` Saves the state for all Fragments.

Public methods

attachHost

Added in API level 23
Deprecated in API level 28

open fun attachHost(parent: Fragment!): Unit

Deprecated.

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

createController

Added in API level 23
Deprecated in API level 28

static fun createController(callbacks: FragmentHostCallback<*>!): FragmentController!

Deprecated.

Returns a FragmentController.

dispatchActivityCreated

Added in API level 23
Deprecated in API level 28

open fun dispatchActivityCreated(): Unit

Deprecated.

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.

See Also

android.app.Fragment#onActivityCreated(Bundle)

dispatchConfigurationChanged

Added in API level 23
Deprecated in API level 28

open fun dispatchConfigurationChanged(newConfig: Configuration!): Unit

Deprecated.

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

Call when there is a configuration change.

See Also

android.app.Fragment#onConfigurationChanged(Configuration)

dispatchContextItemSelected

Added in API level 23
Deprecated in API level 28

open fun dispatchContextItemSelected(item: MenuItem!): Boolean

Deprecated.

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

Return
`Boolean`	`true` if the context menu selection event was consumed

See Also

android.app.Fragment#onContextItemSelected(MenuItem)

dispatchCreate

Added in API level 23
Deprecated in API level 28

open fun dispatchCreate(): Unit

Deprecated.

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

Call when Fragments should be created.

See Also

android.app.Fragment#onCreate(Bundle)

dispatchCreateOptionsMenu

Added in API level 23
Deprecated in API level 28

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

Deprecated.

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.

Return
`Boolean`	`true` if the options menu contains items to display

See Also

android.app.Fragment#onCreateOptionsMenu(Menu, MenuInflater)

dispatchDestroy

Added in API level 23
Deprecated in API level 28

open fun dispatchDestroy(): Unit

Deprecated.

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

Call when Fragments should be destroyed.

See Also

android.app.Fragment#onDestroy()

dispatchDestroyView

Added in API level 23
Deprecated in API level 28

open fun dispatchDestroyView(): Unit

Deprecated.

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

Call when the Fragment's views should be destroyed.

See Also

android.app.Fragment#onDestroyView()

dispatchLowMemory

Added in API level 23
Deprecated in API level 28

open fun dispatchLowMemory(): Unit

Deprecated.

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.

See Also

android.app.Fragment#onLowMemory()

dispatchMultiWindowModeChanged

Added in API level 24
Deprecated in API level 26

open fun dispatchMultiWindowModeChanged(isInMultiWindowMode: Boolean): Unit

Deprecated: use dispatchMultiWindowModeChanged(boolean,android.content.res.Configuration)

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.

See Also

Fragment#onMultiWindowModeChanged

dispatchMultiWindowModeChanged

Added in API level 26
Deprecated in API level 28

open fun dispatchMultiWindowModeChanged(
    isInMultiWindowMode: Boolean, 
    newConfig: Configuration!
): Unit

Deprecated.

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.

See Also

Fragment#onMultiWindowModeChanged

dispatchOptionsItemSelected

Added in API level 23
Deprecated in API level 28

open fun dispatchOptionsItemSelected(item: MenuItem!): Boolean

Deprecated.

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

Return
`Boolean`	`true` if the options menu selection event was consumed

See Also

android.app.Fragment#onOptionsItemSelected(MenuItem)

dispatchOptionsMenuClosed

Added in API level 23
Deprecated in API level 28

open fun dispatchOptionsMenuClosed(menu: Menu!): Unit

Deprecated.

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

Call immediately after closing the Fragment's options menu.

See Also

android.app.Fragment#onOptionsMenuClosed(Menu)

dispatchPause

Added in API level 23
Deprecated in API level 28

open fun dispatchPause(): Unit

Deprecated.

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

Call when Fragments should be paused.

See Also

android.app.Fragment#onPause()

dispatchPictureInPictureModeChanged

Added in API level 24
Deprecated in API level 26

open fun dispatchPictureInPictureModeChanged(isInPictureInPictureMode: Boolean): Unit

Deprecated: use dispatchPictureInPictureModeChanged(boolean,android.content.res.Configuration)

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.

See Also

Fragment#onPictureInPictureModeChanged

dispatchPictureInPictureModeChanged

Added in API level 26
Deprecated in API level 28

open fun dispatchPictureInPictureModeChanged(
    isInPictureInPictureMode: Boolean, 
    newConfig: Configuration!
): Unit

Deprecated.

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.

See Also

Fragment#onPictureInPictureModeChanged

dispatchPrepareOptionsMenu

Added in API level 23
Deprecated in API level 28

open fun dispatchPrepareOptionsMenu(menu: Menu!): Boolean

Deprecated.

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.

Return
`Boolean`	`true` if the options menu contains items to display

See Also

android.app.Fragment#onPrepareOptionsMenu(Menu)

dispatchResume

Added in API level 23
Deprecated in API level 28

open fun dispatchResume(): Unit

Deprecated.

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

Call when Fragments should be resumed.

See Also

android.app.Fragment#onResume()

dispatchStart

Added in API level 23
Deprecated in API level 28

open fun dispatchStart(): Unit

Deprecated.

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

Call when Fragments should be started.

See Also

android.app.Fragment#onStart()

dispatchStop

Added in API level 23
Deprecated in API level 28

open fun dispatchStop(): Unit

Deprecated.

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

Call when Fragments should be stopped.

See Also

android.app.Fragment#onStop()

dispatchTrimMemory

Added in API level 23
Deprecated in API level 28

open fun dispatchTrimMemory(level: Int): Unit

Deprecated.

Lets all Fragments managed by the controller's FragmentManager know they should trim their memory usage.

Call when the Fragment can release allocated memory [such as if the Fragment is in the background].

See Also

android.app.Fragment#onTrimMemory(int)

doLoaderDestroy

Added in API level 23
Deprecated in API level 28

open fun doLoaderDestroy(): Unit

Deprecated.

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

doLoaderStart

Added in API level 23
Deprecated in API level 28

open fun doLoaderStart(): Unit

Deprecated.

Starts the loaders.

doLoaderStop

Added in API level 23
Deprecated in API level 28

open fun doLoaderStop(retain: Boolean): Unit

Deprecated.

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

Parameters
`retain`	Boolean: When `true`, the loaders aren't stopped, but, their instances are retained in a started state

dumpLoaders

Added in API level 23
Deprecated in API level 28

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

Deprecated.

Dumps the current state of the loaders.

execPendingActions

Added in API level 23
Deprecated in API level 28

open fun execPendingActions(): Boolean

Deprecated.

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

Return
`Boolean`	`true` if queued actions were performed

findFragmentByWho

Added in API level 23
Deprecated in API level 28

open fun findFragmentByWho(who: String!): Fragment?

Deprecated.

Returns a fragment with the given identifier.

Return
`Fragment?`	This value may be `null`.

getFragmentManager

Added in API level 23
Deprecated in API level 28

open fun getFragmentManager(): FragmentManager!

Deprecated.

Returns a FragmentManager for this controller.

getLoaderManager

Added in API level 23
Deprecated in API level 28

open fun getLoaderManager(): LoaderManager!

Deprecated.

Returns a LoaderManager.

noteStateNotSaved

Added in API level 23
Deprecated in API level 28

open fun noteStateNotSaved(): Unit

Deprecated.

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

onCreateView

Added in API level 23
Deprecated in API level 28

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

Deprecated.

Instantiates a Fragment's view.

Parameters
`parent`	View!: The parent that the created view will be placed in; note that this may be null.
`name`	String!: Tag name to be inflated.
`context`	Context!: The context the view is being created in.
`attrs`	AttributeSet!: Inflation attributes as specified in XML file.

Return
`View!`	view the newly created view

reportLoaderStart

Added in API level 23
Deprecated in API level 28

open fun reportLoaderStart(): Unit

Deprecated.

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

restoreAllState

Added in API level 23
Deprecated in API level 24

open fun restoreAllState(
    state: Parcelable!, 
    nonConfigList: MutableList<Fragment!>!
): Unit

Deprecated: use restoreAllState(android.os.Parcelable,android.app.FragmentManagerNonConfig)

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

See Also

#retainNonConfig()

restoreAllState

Added in API level 24
Deprecated in API level 28

open fun restoreAllState(
    state: Parcelable!, 
    nonConfig: FragmentManagerNonConfig!
): Unit

Deprecated.

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

See Also

#retainNestedNonConfig()

restoreLoaderNonConfig

Added in API level 23
Deprecated in API level 28

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

Deprecated.

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

See Also

#retainLoaderNonConfig()

retainLoaderNonConfig

Added in API level 23
Deprecated in API level 28

open fun retainLoaderNonConfig(): ArrayMap<String!, LoaderManager!>!

Deprecated.

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

retainNestedNonConfig

Added in API level 24
Deprecated in API level 28

open fun retainNestedNonConfig(): FragmentManagerNonConfig!

Deprecated.

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

retainNonConfig

Added in API level 23
Deprecated in API level 24

open fun retainNonConfig(): MutableList<Fragment!>!

Deprecated: use retainNestedNonConfig() to also track retained nested child fragments

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

saveAllState

Added in API level 23
Deprecated in API level 28

open fun saveAllState(): Parcelable!

Deprecated.

Saves the state for all Fragments.