Skip to content

Most visited

Recently visited

navigation

FragmentController

public class FragmentController
extends Object

java.lang.Object
   ↳ 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

void attachHost(Fragment parent)

Attaches the host to the FragmentManager for this controller.

static final FragmentController createController(FragmentHostCallback<?> callbacks)

Returns a FragmentController.

void dispatchActivityCreated()

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

void dispatchConfigurationChanged(Configuration newConfig)

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

boolean dispatchContextItemSelected(MenuItem item)

Sends a context item selection event to the Fragments managed by the controller's FragmentManager.

void dispatchCreate()

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

boolean dispatchCreateOptionsMenu(Menu menu, MenuInflater inflater)

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

void dispatchDestroy()

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

void dispatchDestroyView()

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

void dispatchLowMemory()

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

void dispatchMultiWindowModeChanged(boolean isInMultiWindowMode)

This method was deprecated in API level 26. use dispatchMultiWindowModeChanged(boolean, Configuration)

void dispatchMultiWindowModeChanged(boolean isInMultiWindowMode, Configuration newConfig)

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

boolean dispatchOptionsItemSelected(MenuItem item)

Sends an option item selection event to the Fragments managed by the controller's FragmentManager.

void dispatchOptionsMenuClosed(Menu menu)

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

void dispatchPause()

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

void dispatchPictureInPictureModeChanged(boolean isInPictureInPictureMode, Configuration newConfig)

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

void dispatchPictureInPictureModeChanged(boolean isInPictureInPictureMode)

This method was deprecated in API level 26. use dispatchPictureInPictureModeChanged(boolean, Configuration)

boolean dispatchPrepareOptionsMenu(Menu menu)

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

void dispatchResume()

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

void dispatchStart()

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

void dispatchStop()

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

void dispatchTrimMemory(int level)

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

void doLoaderDestroy()

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

void doLoaderStart()

Starts the loaders.

void doLoaderStop(boolean retain)

Stops the loaders, optionally retaining their state.

void dumpLoaders(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)

Dumps the current state of the loaders.

boolean execPendingActions()

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

Fragment findFragmentByWho(String who)

Returns a fragment with the given identifier.

FragmentManager getFragmentManager()

Returns a FragmentManager for this controller.

LoaderManager getLoaderManager()

Returns a LoaderManager.

void noteStateNotSaved()

Marks the fragment state as unsaved.

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

Instantiates a Fragment's view.

void reportLoaderStart()

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

void restoreAllState(Parcelable state, FragmentManagerNonConfig nonConfig)

Restores the saved state for all Fragments.

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

This method was deprecated in API level 24. use restoreAllState(Parcelable, FragmentManagerNonConfig)

void restoreLoaderNonConfig(ArrayMap<StringLoaderManager> loaderManagers)

Restores the saved state for all LoaderManagers.

ArrayMap<StringLoaderManager> retainLoaderNonConfig()

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

FragmentManagerNonConfig retainNestedNonConfig()

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

List<Fragment> retainNonConfig()

This method was deprecated in API level 24. use retainNestedNonConfig() to also track retained nested child fragments

Parcelable saveAllState()

Saves the state for all Fragments.

Inherited methods

From class java.lang.Object

Public methods

attachHost

