FragmentActivity

Kotlin |Java

open class FragmentActivity : ComponentActivity, ActivityCompat.OnRequestPermissionsResultCallback, RequestPermissionsRequestCodeValidator

androidx.activity.ComponentActivity
↳	androidx.fragment.app.FragmentActivity

Known Direct Subclasses AppCompatActivity AppCompatActivity Base class for activities that wish to use some of the newer platform features on older Android devices.

Base class for activities that want to use the support-based Fragments.

Known limitations:

• When using the <fragment> tag, this implementation can not use the parent view's ID as the new fragment's ID. You must explicitly specify an ID (or tag) in the <fragment>.

Summary

Public constructors
<init>() Default constructor for FragmentActivity.
<init>(@LayoutRes contentLayoutId: Int) Alternate constructor that can be used to provide a default layout that will be inflated as part of super.onCreate(savedInstanceState).

Public methods
open Unit	dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?) Print the Activity's state into the given stream.
open FragmentManager	getSupportFragmentManager() Return the FragmentManager for interacting with fragments associated with this activity.
open LoaderManager	getSupportLoaderManager()
open Unit	onAttachFragment(@NonNull fragment: Fragment) Called when a fragment is attached to the activity.
open Unit	onConfigurationChanged(@NonNull newConfig: Configuration) Dispatch configuration change to all fragments.
open Boolean	onCreatePanelMenu(featureId: Int, @NonNull menu: Menu) Dispatch to Fragment.
open View?	onCreateView(@Nullable parent: View?, @NonNull name: String, @NonNull context: Context, @NonNull attrs: AttributeSet)
open View?	onCreateView(@NonNull name: String, @NonNull context: Context, @NonNull attrs: AttributeSet)
open Unit	onLowMemory() Dispatch onLowMemory() to all fragments.
open Boolean	onMenuItemSelected(featureId: Int, @NonNull item: MenuItem) Dispatch context and options menu to fragments.
open Unit	onMultiWindowModeChanged(isInMultiWindowMode: Boolean) Note: If you override this method you must call super.onMultiWindowModeChanged to correctly dispatch the event to support fragments attached to this activity.
open Unit	onPanelClosed(featureId: Int, @NonNull menu: Menu) Call onOptionsMenuClosed() on fragments.
open Unit	onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean) Note: If you override this method you must call super.onPictureInPictureModeChanged to correctly dispatch the event to support fragments attached to this activity.
open Boolean	onPreparePanel(featureId: Int, @Nullable view: View?, @NonNull menu: Menu) Dispatch onPrepareOptionsMenu() to fragments.
open Unit	onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<String!>, @NonNull grantResults: IntArray)
open Unit	onStateNotSaved() Hook in to note that fragment state is no longer saved.
open Unit	setEnterSharedElementCallback(@Nullable callback: SharedElementCallback?) When android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String) was used to start an Activity, callback will be called to handle shared elements on the launched Activity.
open Unit	setExitSharedElementCallback(@Nullable listener: SharedElementCallback?) When android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String) was used to start an Activity, listener will be called to handle shared elements on the launching Activity.
open Unit	startActivityFromFragment(@NonNull fragment: Fragment, intent: Intent!, requestCode: Int) Called by Fragment.
open Unit	startActivityFromFragment(@NonNull fragment: Fragment, intent: Intent!, requestCode: Int, @Nullable options: Bundle?) Called by Fragment.
open Unit	startIntentSenderFromFragment(@NonNull fragment: Fragment, intent: IntentSender!, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?) Called by Fragment.
open Unit	supportFinishAfterTransition() Reverses the Activity Scene entry Transition and triggers the calling Activity to reverse its exit Transition.
open Unit	supportInvalidateOptionsMenu() Support library version of Activity#invalidateOptionsMenu.
open Unit	supportPostponeEnterTransition() Support library version of android.app.Activity#postponeEnterTransition() that works only on API 21 and later.
open Unit	supportStartPostponedEnterTransition() Support library version of android.app.Activity#startPostponedEnterTransition() that only works with API 21 and later.
Unit	validateRequestPermissionsRequestCode(requestCode: Int)

Protected methods
open Unit	onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?)
open Unit	onCreate(@Nullable savedInstanceState: Bundle?) Perform initialization of all fragments.
open Unit	onDestroy() Destroy all fragments.
open Unit	onNewIntent(intent: Intent!) Handle onNewIntent() to inform the fragment manager that the state is not saved.
open Unit	onPause() Dispatch onPause() to fragments.
open Unit	onPostResume() Dispatch onResume() to fragments.
open Unit	onResume() Dispatch onResume() to fragments.
open Unit	onResumeFragments() This is the fragment-orientated version of onResume() that you can override to perform operations in the Activity at the same point where its fragments are resumed.
open Unit	onStart() Dispatch onStart() to all fragments.
open Unit	onStop() Dispatch onStop() to all fragments.

