{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}
public class 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.
Public methods |
|
---|---|
@NonNull void |
attachHost(@Nullable Fragment parent) Attaches the host to the FragmentManager for this controller. |
static @NonNull FragmentController |
createController(@NonNull FragmentHostCallback<@NonNull Object> callbacks) Returns a |
@NonNull void |
Moves all Fragments managed by the controller's FragmentManager into the activity created state. |
@NonNull void |
dispatchConfigurationChanged(@NonNull Configuration newConfig) Lets all Fragments managed by the controller's FragmentManager know a configuration change occurred. |
@NonNull boolean |
dispatchContextItemSelected(@NonNull MenuItem item) Sends a context item selection event to the Fragments managed by the controller's FragmentManager. |
@NonNull void |
Moves all Fragments managed by the controller's FragmentManager into the create state. |
@NonNull boolean |
dispatchCreateOptionsMenu( Lets all Fragments managed by the controller's FragmentManager know they should create an options menu. |
@NonNull void |
Moves Fragments managed by the controller's FragmentManager into the destroy state. |
@NonNull void |
Moves all Fragments managed by the controller's FragmentManager into the destroy view state. |
@NonNull void |
Lets all Fragments managed by the controller's FragmentManager know the device is in a low memory condition. |
@NonNull void |
dispatchMultiWindowModeChanged(@NonNull boolean isInMultiWindowMode) Lets all Fragments managed by the controller's FragmentManager know the multi-window mode of the activity changed. |
@NonNull boolean |
dispatchOptionsItemSelected(@NonNull MenuItem item) Sends an option item selection event to the Fragments managed by the controller's FragmentManager. |
@NonNull void |
dispatchOptionsMenuClosed(@NonNull Menu menu) Lets all Fragments managed by the controller's FragmentManager know their options menu has closed. |
@NonNull void |
Moves all Fragments managed by the controller's FragmentManager into the pause state. |
@NonNull void |
dispatchPictureInPictureModeChanged( Lets all Fragments managed by the controller's FragmentManager know the picture-in-picture mode of the activity changed. |
@NonNull boolean |
dispatchPrepareOptionsMenu(@NonNull Menu menu) Lets all Fragments managed by the controller's FragmentManager know they should prepare their options menu for display. |
@NonNull void |
This method is deprecated. This functionality has been rolled into |
@NonNull void |
Moves all Fragments managed by the controller's FragmentManager into the resume state. |
@NonNull void |
Moves all Fragments managed by the controller's FragmentManager into the start state. |
@NonNull void |
Moves all Fragments managed by the controller's FragmentManager into the stop state. |
@NonNull void |
This method is deprecated. Loaders are managed separately from FragmentController |
@NonNull void |
This method is deprecated. Loaders are managed separately from FragmentController |
@NonNull void |
This method is deprecated. Loaders are managed separately from FragmentController |
@NonNull void |
This method is deprecated. Loaders are managed separately from FragmentController |
@NonNull void |
This method is deprecated. Loaders are managed separately from FragmentController |
@NonNull boolean |
Execute any pending actions for the Fragments managed by the controller's FragmentManager. |
@Nullable Fragment |
findFragmentByWho(@NonNull String who) Returns a fragment with the given identifier. |
@NonNull List<@NonNull Fragment> |
getActiveFragments(@NonNull List<@NonNull Fragment> actives) Returns the list of active fragments. |
@NonNull int |
Returns the number of active fragments. |
@NonNull FragmentManager |
Returns a |
@NonNull LoaderManager |
This method is deprecated. Loaders are managed separately from FragmentController and this now throws an |
@NonNull void |
Marks the fragment state as unsaved. |
@Nullable View |
onCreateView( Instantiates a Fragment's view. |
@NonNull void |
This method is deprecated. Loaders are managed separately from FragmentController |
@NonNull void |
This method is deprecated. Have your |
@NonNull void |
This method is deprecated. Have your |
@NonNull void |
This method is deprecated. Loaders are managed separately from FragmentController |
@NonNull void |
restoreSaveState(@Nullable Parcelable state) Restores the saved state for all Fragments. |
@Nullable SimpleArrayMap<String, LoaderManager> |
This method is deprecated. Loaders are managed separately from FragmentController |
@Nullable FragmentManagerNonConfig |
This method is deprecated. Have your |
@Nullable List<@NonNull Fragment> |
This method is deprecated. Have your |
@Nullable Parcelable |
Saves the state for all Fragments. |
@NonNull
public void attachHost(@Nullable 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.
@NonNull
public static FragmentController createController(@NonNull FragmentHostCallback<@NonNull Object> callbacks)
Returns a FragmentController
.
@NonNull
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 | |
---|---|
onActivityCreated |
Fragment#onActivityCreated(Bundle) |
@NonNull
public void dispatchConfigurationChanged(@NonNull Configuration newConfig)
Lets all Fragments managed by the controller's FragmentManager know a configuration change occurred.
Call when there is a configuration change.
See also | |
---|---|
onConfigurationChanged |
androidx.fragment.app.Fragment#onConfigurationChanged(Configuration) |
@NonNull
public boolean dispatchContextItemSelected(@NonNull 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
Returns | |
---|---|
boolean |
|
See also | |
---|---|
onContextItemSelected |
androidx.fragment.app.Fragment#onContextItemSelected(MenuItem) |
@NonNull
public void dispatchCreate()
Moves all Fragments managed by the controller's FragmentManager into the create state.
Call when Fragments should be created.
See also | |
---|---|
onCreate |
Fragment#onCreate(Bundle) |
@NonNull
public boolean dispatchCreateOptionsMenu(
@NonNull Menu menu,
@NonNull 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.
Returns | |
---|---|
boolean |
|
See also | |
---|---|
onCreateOptionsMenu |
androidx.fragment.app.Fragment#onCreateOptionsMenu(Menu, MenuInflater) |
@NonNull
public void dispatchDestroy()
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 Activity#isChangingConfigurations() returns true. In only that case will non configuration state be retained.
Call when Fragments should be destroyed.
See also | |
---|---|
onDestroy |
androidx.fragment.app.Fragment#onDestroy() |
@NonNull
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 | |
---|---|
onDestroyView |
androidx.fragment.app.Fragment#onDestroyView() |
@NonNull
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 | |
---|---|
onLowMemory |
androidx.fragment.app.Fragment#onLowMemory() |
@NonNull
public void dispatchMultiWindowModeChanged(@NonNull 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.
See also | |
---|---|
onMultiWindowModeChanged |
androidx.fragment.app.Fragment#onMultiWindowModeChanged |
@NonNull
public boolean dispatchOptionsItemSelected(@NonNull 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
Returns | |
---|---|
boolean |
|
See also | |
---|---|
onOptionsItemSelected |
androidx.fragment.app.Fragment#onOptionsItemSelected(MenuItem) |
@NonNull
public void dispatchOptionsMenuClosed(@NonNull 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.
See also | |
---|---|
onOptionsMenuClosed |
androidx.fragment.app.Fragment#onOptionsMenuClosed(Menu) |
@NonNull
public void dispatchPause()
Moves all Fragments managed by the controller's FragmentManager into the pause state.
Call when Fragments should be paused.
See also | |
---|---|
onPause |
androidx.fragment.app.Fragment#onPause() |
@NonNull
public void dispatchPictureInPictureModeChanged(
@NonNull 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.
See also | |
---|---|
onPictureInPictureModeChanged |
androidx.fragment.app.Fragment#onPictureInPictureModeChanged |
@NonNull
public boolean dispatchPrepareOptionsMenu(@NonNull 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.
Returns | |
---|---|
boolean |
|
See also | |
---|---|
onPrepareOptionsMenu |
androidx.fragment.app.Fragment#onPrepareOptionsMenu(Menu) |
@NonNull
public void dispatchResume()
Moves all Fragments managed by the controller's FragmentManager into the resume state.
Call when Fragments should be resumed.
See also | |
---|---|
onResume |
androidx.fragment.app.Fragment#onResume() |
@NonNull
public void dispatchStart()
Moves all Fragments managed by the controller's FragmentManager into the start state.
Call when Fragments should be started.
See also | |
---|---|
onStart |
androidx.fragment.app.Fragment#onStart() |
@NonNull
public void dispatchStop()
Moves all Fragments managed by the controller's FragmentManager into the stop state.
Call when Fragments should be stopped.
See also | |
---|---|
onStop |
androidx.fragment.app.Fragment#onStop() |
@NonNull
public voiddoLoaderDestroy()
Destroys the loaders and, if their state is not being retained, removes them.
@NonNull
public voiddoLoaderStop(@NonNull boolean retain)
Stops the loaders, optionally retaining their state. This is useful for keeping the loader state across configuration changes.
Parameters | |
---|---|
@NonNull boolean retain |
When |
@NonNull
public voiddumpLoaders(
@NonNull String prefix,
@Nullable FileDescriptor fd,
@NonNull PrintWriter writer,
@Nullable Array<@NonNull String> args
)
Dumps the current state of the loaders.
@NonNull
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 |
|
@Nullable
@NonNull
public Fragment findFragmentByWho(@NonNull String who)
Returns a fragment with the given identifier.
@NonNull
public List<@NonNull Fragment> getActiveFragments(@NonNull List<@NonNull Fragment> actives)
Returns the list of active fragments.
@NonNull
public int getActiveFragmentsCount()
Returns the number of active fragments.
@NonNull
public FragmentManager getSupportFragmentManager()
Returns a FragmentManager
for this controller.
@NonNull
public LoaderManagergetSupportLoaderManager()
Returns a LoaderManager.
See also | |
---|---|
LoaderManager |
androidx.loader.app.LoaderManager#getInstance |
@NonNull
public void noteStateNotSaved()
Marks the fragment state as unsaved. This allows for "state loss" detection.
@Nullable
@NonNull
public View onCreateView(
@Nullable View parent,
@NonNull String name,
@NonNull Context context,
@NonNull AttributeSet attrs
)
Instantiates a Fragment's view.
Parameters | |
---|---|
@Nullable View parent |
The parent that the created view will be placed in; note that this may be null. |
@NonNull String name |
Tag name to be inflated. |
@NonNull Context context |
The context the view is being created in. |
@NonNull AttributeSet attrs |
Inflation attributes as specified in XML file. |
Returns | |
---|---|
View |
view the newly created view |
@NonNull
public voidreportLoaderStart()
Lets the loaders know the host is ready to receive notifications.
@NonNull
public voidrestoreAllState(
@Nullable Parcelable state,
@Nullable List<@NonNull Fragment> nonConfigList
)
Restores the saved state for all Fragments. The given Fragment list are Fragment instances retained across configuration changes.
@NonNull
public voidrestoreAllState(
@Nullable Parcelable state,
@Nullable FragmentManagerNonConfig nonConfig
)
Restores the saved state for all Fragments. The given FragmentManagerNonConfig are Fragment instances retained across configuration changes, including nested fragments
@NonNull
public voidrestoreLoaderNonConfig(
@NonNull SimpleArrayMap<String, LoaderManager> loaderManagers
)
Restores the saved state for all LoaderManagers. The given LoaderManager list are LoaderManager instances retained across configuration changes.
See also | |
---|---|
retainLoaderNonConfig |
#retainLoaderNonConfig() |
@NonNull
public void restoreSaveState(@Nullable Parcelable state)
Restores the saved state for all Fragments.
Parameters | |
---|---|
@Nullable Parcelable state |
the saved state containing the Parcelable returned by |
See also | |
---|---|
saveAllState |
#saveAllState() |
@Nullable
@NonNull
public SimpleArrayMap<String, LoaderManager>retainLoaderNonConfig()
Returns a list of LoaderManagers that have opted to retain their instance across configuration changes.
@Nullable
@NonNull
public FragmentManagerNonConfigretainNestedNonConfig()
Returns a nested tree of Fragments that have opted to retain their instance across configuration changes.
@Nullable
@NonNull
public List<@NonNull Fragment>retainNonConfig()
Returns a list of Fragments that have opted to retain their instance across configuration changes.
@Nullable
@NonNull
public Parcelable saveAllState()
Saves the state for all Fragments.
See also | |
---|---|
restoreSaveState |
#restoreSaveState(Parcelable) |