AppCompatActivity

Kotlin |Java

open class AppCompatActivity : FragmentActivity, AppCompatCallback, TaskStackBuilder.SupportParentable, ActionBarDrawerToggle.DelegateProvider

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

Base class for activities that use the support library action bar features.

You can add an androidx.appcompat.app.ActionBar to your activity when running on API level 7 or higher by extending this class for your activity and setting the activity theme to androidx.appcompat.R.style#Theme_AppCompat or a similar theme.

Summary

Public constructors
`<init>()` Default constructor for AppCompatActivity.
`<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	`addContentView(view: View!, params: LayoutParams!)`
open Unit	`closeOptionsMenu()`
open Boolean	`dispatchKeyEvent(event: KeyEvent!)`
open T	`findViewById(@IdRes id: Int)`
open AppCompatDelegate	`getDelegate()`
open ActionBarDrawerToggle.Delegate?	`getDrawerToggleDelegate()`
open MenuInflater	`getMenuInflater()`
open Resources!	`getResources()`
open ActionBar?	`getSupportActionBar()` Support library version of `android.app.Activity#getActionBar`.
open Intent?	`getSupportParentActivityIntent()` Obtain an `android.content.Intent` that will launch an explicit target activity specified by sourceActivity's `androidx.core.app.NavUtils#PARENT_ACTIVITY` <meta-data> element in the application's manifest.
open Unit	`invalidateOptionsMenu()`
open Unit	`onConfigurationChanged(@NonNull newConfig: Configuration)`
open Unit	`onContentChanged()`
open Unit	`onCreateSupportNavigateUpTaskStack(@NonNull builder: TaskStackBuilder)` Support version of `onCreateNavigateUpTaskStack(android.app.TaskStackBuilder)`.
open Boolean	`onKeyDown(keyCode: Int, event: KeyEvent!)`
Boolean	`onMenuItemSelected(featureId: Int, @NonNull item: MenuItem)`
open Boolean	`onMenuOpened(featureId: Int, menu: Menu!)` Please note: AppCompat uses its own feature id for the action bar: `FEATURE_SUPPORT_ACTION_BAR`.
open Unit	`onPanelClosed(featureId: Int, @NonNull menu: Menu)` Call onOptionsMenuClosed() on fragments.
open Unit	`onPrepareSupportNavigateUpTaskStack(@NonNull builder: TaskStackBuilder)` Support version of `onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder)`.
open Unit	`onSupportActionModeFinished(@NonNull mode: ActionMode)` Notifies the activity that a support action mode has finished.
open Unit	`onSupportActionModeStarted(@NonNull mode: ActionMode)` Notifies the Activity that a support action mode has been started.
open Unit	`onSupportContentChanged()`
open Boolean	`onSupportNavigateUp()` This method is called whenever the user chooses to navigate Up within your application's activity hierarchy from the action bar.
open ActionMode?	`onWindowStartingSupportActionMode(@NonNull callback: ActionMode.Callback)` Called when a support action mode is being started for this window.
open Unit	`openOptionsMenu()`
open Unit	`setContentView(@LayoutRes layoutResID: Int)`
open Unit	`setContentView(view: View!)`
open Unit	`setContentView(view: View!, params: LayoutParams!)`
open Unit	`setSupportActionBar(@Nullable toolbar: Toolbar?)` Set a `Toolbar` to act as the `androidx.appcompat.app.ActionBar` for this Activity window.
open Unit	`setSupportProgress(progress: Int)`
open Unit	`setSupportProgressBarIndeterminate(indeterminate: Boolean)`
open Unit	`setSupportProgressBarIndeterminateVisibility(visible: Boolean)`
open Unit	`setSupportProgressBarVisibility(visible: Boolean)`
open Unit	`setTheme(@StyleRes resId: Int)`
open ActionMode?	`startSupportActionMode(@NonNull callback: ActionMode.Callback)` Start an action mode.
open Unit	`supportInvalidateOptionsMenu()`
open Unit	`supportNavigateUpTo(@NonNull upIntent: Intent)` Navigate from sourceActivity to the activity specified by upIntent, finishing sourceActivity in the process.
open Boolean	`supportRequestWindowFeature(featureId: Int)` Enable extended support library window features.
open Boolean	`supportShouldUpRecreateTask(@NonNull targetIntent: Intent)` Returns true if sourceActivity should recreate the task when navigating 'up' by using targetIntent.