Inherited functions

From class ComponentActivity Unit addContentView(view: View!, params: LayoutParams!) Unit addOnContextAvailableListener(@NonNull listener: OnContextAvailableListener) Add a new OnContextAvailableListener for receiving a callback for when this class is associated with a android.content.Context. Listeners are triggered in the order they are added when added before the Context is available. Listeners added after the context has been made available will have the Context synchronously delivered to them as part of this call. Any listener added here will receive a callback as part of super.onCreate(), but importantly before any other logic is done (including calling through to the framework Activity#onCreate(Bundle) with the exception of restoring the state of the SavedStateRegistry for use in your listener. ActivityResultRegistry getActivityResultRegistry() Get the ActivityResultRegistry associated with this activity. ViewModelProvider.Factory getDefaultViewModelProviderFactory() Returns the default ViewModelProvider.Factory that should be used when no custom Factory is provided to the ViewModelProvider constructors. The extras of getIntent() when this is first called will be used as the defaults to any androidx.lifecycle.SavedStateHandle passed to a view model created using this factory. Any? getLastCustomNonConfigurationInstance() Return the value previously returned from onRetainCustomNonConfigurationInstance(). Lifecycle getLifecycle() Returns the Lifecycle of the provider. Overriding this method is no longer supported and this method will be made final in a future version of ComponentActivity. If you do override this method, you must: Return an instance of LifecycleRegistry Lazily initialize your LifecycleRegistry object when this is first called. Note that this method will be called in the super classes' constructor, before any field initialization or object state creation is complete. OnBackPressedDispatcher getOnBackPressedDispatcher() Retrieve the OnBackPressedDispatcher that will be triggered when onBackPressed() is called. SavedStateRegistry getSavedStateRegistry() ViewModelStore getViewModelStore() Returns the ViewModelStore associated with this activity Overriding this method is no longer supported and this method will be made final in a future version of ComponentActivity. Unit onBackPressed() Called when the activity has detected the user's press of the back key. The OnBackPressedDispatcher will be given a chance to handle the back button before the default behavior of android.app.Activity#onBackPressed() is invoked. Any? onRetainCustomNonConfigurationInstance() Use this instead of onRetainNonConfigurationInstance(). Retrieve later with getLastCustomNonConfigurationInstance(). Any? onRetainNonConfigurationInstance() Retain all appropriate non-config state. You can NOT override this yourself! Use a androidx.lifecycle.ViewModel if you want to retain your own non config state. Unit onSaveInstanceState(@NonNull outState: Bundle) Context? peekAvailableContext() ActivityResultLauncher<I> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull registry: ActivityResultRegistry, @NonNull callback: ActivityResultCallback<O>) ActivityResultLauncher<I> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull callback: ActivityResultCallback<O>) Unit removeOnContextAvailableListener(@NonNull listener: OnContextAvailableListener) Unit setContentView(@LayoutRes layoutResID: Int) Unit setContentView(view: View!) Unit setContentView(view: View!, params: LayoutParams!) Unit startActivityForResult(intent: Intent!, requestCode: Int) Unit startActivityForResult(intent: Intent!, requestCode: Int, @Nullable options: Bundle?) Unit startIntentSenderForResult(intent: IntentSender!, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int) Unit startIntentSenderForResult(intent: IntentSender!, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?)

Public constructors

<init>

FragmentActivity()

Default constructor for FragmentActivity. All Activities must have a default constructor for API 27 and lower devices or when using the default android.app.AppComponentFactory.

<init>

FragmentActivity(@LayoutRes contentLayoutId: Int)

Alternate constructor that can be used to provide a default layout that will be inflated as part of super.onCreate(savedInstanceState).

This should generally be called from your constructor that takes no parameters, as is required for API 27 and lower or when using the default android.app.AppComponentFactory.

See Also

• #FragmentActivity()

Public methods

dump

open fun dump(
    @NonNull prefix: String, 
    @Nullable fd: FileDescriptor?, 
    @NonNull writer: PrintWriter, 
    @Nullable args: Array<String!>?
): Unit

Print the Activity's state into the given stream. This gets invoked if you run "adb shell dumpsys activity ".

Parameters
prefix	String: Desired prefix to prepend at each line of output.
fd	FileDescriptor?: The raw file descriptor that the dump is being sent to.
writer	PrintWriter: The PrintWriter to which you should dump your state. This will be closed for you after you return.
args	Array<String!>?: additional arguments to the dump request.

getSupportFragmentManager

@NonNull open fun getSupportFragmentManager(): FragmentManager

Return the FragmentManager for interacting with fragments associated with this activity.

getSupportLoaderManager

@NonNull open fun getSupportLoaderManager(): LoaderManager

Deprecated: Use LoaderManager.getInstance(this).

onAttachFragment

@MainThread open fun onAttachFragment(@NonNull fragment: Fragment): Unit

Deprecated: The responsibility for listening for fragments being attached has been moved to FragmentManager. You can add a listener to this Activity's FragmentManager by calling FragmentManager#addFragmentOnAttachListener(FragmentOnAttachListener) in your constructor to get callbacks when a fragment is attached directly to the activity's FragmentManager.

Called when a fragment is attached to the activity.

This is called after the attached fragment's onAttach and before the attached fragment's onCreate if the fragment has not yet had a previous call to onCreate.

onConfigurationChanged

open fun onConfigurationChanged(@NonNull newConfig: Configuration): Unit

Dispatch configuration change to all fragments.

onCreatePanelMenu

open fun onCreatePanelMenu(
    featureId: Int, 
    @NonNull menu: Menu
): Boolean

Dispatch to Fragment.onCreateOptionsMenu().

onCreateView

@Nullable open fun onCreateView(
    @Nullable parent: View?, 
    @NonNull name: String, 
    @NonNull context: Context, 
    @NonNull attrs: AttributeSet
): View?

onCreateView

@Nullable open fun onCreateView(
    @NonNull name: String, 
    @NonNull context: Context, 
    @NonNull attrs: AttributeSet
): View?

onLowMemory

open fun onLowMemory(): Unit

Dispatch onLowMemory() to all fragments.

onMenuItemSelected

open fun onMenuItemSelected(
    featureId: Int, 
    @NonNull item: MenuItem
): Boolean

Dispatch context and options menu to fragments.

onMultiWindowModeChanged

@CallSuper open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean): Unit

