FragmentController
open classFragmentController
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 |
open Unit |
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 |
Moves all Fragments managed by the controller's FragmentManager into the create state. |
open Boolean |
dispatchCreateOptionsMenu(: Menu!, inflater: MenuInflater!) Lets all Fragments managed by the controller's FragmentManager know they should create an options menu. |
open Unit |
Moves all Fragments managed by the controller's FragmentManager into the destroy state. |
open Unit |
Moves all Fragments managed by the controller's FragmentManager into the destroy view state. |
open Unit |
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 |
Lets all Fragments managed by the controller's FragmentManager know their options menu has closed. |
open Unit |
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 |
Lets all Fragments managed by the controller's FragmentManager know they should prepare their options menu for display. |
open Unit |
Moves all Fragments managed by the controller's FragmentManager into the resume state. |
open Unit |
Moves all Fragments managed by the controller's FragmentManager into the start state. |
open Unit |
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 |
Destroys the loaders and, if their state is not being retained, removes them. |
open Unit |
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 |
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! |
Returns a |
open LoaderManager! |
Returns a |
open Unit |
Marks the fragment state as unsaved. |
open View! |
onCreateView(parent: View!, name: String!, context: Context!, attrs: AttributeSet!) Instantiates a Fragment's view. |
open Unit |
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!>! |
Returns a list of LoaderManagers that have opted to retain their instance across configuration changes. |
open FragmentManagerNonConfig! |
Returns a nested tree of Fragments that have opted to retain their instance across configuration changes. |
open MutableList<Fragment!>! |
Returns a list of Fragments that have opted to retain their instance across configuration changes. |
open Parcelable! |
Saves the state for all Fragments. |
Public methods
attachHost
open funattachHost(parent: Fragment!): Unit
Deprecated: Deprecated in Java.
Attaches the host to the FragmentManager for this controller. The host must be attached before the FragmentManager can be used to manage Fragments.
createController
static funcreateController(callbacks: FragmentHostCallback<*>!): FragmentController!
Deprecated: Deprecated in Java.
Returns a FragmentController
.
dispatchActivityCreated
open fundispatchActivityCreated(): Unit
Deprecated: Deprecated in Java.
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
open fundispatchConfigurationChanged(newConfig: Configuration!): Unit
Deprecated: Deprecated in Java.
Lets all Fragments managed by the controller's FragmentManager know a configuration change occurred.
Call when there is a configuration change.
dispatchContextItemSelected
open fundispatchContextItemSelected(item: MenuItem!): Boolean
Deprecated: Deprecated in Java.
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 |
dispatchCreate
open fundispatchCreate(): Unit
Deprecated: Deprecated in Java.
Moves all Fragments managed by the controller's FragmentManager into the create state.
Call when Fragments should be created.
dispatchCreateOptionsMenu
open fundispatchCreateOptionsMenu(
: Menu!,
inflater: MenuInflater!
): Boolean
Deprecated: Deprecated in Java.
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 |
dispatchDestroy
open fundispatchDestroy(): Unit
Deprecated: Deprecated in Java.
Moves all Fragments managed by the controller's FragmentManager into the destroy state.
Call when Fragments should be destroyed.
See Also
dispatchDestroyView
open fundispatchDestroyView(): Unit
Deprecated: Deprecated in Java.
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
open fundispatchLowMemory(): Unit
Deprecated: Deprecated in Java.
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
open fundispatchMultiWindowModeChanged(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
dispatchMultiWindowModeChanged
open fundispatchMultiWindowModeChanged(
isInMultiWindowMode: Boolean,
newConfig: Configuration!
): Unit
Deprecated: Deprecated in Java.
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
dispatchOptionsItemSelected
open fundispatchOptionsItemSelected(item: MenuItem!): Boolean
Deprecated: Deprecated in Java.
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 |
dispatchOptionsMenuClosed
open fundispatchOptionsMenuClosed(: Menu!): Unit
Deprecated: Deprecated in Java.
Lets all Fragments managed by the controller's FragmentManager know their options menu has closed.
Call immediately after closing the Fragment's options menu.
dispatchPause
open fundispatchPause(): Unit
Deprecated: Deprecated in Java.
Moves all Fragments managed by the controller's FragmentManager into the pause state.
Call when Fragments should be paused.
See Also
dispatchPictureInPictureModeChanged
open fundispatchPictureInPictureModeChanged(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
dispatchPictureInPictureModeChanged
open fundispatchPictureInPictureModeChanged(
isInPictureInPictureMode: Boolean,
newConfig: Configuration!
): Unit
Deprecated: Deprecated in Java.
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
dispatchPrepareOptionsMenu
open fundispatchPrepareOptionsMenu(: Menu!): Boolean
Deprecated: Deprecated in Java.
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 |
dispatchResume
open fundispatchResume(): Unit
Deprecated: Deprecated in Java.
Moves all Fragments managed by the controller's FragmentManager into the resume state.
Call when Fragments should be resumed.
See Also
dispatchStart
open fundispatchStart(): Unit
Deprecated: Deprecated in Java.
Moves all Fragments managed by the controller's FragmentManager into the start state.
Call when Fragments should be started.
See Also
dispatchStop
open fundispatchStop(): Unit
Deprecated: Deprecated in Java.
Moves all Fragments managed by the controller's FragmentManager into the stop state.
Call when Fragments should be stopped.
See Also
dispatchTrimMemory
open fundispatchTrimMemory(level: Int): Unit
Deprecated: Deprecated in Java.
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].
doLoaderDestroy
open fundoLoaderDestroy(): Unit
Deprecated: Deprecated in Java.
Destroys the loaders and, if their state is not being retained, removes them.
doLoaderStart
open fundoLoaderStart(): Unit
Deprecated: Deprecated in Java.
Starts the loaders.
doLoaderStop
open fundoLoaderStop(retain: Boolean): Unit
Deprecated: Deprecated in Java.
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
open fundumpLoaders(
prefix: String!,
fd: FileDescriptor!,
writer: PrintWriter!,
args: Array<String!>!
): Unit
Deprecated: Deprecated in Java.
Dumps the current state of the loaders.
execPendingActions
open funexecPendingActions(): Boolean
Deprecated: Deprecated in Java.
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
open funfindFragmentByWho(who: String!): Fragment?
Deprecated: Deprecated in Java.
Returns a fragment with the given identifier.
Return | |
---|---|
Fragment? |
This value may be null . |
getFragmentManager
open fungetFragmentManager(): FragmentManager!
Deprecated: Deprecated in Java.
Returns a FragmentManager
for this controller.
getLoaderManager
open fungetLoaderManager(): LoaderManager!
Deprecated: Deprecated in Java.
Returns a LoaderManager
.
noteStateNotSaved
open funnoteStateNotSaved(): Unit
Deprecated: Deprecated in Java.
Marks the fragment state as unsaved. This allows for "state loss" detection.
onCreateView
open funonCreateView(
parent: View!,
name: String!,
context: Context!,
attrs: AttributeSet!
): View!
Deprecated: Deprecated in Java.
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
open funreportLoaderStart(): Unit
Deprecated: Deprecated in Java.
Lets the loaders know the host is ready to receive notifications.
restoreAllState
open funrestoreAllState(
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
restoreAllState
open funrestoreAllState(
state: Parcelable!,
nonConfig: FragmentManagerNonConfig!
): Unit
Deprecated: Deprecated in Java.
Restores the saved state for all Fragments. The given FragmentManagerNonConfig are Fragment instances retained across configuration changes, including nested fragments
See Also
restoreLoaderNonConfig
open funrestoreLoaderNonConfig(loaderManagers: ArrayMap<String!, LoaderManager!>!): Unit
Deprecated: Deprecated in Java.
Restores the saved state for all LoaderManagers. The given LoaderManager list are LoaderManager instances retained across configuration changes.
See Also
retainLoaderNonConfig
open funretainLoaderNonConfig(): ArrayMap<String!, LoaderManager!>!
Deprecated: Deprecated in Java.
Returns a list of LoaderManagers that have opted to retain their instance across configuration changes.
retainNestedNonConfig
open funretainNestedNonConfig(): FragmentManagerNonConfig!
Deprecated: Deprecated in Java.
Returns a nested tree of Fragments that have opted to retain their instance across configuration changes.
retainNonConfig
open funretainNonConfig(): 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
open funsaveAllState(): Parcelable!
Deprecated: Deprecated in Java.
Saves the state for all Fragments.