Protected methods
open Unit	`attachBaseContext(newBase: Context!)`
open Unit	`onCreate(@Nullable savedInstanceState: Bundle?)`
open Unit	`onDestroy()`
open Unit	`onNightModeChanged(mode: Int)` Called when the night mode has changed.
open Unit	`onPostCreate(@Nullable savedInstanceState: Bundle?)`
open Unit	`onPostResume()`
open Unit	`onSaveInstanceState(@NonNull outState: Bundle)`
open Unit	`onStart()`
open Unit	`onStop()`
open Unit	`onTitleChanged(title: CharSequence!, color: Int)`

Inherited functions

From class FragmentActivity

`Unit`	`dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?)` Print the Activity's state into the given stream. This gets invoked if you run "adb shell dumpsys activity ".
`FragmentManager`	`getSupportFragmentManager()` Return the FragmentManager for interacting with fragments associated with this activity.
`LoaderManager`	`getSupportLoaderManager()`
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?)` Dispatch incoming result to the correct fragment.
`Unit`	`onAttachFragment(@NonNull fragment: Fragment)` 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`.
`Boolean`	`onCreatePanelMenu(featureId: Int, @NonNull menu: Menu)` Dispatch to Fragment.onCreateOptionsMenu().
`View?`	`onCreateView(@Nullable parent: View?, @NonNull name: String, @NonNull context: Context, @NonNull attrs: AttributeSet)`
`View?`	`onCreateView(@NonNull name: String, @NonNull context: Context, @NonNull attrs: AttributeSet)`
`Unit`	`onLowMemory()` Dispatch onLowMemory() to all fragments.
`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.
`Unit`	`onNewIntent(intent: Intent!)` 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.
`Unit`	`onPause()` Dispatch onPause() to fragments.
`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.
`Boolean`	`onPreparePanel(featureId: Int, @Nullable view: View?, @NonNull menu: Menu)` Dispatch onPrepareOptionsMenu() to fragments.
`Unit`	`onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<String!>, @NonNull grantResults: IntArray)` Callback for the result from requesting permissions. This method is invoked for every call on `requestPermissions(String[], int)`. Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.
`Unit`	`onResume()` 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.
`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. Be sure to always call through to the super-class.
`Unit`	`onStateNotSaved()` Hook in to note that fragment state is no longer saved.
`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. This requires `Window#FEATURE_CONTENT_TRANSITIONS`.
`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. Most calls will only come when returning from the started Activity. This requires `Window#FEATURE_CONTENT_TRANSITIONS`.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int)` Modifies the standard behavior to allow results to be delivered to fragments. This imposes a restriction that requestCode be <= 0xffff.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int, @Nullable options: Bundle?)`
`Unit`	`startActivityFromFragment(@NonNull fragment: Fragment, intent: Intent!, requestCode: Int)` Called by Fragment.startActivityForResult() to implement its behavior.
`Unit`	`startActivityFromFragment(@NonNull fragment: Fragment, intent: Intent!, requestCode: Int, @Nullable options: Bundle?)` Called by Fragment.startActivityForResult() to implement its behavior.
`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?)`
`Unit`	`startIntentSenderFromFragment(@NonNull fragment: Fragment, intent: IntentSender!, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?)` Called by Fragment.startIntentSenderForResult() to implement its behavior.
`Unit`	`supportFinishAfterTransition()` 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.
`Unit`	`supportPostponeEnterTransition()` Support library version of `android.app.Activity#postponeEnterTransition()` that works only on API 21 and later.
`Unit`	`supportStartPostponedEnterTransition()` Support library version of `android.app.Activity#startPostponedEnterTransition()` that only works with API 21 and later.
`Unit`	`validateRequestPermissionsRequestCode(requestCode: Int)`