Note: If you override this method you must call super.onMultiWindowModeChanged to correctly dispatch the event to support fragments attached to this activity.

Parameters
isInMultiWindowMode	Boolean: True if the activity is in multi-window mode.

onPanelClosed

open fun onPanelClosed(
    featureId: Int, 
    @NonNull menu: Menu
): Unit

Call onOptionsMenuClosed() on fragments.

onPictureInPictureModeChanged

@CallSuper open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean): Unit

Note: If you override this method you must call super.onPictureInPictureModeChanged to correctly dispatch the event to support fragments attached to this activity.

Parameters
isInPictureInPictureMode	Boolean: True if the activity is in picture-in-picture mode.

onPreparePanel

open fun onPreparePanel(
    featureId: Int, 
    @Nullable view: View?, 
    @NonNull menu: Menu
): Boolean

Dispatch onPrepareOptionsMenu() to fragments.

onRequestPermissionsResult

@CallSuper open fun onRequestPermissionsResult(
    requestCode: Int, 
    @NonNull permissions: Array<String!>, 
    @NonNull grantResults: IntArray
): Unit

onStateNotSaved

open fun onStateNotSaved(): Unit

Hook in to note that fragment state is no longer saved.

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable callback: SharedElementCallback?): Unit

When android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String) was used to start an Activity, callback will be called to handle shared elements on the launched Activity. This requires Window#FEATURE_CONTENT_TRANSITIONS.

Parameters
callback	SharedElementCallback?: Used to manipulate shared element transitions on the launched Activity.

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable listener: SharedElementCallback?): Unit

When android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String) was used to start an Activity, listener will be called to handle shared elements on the launching Activity. Most calls will only come when returning from the started Activity. This requires Window#FEATURE_CONTENT_TRANSITIONS.

Parameters
listener	SharedElementCallback?: Used to manipulate shared element transitions on the launching Activity.

startActivityFromFragment

open fun startActivityFromFragment(
    @NonNull fragment: Fragment, 
    intent: Intent!, 
    requestCode: Int
): Unit

Called by Fragment.startActivityForResult() to implement its behavior.

Parameters
fragment	Fragment: the Fragment to start the activity from.
intent	Intent!: The intent to start.
requestCode	Int: The request code to be returned in Fragment#onActivityResult(int, int, Intent) when the activity exits. Must be between 0 and 65535 to be considered valid. If given requestCode is greater than 65535, an IllegalArgumentException would be thrown.

startActivityFromFragment

open fun startActivityFromFragment(
    @NonNull fragment: Fragment, 
    intent: Intent!, 
    requestCode: Int, 
    @Nullable options: Bundle?
): Unit

Called by Fragment.startActivityForResult() to implement its behavior.

Parameters
fragment	Fragment: the Fragment to start the activity from.
intent	Intent!: The intent to start.
requestCode	Int: The request code to be returned in Fragment#onActivityResult(int, int, Intent) when the activity exits. Must be between 0 and 65535 to be considered valid. If given requestCode is greater than 65535, an IllegalArgumentException would be thrown.
options	Bundle?: Additional options for how the Activity should be started. See Context#startActivity(Intent, Bundle) for more details. This value may be null.

