Summary: Methods | Inherited Methods

FragmentController

Kotlin |Java

public class FragmentController
extends Object

java.lang.Object
↳	androidx.fragment.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 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()` This method is deprecated. This functionality has been rolled into `dispatchStop()`.
`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 is deprecated. Loaders are managed separately from FragmentController
`void`	`doLoaderRetain()` This method is deprecated. Loaders are managed separately from FragmentController
`void`	`doLoaderStart()` This method is deprecated. Loaders are managed separately from FragmentController
`void`	`doLoaderStop(boolean retain)` This method is deprecated. Loaders are managed separately from FragmentController
`void`	`dumpLoaders(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` This method is deprecated. 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 is deprecated. Loaders are managed separately from FragmentController and this now throws an `UnsupportedOperationException`. Use `LoaderManager.getInstance(T)` to obtain 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()` This method is deprecated. Loaders are managed separately from FragmentController
`void`	`restoreAllState(Parcelable state, FragmentManagerNonConfig nonConfig)` This method is deprecated. Have your `FragmentHostCallback` implement `ViewModelStoreOwner` to automatically restore the Fragment's non configuration state and use `restoreSaveState(Parcelable)` to restore the Fragment's save state.
`void`	`restoreAllState(Parcelable state, List<Fragment> nonConfigList)` This method is deprecated. Have your `FragmentHostCallback` implement `ViewModelStoreOwner` to automatically restore the Fragment's non configuration state and use `restoreSaveState(Parcelable)` to restore the Fragment's save state.
`void`	`restoreLoaderNonConfig(SimpleArrayMap<String, LoaderManager> loaderManagers)` This method is deprecated. Loaders are managed separately from FragmentController
`void`	`restoreSaveState(Parcelable state)` Restores the saved state for all Fragments.
`SimpleArrayMap<String, LoaderManager>`	`retainLoaderNonConfig()` This method is deprecated. Loaders are managed separately from FragmentController
`FragmentManagerNonConfig`	`retainNestedNonConfig()` This method is deprecated. Have your `FragmentHostCallback` implement `ViewModelStoreOwner` to automatically retain the Fragment's non configuration state.
`List<Fragment>`	`retainNonConfig()` This method is deprecated. Have your `FragmentHostCallback` implement `ViewModelStoreOwner` to automatically retain the Fragment's non configuration state.
`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

public 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

public static FragmentController createController (FragmentHostCallback<?> callbacks)

Returns a FragmentController.

Parameters
`callbacks`	`FragmentHostCallback`

Returns
`FragmentController`

dispatchActivityCreated

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.

See also:

Fragment.onActivityCreated(Bundle)

dispatchConfigurationChanged

public 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:

Fragment.onConfigurationChanged(Configuration)

dispatchContextItemSelected

public 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:

Fragment.onContextItemSelected(MenuItem)

dispatchCreate

public void dispatchCreate ()

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

Call when Fragments should be created.

See also:

Fragment.onCreate(Bundle)

public 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:

Fragment.onCreateOptionsMenu(Menu, MenuInflater)

dispatchDestroy

public void dispatchDestroy ()

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

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

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

Call when Fragments should be destroyed.

See also:

Fragment.onDestroy()

dispatchDestroyView

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.

See also:

Fragment.onDestroyView()

dispatchLowMemory

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.

See also:

Fragment.onLowMemory()

dispatchMultiWindowModeChanged

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.

Parameters
`isInMultiWindowMode`	`boolean`

See also:

Fragment.onMultiWindowModeChanged(boolean)

dispatchOptionsItemSelected

public 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:

Fragment.onOptionsItemSelected(MenuItem)

public 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:

Fragment.onOptionsMenuClosed(Menu)

dispatchPause

public void dispatchPause ()

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

Call when Fragments should be paused.

See also:

Fragment.onPause()

dispatchPictureInPictureModeChanged

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.

Parameters
`isInPictureInPictureMode`	`boolean`

See also:

Fragment.onPictureInPictureModeChanged(boolean)