From class ComponentActivity

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

Extension functions

From androidx.navigation.ui.androidx.appcompat.app.AppCompatActivity

Unit	`AppCompatActivity.setupActionBarWithNavController(navController: NavController, drawerLayout: DrawerLayout?)` Sets up the ActionBar returned by AppCompatActivity.getSupportActionBar for use with a NavController.
Unit	`AppCompatActivity.setupActionBarWithNavController(navController: NavController, configuration: AppBarConfiguration = AppBarConfiguration(navController.graph))` Sets up the ActionBar returned by AppCompatActivity.getSupportActionBar for use with a NavController.

Public constructors

<init>

AppCompatActivity()

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

<init>

AppCompatActivity(@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

#AppCompatActivity()

Public methods

addContentView

open fun addContentView(view: View!, params: LayoutParams!): Unit

closeOptionsMenu

open fun closeOptionsMenu(): Unit

dispatchKeyEvent

open fun dispatchKeyEvent(event: KeyEvent!): Boolean

findViewById

open fun <T : View!> findViewById(@IdRes id: Int): T

getDelegate

@NonNull open fun getDelegate(): AppCompatDelegate

Return
AppCompatDelegate: The `AppCompatDelegate` being used by this Activity.

getDrawerToggleDelegate

@Nullable open fun getDrawerToggleDelegate(): ActionBarDrawerToggle.Delegate?

getMenuInflater

@NonNull open fun getMenuInflater(): MenuInflater

getResources

open fun getResources(): Resources!

getSupportActionBar

@Nullable open fun getSupportActionBar(): ActionBar?

Support library version of android.app.Activity#getActionBar.

Retrieve a reference to this activity's ActionBar.

Return
ActionBar?: The Activity's ActionBar, or null if it does not have one.

getSupportParentActivityIntent

@Nullable open fun getSupportParentActivityIntent(): Intent?

Obtain an android.content.Intent that will launch an explicit target activity specified by sourceActivity's androidx.core.app.NavUtils#PARENT_ACTIVITY <meta-data> element in the application's manifest. If the device is running Jellybean or newer, the android:parentActivityName attribute will be preferred if it is present.

Return
Intent?: a new Intent targeting the defined parent activity of sourceActivity

invalidateOptionsMenu

open fun invalidateOptionsMenu(): Unit

onConfigurationChanged

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

onContentChanged

open fun onContentChanged(): Unit

onCreateSupportNavigateUpTaskStack

open fun onCreateSupportNavigateUpTaskStack(@NonNull builder: TaskStackBuilder): Unit

Support version of onCreateNavigateUpTaskStack(android.app.TaskStackBuilder). This method will be called on all platform versions. Define the synthetic task stack that will be generated during Up navigation from a different task.

The default implementation of this method adds the parent chain of this activity as specified in the manifest to the supplied androidx.core.app.TaskStackBuilder. Applications may choose to override this method to construct the desired task stack in a different way.

This method will be invoked by the default implementation of onNavigateUp() if shouldUpRecreateTask(android.content.Intent) returns true when supplied with the intent returned by getParentActivityIntent().

Applications that wish to supply extra Intent parameters to the parent stack defined by the manifest should override onPrepareSupportNavigateUpTaskStack(androidx.core.app.TaskStackBuilder).

Parameters
`builder`	TaskStackBuilder: An empty TaskStackBuilder - the application should add intents representing the desired task stack

onKeyDown

open fun onKeyDown(keyCode: Int, event: KeyEvent!): Boolean

onMenuItemSelected

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

onMenuOpened

open fun onMenuOpened(featureId: Int, menu: Menu!): Boolean

Please note: AppCompat uses its own feature id for the action bar: FEATURE_SUPPORT_ACTION_BAR.

onPanelClosed

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

Call onOptionsMenuClosed() on fragments.

Please note: AppCompat uses its own feature id for the action bar: FEATURE_SUPPORT_ACTION_BAR.

onPrepareSupportNavigateUpTaskStack

open fun onPrepareSupportNavigateUpTaskStack(@NonNull builder: TaskStackBuilder): Unit

Support version of onPrepareNavigateUpTaskStack(android.app.TaskStackBuilder). This method will be called on all platform versions. Prepare the synthetic task stack that will be generated during Up navigation from a different task.

This method receives the androidx.core.app.TaskStackBuilder with the constructed series of Intents as generated by onCreateSupportNavigateUpTaskStack(androidx.core.app.TaskStackBuilder). If any extra data should be added to these intents before launching the new task, the application should override this method and add that data here.

Parameters
`builder`	TaskStackBuilder: A TaskStackBuilder that has been populated with Intents by onCreateNavigateUpTaskStack.

onSupportActionModeFinished

@CallSuper open fun onSupportActionModeFinished(@NonNull mode: ActionMode): Unit

Notifies the activity that a support action mode has finished. Activity subclasses overriding this method should call the superclass implementation.

Parameters
`mode`	ActionMode: The action mode that just finished.

onSupportActionModeStarted

@CallSuper open fun onSupportActionModeStarted(@NonNull mode: ActionMode): Unit

Notifies the Activity that a support action mode has been started. Activity subclasses overriding this method should call the superclass implementation.

Parameters
`mode`	ActionMode: The new action mode.

onSupportContentChanged

open fun onSupportContentChanged(): Unit

Deprecated: Use onContentChanged() instead.

onSupportNavigateUp

open fun onSupportNavigateUp(): Boolean

This method is called whenever the user chooses to navigate Up within your application's activity hierarchy from the action bar.

If a parent was specified in the manifest for this activity or an activity-alias to it, default Up navigation will be handled automatically. See getSupportParentActivityIntent() for how to specify the parent. If any activity along the parent chain requires extra Intent arguments, the Activity subclass should override the method onPrepareSupportNavigateUpTaskStack(androidx.core.app.TaskStackBuilder) to supply those arguments.

See Tasks and Back Stack from the developer guide and Navigation from the design guide for more information about navigating within your app.

See the androidx.core.app.TaskStackBuilder class and the Activity methods getSupportParentActivityIntent(), supportShouldUpRecreateTask(android.content.Intent), and supportNavigateUpTo(android.content.Intent) for help implementing custom Up navigation.

Return
Boolean: true if Up navigation completed successfully and this Activity was finished, false otherwise.

onWindowStartingSupportActionMode

@Nullable open fun onWindowStartingSupportActionMode(@NonNull callback: ActionMode.Callback): ActionMode?

Called when a support action mode is being started for this window. Gives the callback an opportunity to handle the action mode in its own unique and beautiful way. If this method returns null the system can choose a way to present the mode or choose not to start the mode at all.

Parameters
`callback`	ActionMode.Callback: Callback to control the lifecycle of this action mode

Return
ActionMode?: The ActionMode that was started, or null if the system should present it

openOptionsMenu

open fun openOptionsMenu(): Unit

setContentView

open fun setContentView(@LayoutRes layoutResID: Int): Unit

setContentView

open fun setContentView(view: View!): Unit

setContentView

open fun setContentView(view: View!, params: LayoutParams!): Unit

setSupportActionBar

open fun setSupportActionBar(@Nullable toolbar: Toolbar?): Unit

Set a Toolbar to act as the androidx.appcompat.app.ActionBar for this Activity window.

When set to a non-null value the getActionBar() method will return an androidx.appcompat.app.ActionBar object that can be used to control the given toolbar as if it were a traditional window decor action bar. The toolbar's menu will be populated with the Activity's options menu and the navigation button will be wired through the standard home menu select action.

In order to use a Toolbar within the Activity's window content the application must not request the window feature FEATURE_SUPPORT_ACTION_BAR.

Parameters
`toolbar`	Toolbar?: Toolbar to set as the Activity's action bar, or `null` to clear it

setSupportProgress

open fun setSupportProgress(progress: Int): Unit

Deprecated: Progress bars are no longer provided in AppCompat.

setSupportProgressBarIndeterminate

open fun setSupportProgressBarIndeterminate(indeterminate: Boolean): Unit

Deprecated: Progress bars are no longer provided in AppCompat.

setSupportProgressBarIndeterminateVisibility

open fun setSupportProgressBarIndeterminateVisibility(visible: Boolean): Unit

Deprecated: Progress bars are no longer provided in AppCompat.

setSupportProgressBarVisibility

open fun setSupportProgressBarVisibility(visible: Boolean): Unit

Deprecated: Progress bars are no longer provided in AppCompat.

setTheme

open fun setTheme(@StyleRes resId: Int): Unit

startSupportActionMode

@Nullable open fun startSupportActionMode(@NonNull callback: ActionMode.Callback): ActionMode?

Start an action mode.

Parameters
`callback`	ActionMode.Callback: Callback that will manage lifecycle events for this context mode

Return
ActionMode?: The ContextMode that was started, or null if it was canceled

supportInvalidateOptionsMenu

open fun supportInvalidateOptionsMenu(): Unit

supportNavigateUpTo

open fun supportNavigateUpTo(@NonNull upIntent: Intent): Unit

Navigate from sourceActivity to the activity specified by upIntent, finishing sourceActivity in the process. upIntent will have the flag android.content.Intent#FLAG_ACTIVITY_CLEAR_TOP set by this method, along with any others required for proper up navigation as outlined in the Android Design Guide.

This method should be used when performing up navigation from within the same task as the destination. If up navigation should cross tasks in some cases, see supportShouldUpRecreateTask(android.content.Intent).

Parameters
`upIntent`	Intent: An intent representing the target destination for up navigation

supportRequestWindowFeature

open fun supportRequestWindowFeature(featureId: Int): Boolean

Enable extended support library window features.

This is a convenience for calling getWindow().requestFeature().

Parameters
`featureId`	Int: The desired feature as defined in `android.view.Window` or `androidx.core.view.WindowCompat`.

Return
Boolean: Returns true if the requested feature is supported and now enabled.

See Also

android.app.Activity#requestWindowFeatureandroid.view.Window#requestFeature

supportShouldUpRecreateTask

open fun supportShouldUpRecreateTask(@NonNull targetIntent: Intent): Boolean

Returns true if sourceActivity should recreate the task when navigating 'up' by using targetIntent.

If this method returns false the app can trivially call supportNavigateUpTo(android.content.Intent) using the same parameters to correctly perform up navigation. If this method returns false, the app should synthesize a new task stack by using androidx.core.app.TaskStackBuilder or another similar mechanism to perform up navigation.

Parameters
`targetIntent`	Intent: An intent representing the target destination for up navigation

Return
Boolean: true if navigating up should recreate a new task stack, false if the same task should be used for the destination

Protected methods

attachBaseContext

protected open fun attachBaseContext(newBase: Context!): Unit

onCreate

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

onDestroy

protected open fun onDestroy(): Unit

onNightModeChanged

protected open fun onNightModeChanged(mode: Int): Unit

Called when the night mode has changed. See AppCompatDelegate#applyDayNight() for more information.

Parameters
`mode`	Int: the night mode which has been applied

onPostCreate

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

onPostResume

protected open fun onPostResume(): Unit

onSaveInstanceState

protected open fun onSaveInstanceState(@NonNull outState: Bundle): Unit

onStart

protected open fun onStart(): Unit

onStop

protected open fun onStop(): Unit

onTitleChanged

protected open fun onTitleChanged(title: CharSequence!, color: Int): Unit