startIntentSenderFromFragment

open fun startIntentSenderFromFragment(
    @NonNull fragment: Fragment, 
    intent: IntentSender!, 
    requestCode: Int, 
    @Nullable fillInIntent: Intent?, 
    flagsMask: Int, 
    flagsValues: Int, 
    extraFlags: Int, 
    @Nullable options: Bundle?
): Unit

Deprecated: Fragments should use Fragment#registerForActivityResult(ActivityResultContract, ActivityResultCallback) with the StartIntentSenderForResult contract. This method will still be called when Fragments call the deprecated startIntentSenderForResult() method.

Called by Fragment.startIntentSenderForResult() to implement its behavior.

Parameters
fragment	Fragment: the Fragment to start the intent sender from.
intent	IntentSender!: The IntentSender to launch.
requestCode	Int: The request code to be returned in Fragment#onActivityResult(int, int, Intent) when the activity exits. Must be between 0 and 65535 to be considered valid. If given requestCode is greater than 65535, an IllegalArgumentException would be thrown.
fillInIntent	Intent?: If non-null, this will be provided as the intent parameter to IntentSender#sendIntent(Context, int, Intent, IntentSender.OnFinished, Handler). This value may be null.
flagsMask	Int: Intent flags in the original IntentSender that you would like to change.
flagsValues	Int: Desired values for any bits set in flagsMask.
extraFlags	Int: Always set to 0.
options	Bundle?: Additional options for how the Activity should be started. See Context#startActivity(Intent, Bundle) for more details. This value may be null.

Exceptions
IntentSender.SendIntentException	if the call fails to execute.

supportFinishAfterTransition

open fun supportFinishAfterTransition(): Unit

Reverses the Activity Scene entry Transition and triggers the calling Activity to reverse its exit Transition. When the exit Transition completes, finish() is called. If no entry Transition was used, finish() is called immediately and the Activity exit Transition is run.

On Android 4.4 or lower, this method only finishes the Activity with no special exit transition.

supportInvalidateOptionsMenu

open fun supportInvalidateOptionsMenu(): Unit

Deprecated: Call Activity#invalidateOptionsMenu directly.

Support library version of Activity#invalidateOptionsMenu.

Invalidate the activity's options menu. This will cause relevant presentations of the menu to fully update via calls to onCreateOptionsMenu and onPrepareOptionsMenu the next time the menu is requested.

supportPostponeEnterTransition

open fun supportPostponeEnterTransition(): Unit

Support library version of android.app.Activity#postponeEnterTransition() that works only on API 21 and later.

supportStartPostponedEnterTransition

open fun supportStartPostponedEnterTransition(): Unit

Support library version of android.app.Activity#startPostponedEnterTransition() that only works with API 21 and later.

validateRequestPermissionsRequestCode

fun validateRequestPermissionsRequestCode(requestCode: Int): Unit

Deprecated: there are no longer any restrictions on permissions requestCodes.

Protected methods

onActivityResult

@CallSuper protected open fun onActivityResult(
    requestCode: Int, 
    resultCode: Int, 
    @Nullable data: Intent?
): Unit

onCreate

protected open fun onCreate(@Nullable savedInstanceState: Bundle?): Unit

Perform initialization of all fragments.

onDestroy

protected open fun onDestroy(): Unit

Destroy all fragments.

onNewIntent

@CallSuper protected open fun onNewIntent(intent: Intent!): Unit

Handle onNewIntent() to inform the fragment manager that the state is not saved. If you are handling new intents and may be making changes to the fragment state, you want to be sure to call through to the super-class here first. Otherwise, if your state is saved but the activity is not stopped, you could get an onNewIntent() call which happens before onResume() and trying to perform fragment operations at that point will throw IllegalStateException because the fragment manager thinks the state is still saved.

onPause

protected open fun onPause(): Unit

Dispatch onPause() to fragments.

onPostResume

protected open fun onPostResume(): Unit

Dispatch onResume() to fragments.

onResume

protected open fun onResume(): Unit

Dispatch onResume() to fragments. Note that for better inter-operation with older versions of the platform, at the point of this call the fragments attached to the activity are not resumed.

onResumeFragments

protected open fun onResumeFragments(): Unit

This is the fragment-orientated version of onResume() that you can override to perform operations in the Activity at the same point where its fragments are resumed. Be sure to always call through to the super-class.

onStart

protected open fun onStart(): Unit

Dispatch onStart() to all fragments.

onStop

protected open fun onStop(): Unit

Dispatch onStop() to all fragments.