added in API level 23
void attachHost (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.

Parameters
parent Fragment

createController

added in API level 23
FragmentController createController (FragmentHostCallback<?> callbacks)

Returns a FragmentController.

Parameters
callbacks FragmentHostCallback

Returns
FragmentController

dispatchActivityCreated

added in API level 23
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.

dispatchConfigurationChanged

added in API level 23
void dispatchConfigurationChanged (Configuration newConfig)

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

Call when there is a configuration change.

Parameters
newConfig Configuration

dispatchContextItemSelected

added in API level 23
boolean dispatchContextItemSelected (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

Parameters
item MenuItem

Returns
boolean true if the context menu selection event was consumed

dispatchCreate

added in API level 23
void dispatchCreate ()

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

Call when Fragments should be created.

See also:

dispatchCreateOptionsMenu

added in API level 23
boolean dispatchCreateOptionsMenu (Menu menu, 
                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.

Parameters
menu Menu

inflater MenuInflater

Returns
boolean true if the options menu contains items to display

dispatchDestroy

added in API level 23
void dispatchDestroy ()

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

Call when Fragments should be destroyed.

See also:

dispatchDestroyView

added in API level 23
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.

See also:

dispatchLowMemory

added in API level 23
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.

See also:

dispatchMultiWindowModeChanged

added in API level 24
void dispatchMultiWindowModeChanged (boolean isInMultiWindowMode)

This method was deprecated in API level 26.
use dispatchMultiWindowModeChanged(boolean, 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.

Parameters
isInMultiWindowMode boolean

dispatchMultiWindowModeChanged

added in API level 26
void dispatchMultiWindowModeChanged (boolean isInMultiWindowMode, 
                Configuration newConfig)

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.

Parameters
isInMultiWindowMode boolean

newConfig Configuration

dispatchOptionsItemSelected

added in API level 23
boolean dispatchOptionsItemSelected (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

Parameters
item MenuItem

Returns
boolean true if the options menu selection event was consumed

dispatchOptionsMenuClosed

added in API level 23
void dispatchOptionsMenuClosed (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.

Parameters
menu Menu

dispatchPause

added in API level 23
void dispatchPause ()

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

Call when Fragments should be paused.

See also:

dispatchPictureInPictureModeChanged

added in API level 26
void dispatchPictureInPictureModeChanged (boolean isInPictureInPictureMode, 
                Configuration newConfig)

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.

Parameters
isInPictureInPictureMode boolean

newConfig Configuration

dispatchPictureInPictureModeChanged

added in API level 24
void dispatchPictureInPictureModeChanged (boolean isInPictureInPictureMode)

This method was deprecated in API level 26.
use dispatchPictureInPictureModeChanged(boolean, 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.

Parameters
isInPictureInPictureMode boolean

dispatchPrepareOptionsMenu

added in API level 23
boolean dispatchPrepareOptionsMenu (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.

Parameters
menu Menu

Returns
boolean true if the options menu contains items to display

dispatchResume

added in API level 23
void dispatchResume ()

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

Call when Fragments should be resumed.

See also:

dispatchStart

added in API level 23
void dispatchStart ()

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

Call when Fragments should be started.

See also:

dispatchStop

added in API level 23
void dispatchStop ()

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

Call when Fragments should be stopped.

See also:

dispatchTrimMemory

added in API level 23
void dispatchTrimMemory (int level)

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

Parameters
level int

See also:

doLoaderDestroy

added in API level 23
void doLoaderDestroy ()

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

doLoaderStart

added in API level 23
void doLoaderStart ()

Starts the loaders.

doLoaderStop

added in API level 23
void doLoaderStop (boolean retain)

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
void dumpLoaders (String prefix, 
                FileDescriptor fd, 
                PrintWriter writer, 
                String[] args)

Dumps the current state of the loaders.

Parameters
prefix String

fd FileDescriptor

writer PrintWriter

args String

execPendingActions

added in API level 23
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].

Returns
boolean true if queued actions were performed

findFragmentByWho

added in API level 23
Fragment findFragmentByWho (String who)

Returns a fragment with the given identifier.

Parameters
who String

Returns
Fragment

This value may be null.

getFragmentManager

added in API level 23
FragmentManager getFragmentManager ()

Returns a FragmentManager for this controller.

Returns
FragmentManager

getLoaderManager

added in API level 23
LoaderManager getLoaderManager ()

Returns a LoaderManager.

Returns
LoaderManager

noteStateNotSaved

added in API level 23
void noteStateNotSaved ()

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

onCreateView

added in API level 23
View onCreateView (View parent, 
                String name, 
                Context context, 
                AttributeSet attrs)

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.

Returns
View view the newly created view

reportLoaderStart

added in API level 23
void reportLoaderStart ()

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

restoreAllState

added in API level 24
void restoreAllState (Parcelable state, 
                FragmentManagerNonConfig nonConfig)

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

Parameters
state Parcelable

nonConfig FragmentManagerNonConfig

restoreAllState

added in API level 23
void restoreAllState (Parcelable state, 
                List<Fragment> nonConfigList)

This method was deprecated in API level 24.
use restoreAllState(Parcelable, FragmentManagerNonConfig)

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

Parameters
state Parcelable

nonConfigList List

See also:

restoreLoaderNonConfig

added in API level 23
void restoreLoaderNonConfig (ArrayMap<StringLoaderManager> loaderManagers)

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

Parameters
loaderManagers ArrayMap

retainLoaderNonConfig

added in API level 23
ArrayMap<StringLoaderManager> retainLoaderNonConfig ()

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

Returns
ArrayMap<StringLoaderManager>

retainNestedNonConfig

added in API level 24
FragmentManagerNonConfig retainNestedNonConfig ()

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

Returns
FragmentManagerNonConfig

retainNonConfig

added in API level 23
List<Fragment> retainNonConfig ()

This method was deprecated in API level 24.
use retainNestedNonConfig() to also track retained nested child fragments

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

Returns
List<Fragment>

saveAllState

added in API level 23
Parcelable saveAllState ()

Saves the state for all Fragments.

Returns
Parcelable

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)