added in version 24.1.0
belongs to Maven artifact com.android.support:support-fragment:28.0.0-alpha1

Summary: Methods | Inherited Methods | [Expand All]

FragmentController

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class FragmentController
extends Object

java.lang.Object
↳	android.support.v4.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 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) 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) Lets all Fragments managed by the controller's FragmentManager know the picture-in-picture mode of the activity changed.
boolean	dispatchPrepareOptionsMenu(Menu menu) Lets all Fragments managed by the controller's FragmentManager know they should prepare their options menu for display.
void	dispatchReallyStop()
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	doLoaderDestroy() This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
void	doLoaderRetain() This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
void	doLoaderStart() This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
void	doLoaderStop(boolean retain) This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
void	dumpLoaders(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
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.
List<Fragment>	getActiveFragments(List<Fragment> actives) Returns the list of active fragments.
int	getActiveFragmentsCount() Returns the number of active fragments.
FragmentManager	getSupportFragmentManager() Returns a FragmentManager for this controller.
LoaderManager	getSupportLoaderManager() This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
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() This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
void	restoreAllState(Parcelable state, List<Fragment> nonConfigList) This method was deprecated in API level 24.1.0. use restoreAllState(Parcelable, FragmentManagerNonConfig)
void	restoreAllState(Parcelable state, FragmentManagerNonConfig nonConfig) Restores the saved state for all Fragments.
void	restoreLoaderNonConfig(SimpleArrayMap<String, LoaderManager> loaderManagers) This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
SimpleArrayMap<String, LoaderManager>	retainLoaderNonConfig() This method was deprecated in API level 27.1.0. Loaders are managed separately from FragmentController
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.1.0. use retainNestedNonConfig() to also track retained nested child fragments
Parcelable	saveAllState() Saves the state for all Fragments.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public methods

attachHost

added in version 24.1.0

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 version 24.1.0

FragmentController createController (FragmentHostCallback<?> callbacks)

Returns a FragmentController.

Parameters
callbacks	FragmentHostCallback

Returns
FragmentController

dispatchActivityCreated

added in version 24.1.0

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.

See also:

• onActivityCreated(Bundle)

dispatchConfigurationChanged

added in version 24.1.0

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

See also:

• onConfigurationChanged(Configuration)

dispatchContextItemSelected

added in version 24.1.0

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

See also:

• onContextItemSelected(MenuItem)

dispatchCreate

added in version 24.1.0

void dispatchCreate ()

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

Call when Fragments should be created.

See also:

• onCreate(Bundle)

dispatchCreateOptionsMenu

added in version 24.1.0

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

See also:

• onCreateOptionsMenu(Menu, MenuInflater)

dispatchDestroy

added in version 24.1.0

void dispatchDestroy ()

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

Call when Fragments should be destroyed.

See also:

• onDestroy()

dispatchDestroyView

added in version 24.1.0

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:

• onDestroyView()

dispatchLowMemory

added in version 24.1.0

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:

• onLowMemory()

dispatchMultiWindowModeChanged

added in version 24.1.0

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.

Parameters
isInMultiWindowMode	boolean

See also:

• onMultiWindowModeChanged(boolean)

dispatchOptionsItemSelected

added in version 24.1.0

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

See also:

• onOptionsItemSelected(MenuItem)

dispatchOptionsMenuClosed

added in version 24.1.0

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

See also:

• onOptionsMenuClosed(Menu)

dispatchPause

added in version 24.1.0

void dispatchPause ()

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

Call when Fragments should be paused.

See also:

• onPause()

dispatchPictureInPictureModeChanged

added in version 24.1.0

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.

Parameters
isInPictureInPictureMode	boolean

See also:

• onPictureInPictureModeChanged(boolean)

dispatchPrepareOptionsMenu

added in version 24.1.0

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

See also:

• onPrepareOptionsMenu(Menu)

dispatchReallyStop

added in version 24.1.0

void dispatchReallyStop ()

dispatchResume

added in version 24.1.0

void dispatchResume ()

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

Call when Fragments should be resumed.

See also:

• onResume()

dispatchStart

added in version 24.1.0

void dispatchStart ()

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

Call when Fragments should be started.

See also:

• onStart()

dispatchStop

added in version 24.1.0

void dispatchStop ()

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

Call when Fragments should be stopped.

See also:

• onStop()

doLoaderDestroy

added in version 24.1.0

void doLoaderDestroy ()

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

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

doLoaderRetain

added in version 24.1.0

void doLoaderRetain ()

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

Retains the state of each of the loaders.

doLoaderStart

added in version 24.1.0

void doLoaderStart ()

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

Starts the loaders.

doLoaderStop

added in version 24.1.0

void doLoaderStop (boolean retain)

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

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 version 24.1.0

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

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

Dumps the current state of the loaders.

Parameters
prefix	String
fd	FileDescriptor
writer	PrintWriter
args	String

execPendingActions

added in version 24.1.0

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 version 25.1.0

Fragment findFragmentByWho (String who)

Returns a fragment with the given identifier.

Parameters
who	String

Returns
Fragment

getActiveFragments

added in version 24.1.0

List<Fragment> getActiveFragments (List<Fragment> actives)

Returns the list of active fragments.

Parameters
actives	List

Returns
List<Fragment>

getActiveFragmentsCount

added in version 24.1.0

int getActiveFragmentsCount ()

Returns the number of active fragments.

Returns
int

getSupportFragmentManager

added in version 24.1.0

FragmentManager getSupportFragmentManager ()

Returns a FragmentManager for this controller.

Returns
FragmentManager

getSupportLoaderManager

added in version 24.1.0

LoaderManager getSupportLoaderManager ()

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

Returns a LoaderManager.

Returns
LoaderManager

noteStateNotSaved

added in version 24.1.0

void noteStateNotSaved ()

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

onCreateView

added in version 24.1.0

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 version 24.1.0

void reportLoaderStart ()

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

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

restoreAllState

added in version 24.1.0

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

This method was deprecated in API level 24.1.0.
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:

• retainNonConfig()

restoreAllState

added in version 24.1.0

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

See also:

• retainNestedNonConfig()

restoreLoaderNonConfig

added in version 24.1.0

void restoreLoaderNonConfig (SimpleArrayMap<String, LoaderManager> loaderManagers)

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

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

Parameters
loaderManagers	SimpleArrayMap

See also:

• retainLoaderNonConfig()

retainLoaderNonConfig

added in version 24.1.0

SimpleArrayMap<String, LoaderManager> retainLoaderNonConfig ()

This method was deprecated in API level 27.1.0.
Loaders are managed separately from FragmentController

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

Returns
SimpleArrayMap<String, LoaderManager>

retainNestedNonConfig

added in version 24.1.0

FragmentManagerNonConfig retainNestedNonConfig ()

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

Returns
FragmentManagerNonConfig

retainNonConfig

added in version 24.1.0

List<Fragment> retainNonConfig ()

This method was deprecated in API level 24.1.0.
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 version 24.1.0

Parcelable saveAllState ()

Saves the state for all Fragments.

Returns
Parcelable

• Annotations

  • NotificationCompat.Action.SemanticAction

• Interfaces

  • ActionBarDrawerToggle.Delegate
  • ActionBarDrawerToggle.DelegateProvider
  • ActivityCompat.OnRequestPermissionsResultCallback
  • ActivityCompat.PermissionCompatDelegate
  • FragmentManager.BackStackEntry
  • FragmentManager.OnBackStackChangedListener
  • LoaderManager.LoaderCallbacks
  • NotificationCompat.Action.Extender
  • NotificationCompat.Extender
  • SharedElementCallback.OnSharedElementsReadyListener
  • TaskStackBuilder.SupportParentable

• Classes

  • ActionBarDrawerToggle
  • ActivityCompat
  • ActivityManagerCompat
  • ActivityOptionsCompat
  • AlarmManagerCompat
  • AppLaunchChecker
  • AppOpsManagerCompat
  • BundleCompat
  • DialogFragment
  • Fragment
  • Fragment.SavedState
  • FragmentActivity
  • FragmentContainer
  • FragmentController
  • FragmentHostCallback
  • FragmentManager
  • FragmentManager.FragmentLifecycleCallbacks
  • FragmentManagerNonConfig
  • FragmentPagerAdapter
  • FragmentStatePagerAdapter
  • FragmentTabHost
  • FragmentTransaction
  • FrameMetricsAggregator
  • JobIntentService
  • ListFragment
  • LoaderManager
  • NavUtils
  • NotificationCompat
  • NotificationCompat.Action
  • NotificationCompat.Action.Builder
  • NotificationCompat.Action.WearableExtender
  • NotificationCompat.BigPictureStyle
  • NotificationCompat.BigTextStyle
  • NotificationCompat.Builder
  • NotificationCompat.CarExtender
  • NotificationCompat.CarExtender.UnreadConversation
  • NotificationCompat.CarExtender.UnreadConversation.Builder
  • NotificationCompat.DecoratedCustomViewStyle
  • NotificationCompat.InboxStyle
  • NotificationCompat.MessagingStyle
  • NotificationCompat.MessagingStyle.Message
  • NotificationCompat.Style
  • NotificationCompat.WearableExtender
  • NotificationCompatExtras
  • NotificationCompatSideChannelService
  • NotificationManagerCompat
  • RemoteInput
  • RemoteInput.Builder
  • ServiceCompat
  • ShareCompat
  • ShareCompat.IntentBuilder
  • ShareCompat.IntentReader
  • SharedElementCallback
  • TaskStackBuilder

• Exceptions

  • Fragment.InstantiationException