public 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:

Fragment.onPrepareOptionsMenu(Menu)

dispatchReallyStop

public void dispatchReallyStop ()

This method is deprecated.
This functionality has been rolled into dispatchStop().

dispatchResume

public void dispatchResume ()

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

Call when Fragments should be resumed.

See also:

Fragment.onResume()

dispatchStart

public void dispatchStart ()

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

Call when Fragments should be started.

See also:

Fragment.onStart()

dispatchStop

public void dispatchStop ()

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

Call when Fragments should be stopped.

See also:

Fragment.onStop()

doLoaderDestroy

public void doLoaderDestroy ()

This method is deprecated.
Loaders are managed separately from FragmentController

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

doLoaderRetain

public void doLoaderRetain ()

This method is deprecated.
Loaders are managed separately from FragmentController

Retains the state of each of the loaders.

doLoaderStart

public void doLoaderStart ()

This method is deprecated.
Loaders are managed separately from FragmentController

Starts the loaders.

doLoaderStop

public void doLoaderStop (boolean retain)

This method is deprecated.
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

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

This method is deprecated.
Loaders are managed separately from FragmentController

Dumps the current state of the loaders.

Parameters
`prefix`	`String`
`fd`	`FileDescriptor`
`writer`	`PrintWriter`
`args`	`String`

execPendingActions

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

Returns
`boolean`	`true` if queued actions were performed

findFragmentByWho

public Fragment findFragmentByWho (String who)

Returns a fragment with the given identifier.

Parameters
`who`	`String`

Returns
`Fragment`

getActiveFragments

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

Returns the list of active fragments.

Parameters
`actives`	`List`

Returns
`List<Fragment>`

getActiveFragmentsCount

public int getActiveFragmentsCount ()

Returns the number of active fragments.

Returns
`int`

getSupportFragmentManager

public FragmentManager getSupportFragmentManager ()

Returns a FragmentManager for this controller.

Returns
`FragmentManager`

getSupportLoaderManager

public LoaderManager getSupportLoaderManager ()

This method is deprecated.
Loaders are managed separately from FragmentController and this now throws an UnsupportedOperationException. Use LoaderManager.getInstance(T) to obtain a LoaderManager.

Returns a LoaderManager.

Returns
`LoaderManager`

See also:

LoaderManager.getInstance(T)

noteStateNotSaved

public void noteStateNotSaved ()

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

onCreateView

public 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

public void reportLoaderStart ()

This method is deprecated.
Loaders are managed separately from FragmentController

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

restoreAllState

public void restoreAllState (Parcelable state, 
                FragmentManagerNonConfig nonConfig)

This method is deprecated.
Have your FragmentHostCallback implement ViewModelStoreOwner to automatically restore the Fragment's non configuration state and use restoreSaveState(Parcelable) to restore the Fragment's save state.

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

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

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

Parameters
`state`	`Parcelable`
`nonConfigList`	`List`

restoreLoaderNonConfig

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

This method is deprecated.
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()

restoreSaveState

public void restoreSaveState (Parcelable state)

Restores the saved state for all Fragments.

Parameters
`state`	`Parcelable`: the saved state containing the Parcelable returned by `saveAllState()`

See also:

saveAllState()

retainLoaderNonConfig

public SimpleArrayMap<String, LoaderManager> retainLoaderNonConfig ()

This method is deprecated.
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

public FragmentManagerNonConfig retainNestedNonConfig ()

This method is deprecated.
Have your FragmentHostCallback implement ViewModelStoreOwner to automatically retain the Fragment's non configuration state.

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

Returns
`FragmentManagerNonConfig`

retainNonConfig

public List<Fragment> retainNonConfig ()

This method is deprecated.
Have your FragmentHostCallback implement ViewModelStoreOwner to automatically retain the Fragment's non configuration state.

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

Returns
`List<Fragment>`

saveAllState

public Parcelable saveAllState ()

Saves the state for all Fragments.

Returns
`Parcelable`

See also:

restoreSaveState(Parcelable)