public
class
AppCompatActivity
extends FragmentActivity
implements
AppCompatCallback,
TaskStackBuilder.SupportParentable,
ActionBarDrawerToggle.DelegateProvider
java.lang.Object | ||||||
↳ | android.content.Context | |||||
↳ | android.content.ContextWrapper | |||||
↳ | android.view.ContextThemeWrapper | |||||
↳ | android.app.Activity | |||||
↳ | android.support.v4.app.FragmentActivity | |||||
↳ | android.support.v7.app.AppCompatActivity |
Known Direct Subclasses |
Base class for activities that use the support library action bar features.
You can add an 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
Theme.AppCompat
or a similar theme.
For information about how to use the action bar, including how to add action items, navigation modes and more, read the Action Bar API guide.
Inherited constants |
---|
From
class
android.app.Activity
|
From
class
android.content.Context
|
From
interface
android.content.ComponentCallbacks2
|
Inherited fields |
---|
From
class
android.app.Activity
|
Public constructors | |
---|---|
AppCompatActivity()
|
Public methods | |
---|---|
void
|
addContentView(View view, ViewGroup.LayoutParams params)
Add an additional content view to the activity. |
boolean
|
dispatchKeyEvent(KeyEvent event)
Called to process key events. |
View
|
findViewById(int id)
Finds a view that was identified by the id attribute from the XML that
was processed in |
AppCompatDelegate
|
getDelegate()
|
ActionBarDrawerToggle.Delegate
|
getDrawerToggleDelegate()
|
MenuInflater
|
getMenuInflater()
Returns a |
Resources
|
getResources()
Returns a Resources instance for the application's package. |
ActionBar
|
getSupportActionBar()
Support library version of |
Intent
|
getSupportParentActivityIntent()
Obtain an |
void
|
onConfigurationChanged(Configuration newConfig)
Dispatch configuration change to all fragments. |
void
|
onContentChanged()
This hook is called whenever the content view of the screen changes
(due to a call to
|
void
|
onCreateSupportNavigateUpTaskStack(TaskStackBuilder builder)
Support version of |
final
boolean
|
onMenuItemSelected(int featureId, MenuItem item)
Dispatch context and options menu to fragments. |
boolean
|
onMenuOpened(int featureId, Menu menu)
Called when a panel's menu is opened by the user. Please note: AppCompat uses it's own feature id for the action bar:
|
void
|
onPanelClosed(int featureId, Menu menu)
Call onOptionsMenuClosed() on fragments. Please note: AppCompat uses it's own feature id for the action bar:
|
void
|
onPrepareSupportNavigateUpTaskStack(TaskStackBuilder builder)
Support version of |
void
|
onSupportActionModeFinished(ActionMode mode)
Notifies the activity that a support action mode has finished. |
void
|
onSupportActionModeStarted(ActionMode mode)
Notifies the Activity that a support action mode has been started. |
void
|
onSupportContentChanged()
This method is deprecated.
Use |
boolean
|
onSupportNavigateUp()
This method is called whenever the user chooses to navigate Up within your application's activity hierarchy from the action bar. |
ActionMode
|
onWindowStartingSupportActionMode(ActionMode.Callback callback)
Called when a support action mode is being started for this window. |
void
|
setContentView(View view)
Set the activity content to an explicit view. |
void
|
setContentView(int layoutResID)
Set the activity content from a layout resource. |
void
|
setContentView(View view, ViewGroup.LayoutParams params)
Set the activity content to an explicit view. |
void
|
setSupportActionBar(Toolbar toolbar)
Set a |
void
|
setSupportProgress(int progress)
This method is deprecated. Progress bars are no longer provided in AppCompat. |
void
|
setSupportProgressBarIndeterminate(boolean indeterminate)
This method is deprecated. Progress bars are no longer provided in AppCompat. |
void
|
setSupportProgressBarIndeterminateVisibility(boolean visible)
This method is deprecated. Progress bars are no longer provided in AppCompat. |
void
|
setSupportProgressBarVisibility(boolean visible)
This method is deprecated. Progress bars are no longer provided in AppCompat. |
void
|
setTheme(int resid)
Set the base theme for this context. |
ActionMode
|
startSupportActionMode(ActionMode.Callback callback)
Start an action mode. |
void
|
supportInvalidateOptionsMenu()
Support library version of |
void
|
supportNavigateUpTo(Intent upIntent)
Navigate from sourceActivity to the activity specified by upIntent, finishing sourceActivity in the process. |
boolean
|
supportRequestWindowFeature(int featureId)
Enable extended support library window features. |
boolean
|
supportShouldUpRecreateTask(Intent targetIntent)
Returns true if sourceActivity should recreate the task when navigating 'up' by using targetIntent. |
Protected methods | |
---|---|
void
|
onCreate(Bundle savedInstanceState)
Perform initialization of all fragments and loaders. |
void
|
onDestroy()
Destroy all fragments and loaders. |
void
|
onPostCreate(Bundle savedInstanceState)
Called when activity start-up is complete (after |
void
|
onPostResume()
Dispatch onResume() to fragments. |
void
|
onSaveInstanceState(Bundle outState)
Save all appropriate fragment state. |
void
|
onStop()
Dispatch onStop() to all fragments. |
void
|
onTitleChanged(CharSequence title, int color)
|
Inherited methods | |
---|---|
From
class
android.support.v4.app.FragmentActivity
| |
From
class
android.app.Activity
| |
From
class
android.view.ContextThemeWrapper
| |
From
class
android.content.ContextWrapper
| |
From
class
android.content.Context
| |
From
class
java.lang.Object
| |
From
interface
android.support.v4.app.ActivityCompat.OnRequestPermissionsResultCallback
| |
From
interface
android.support.v4.app.ActivityCompatApi23.RequestPermissionsRequestCodeValidator
| |
From
interface
android.view.LayoutInflater.Factory2
| |
From
interface
android.view.Window.Callback
| |
From
interface
android.view.KeyEvent.Callback
| |
From
interface
android.view.View.OnCreateContextMenuListener
| |
From
interface
android.content.ComponentCallbacks2
| |
From
interface
android.support.v7.app.AppCompatCallback
| |
From
interface
android.support.v4.app.TaskStackBuilder.SupportParentable
| |
From
interface
android.support.v7.app.ActionBarDrawerToggle.DelegateProvider
| |
From
interface
android.view.LayoutInflater.Factory
| |
From
interface
android.content.ComponentCallbacks
|
AppCompatActivity ()
void addContentView (View view, ViewGroup.LayoutParams params)
Add an additional content view to the activity. Added after any existing ones in the activity -- existing views are NOT removed.
Parameters | |
---|---|
view |
View :
The desired content to display. |
params |
ViewGroup.LayoutParams :
Layout parameters for the view.
|
boolean dispatchKeyEvent (KeyEvent event)
Called to process key events. You can override this to intercept all key events before they are dispatched to the window. Be sure to call this implementation for key events that should be handled normally.
Parameters | |
---|---|
event |
KeyEvent :
The key event. |
Returns | |
---|---|
boolean |
boolean Return true if this event was consumed. |
View findViewById (int id)
Finds a view that was identified by the id attribute from the XML that
was processed in onCreate(Bundle)
.
Parameters | |
---|---|
id |
int
|
Returns | |
---|---|
View |
The view if found or null otherwise. |
AppCompatDelegate getDelegate ()
Returns | |
---|---|
AppCompatDelegate |
The AppCompatDelegate being used by this Activity.
|
ActionBarDrawerToggle.Delegate getDrawerToggleDelegate ()
Returns | |
---|---|
ActionBarDrawerToggle.Delegate |
MenuInflater getMenuInflater ()
Returns a MenuInflater
with this context.
Returns | |
---|---|
MenuInflater |
Resources getResources ()
Returns a Resources instance for the application's package.
Note: Implementations of this method should return
a Resources instance that is consistent with the AssetManager instance
returned by getAssets()
. For example, they should share the
same Configuration
object.
Returns | |
---|---|
Resources |
a Resources instance for the application's package |
ActionBar getSupportActionBar ()
Support library version of getActionBar()
.
Retrieve a reference to this activity's ActionBar.
Returns | |
---|---|
ActionBar |
The Activity's ActionBar, or null if it does not have one. |
Intent getSupportParentActivityIntent ()
Obtain an Intent
that will launch an explicit target activity
specified by sourceActivity's 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.
Returns | |
---|---|
Intent |
a new Intent targeting the defined parent activity of sourceActivity |
void onConfigurationChanged (Configuration newConfig)
Dispatch configuration change to all fragments.
Parameters | |
---|---|
newConfig |
Configuration :
The new device configuration.
|
void onContentChanged ()
This hook is called whenever the content view of the screen changes
(due to a call to
Window.setContentView
or
Window.addContentView
).
void onCreateSupportNavigateUpTaskStack (TaskStackBuilder builder)
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 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(android.support.v4.app.TaskStackBuilder)
.
Parameters | |
---|---|
builder |
TaskStackBuilder :
An empty TaskStackBuilder - the application should add intents representing
the desired task stack
|
boolean onMenuItemSelected (int featureId, MenuItem item)
Dispatch context and options menu to fragments.
Parameters | |
---|---|
featureId |
int :
The panel that the menu is in. |
item |
MenuItem :
The menu item that was selected. |
Returns | |
---|---|
boolean |
boolean Return true to finish processing of selection, or false to perform the normal menu handling (calling its Runnable or sending a Message to its target Handler). |
boolean onMenuOpened (int featureId, Menu menu)
Called when a panel's menu is opened by the user. This may also be called when the menu is changing from one type to another (for example, from the icon menu to the expanded menu).
Please note: AppCompat uses it's own feature id for the action bar:
FEATURE_SUPPORT_ACTION_BAR
.
Parameters | |
---|---|
featureId |
int :
The panel that the menu is in. |
menu |
Menu :
The menu that is opened. |
Returns | |
---|---|
boolean |
The default implementation returns true. |
void onPanelClosed (int featureId, Menu menu)
Call onOptionsMenuClosed() on fragments.
Please note: AppCompat uses it's own feature id for the action bar:
FEATURE_SUPPORT_ACTION_BAR
.
Parameters | |
---|---|
featureId |
int :
The panel that is being displayed. |
menu |
Menu :
If onCreatePanelView() returned null, this is the Menu
being displayed in the panel.
|
void onPrepareSupportNavigateUpTaskStack (TaskStackBuilder builder)
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 TaskStackBuilder
with the constructed series of
Intents as generated by onCreateSupportNavigateUpTaskStack(android.support.v4.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.
|
void onSupportActionModeFinished (ActionMode mode)
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.
|
void onSupportActionModeStarted (ActionMode mode)
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.
|
void onSupportContentChanged ()
This method is deprecated.
Use onContentChanged()
instead.
boolean onSupportNavigateUp ()
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(android.support.v4.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 TaskStackBuilder
class and the Activity methods
getSupportParentActivityIntent()
, supportShouldUpRecreateTask(android.content.Intent)
, and
supportNavigateUpTo(android.content.Intent)
for help implementing custom Up navigation.
Returns | |
---|---|
boolean |
true if Up navigation completed successfully and this Activity was finished, false otherwise. |
ActionMode onWindowStartingSupportActionMode (ActionMode.Callback callback)
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 |
Returns | |
---|---|
ActionMode |
The ActionMode that was started, or null if the system should present it |
void setContentView (View view)
Set the activity content to an explicit view. This view is placed
directly into the activity's view hierarchy. It can itself be a complex
view hierarchy. When calling this method, the layout parameters of the
specified view are ignored. Both the width and the height of the view are
set by default to MATCH_PARENT
. To use
your own layout parameters, invoke
setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
instead.
Parameters | |
---|---|
view |
View :
The desired content to display. |
void setContentView (int layoutResID)
Set the activity content from a layout resource. The resource will be inflated, adding all top-level views to the activity.
Parameters | |
---|---|
layoutResID |
int :
Resource ID to be inflated. |
void setContentView (View view, ViewGroup.LayoutParams params)
Set the activity content to an explicit view. This view is placed directly into the activity's view hierarchy. It can itself be a complex view hierarchy.
Parameters | |
---|---|
view |
View :
The desired content to display. |
params |
ViewGroup.LayoutParams :
Layout parameters for the view. |
void setSupportActionBar (Toolbar toolbar)
Set a Toolbar
to act as the
ActionBar
for this Activity window.
When set to a non-null value the getActionBar()
method will return
an 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
|
void setSupportProgress (int progress)
This method is deprecated.
Progress bars are no longer provided in AppCompat.
Parameters | |
---|---|
progress |
int
|
void setSupportProgressBarIndeterminate (boolean indeterminate)
This method is deprecated.
Progress bars are no longer provided in AppCompat.
Parameters | |
---|---|
indeterminate |
boolean
|
void setSupportProgressBarIndeterminateVisibility (boolean visible)
This method is deprecated.
Progress bars are no longer provided in AppCompat.
Parameters | |
---|---|
visible |
boolean
|
void setSupportProgressBarVisibility (boolean visible)
This method is deprecated.
Progress bars are no longer provided in AppCompat.
Parameters | |
---|---|
visible |
boolean
|
void setTheme (int resid)
Set the base theme for this context. Note that this should be called
before any views are instantiated in the Context (for example before
calling setContentView(View)
or
inflate(int, ViewGroup)
).
Parameters | |
---|---|
resid |
int :
The style resource describing the theme.
|
ActionMode startSupportActionMode (ActionMode.Callback callback)
Start an action mode.
Parameters | |
---|---|
callback |
ActionMode.Callback :
Callback that will manage lifecycle events for this context mode |
Returns | |
---|---|
ActionMode |
The ContextMode that was started, or null if it was canceled |
void supportInvalidateOptionsMenu ()
Support library version of 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.
void supportNavigateUpTo (Intent upIntent)
Navigate from sourceActivity to the activity specified by upIntent, finishing sourceActivity
in the process. upIntent will have the flag 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
|
boolean supportRequestWindowFeature (int featureId)
Enable extended support library window features.
This is a convenience for calling
getWindow().requestFeature()
.
Parameters | |
---|---|
featureId |
int :
The desired feature as defined in
Window or WindowCompat . |
Returns | |
---|---|
boolean |
Returns true if the requested feature is supported and now enabled. |
boolean supportShouldUpRecreateTask (Intent targetIntent)
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 TaskStackBuilder
or another similar mechanism to perform up navigation.
Parameters | |
---|---|
targetIntent |
Intent :
An intent representing the target destination for up navigation |
Returns | |
---|---|
boolean |
true if navigating up should recreate a new task stack, false if the same task should be used for the destination |
void onCreate (Bundle savedInstanceState)
Perform initialization of all fragments and loaders.
Parameters | |
---|---|
savedInstanceState |
Bundle :
If the activity is being re-initialized after
previously being shut down then this Bundle contains the data it most
recently supplied in onSaveInstanceState(Bundle) . Note: Otherwise it is null. |
void onDestroy ()
Destroy all fragments and loaders.
void onPostCreate (Bundle savedInstanceState)
Called when activity start-up is complete (after onStart()
and onRestoreInstanceState(Bundle)
have been called). Applications will
generally not implement this method; it is intended for system
classes to do final initialization after application code has run.
Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.
Parameters | |
---|---|
savedInstanceState |
Bundle :
If the activity is being re-initialized after
previously being shut down then this Bundle contains the data it most
recently supplied in onSaveInstanceState(Bundle) . Note: Otherwise it is null. |
void onPostResume ()
Dispatch onResume() to fragments.
void onSaveInstanceState (Bundle outState)
Save all appropriate fragment state.
Parameters | |
---|---|
outState |
Bundle :
Bundle in which to place your saved state. |
void onStop ()
Dispatch onStop() to all fragments. Ensure all loaders are stopped.
void onTitleChanged (CharSequence title, int color)
Parameters | |
---|---|
title |
CharSequence
|
color |
int
|