public
class
TaskStackBuilder
extends Object
| java.lang.Object | |
| ↳ | android.app.TaskStackBuilder |
Utility class for constructing synthetic back stacks for cross-task navigation on Android 3.0 and newer.
In API level 11 (Android 3.0/Honeycomb) the recommended conventions for app navigation using the back key changed. The back key's behavior is local to the current task and does not capture navigation across different tasks. Navigating across tasks and easily reaching the previous task is accomplished through the "recents" UI, accessible through the software-provided Recents key on the navigation or system bar. On devices with the older hardware button configuration the recents UI can be accessed with a long press on the Home key.
When crossing from one task stack to another post-Android 3.0, the application should synthesize a back stack/history for the new task so that the user may navigate out of the new task and back to the Launcher by repeated presses of the back key. Back key presses should not navigate across task stacks.
TaskStackBuilder provides a way to obey the correct conventions around cross-task navigation.
Public methods | |
|---|---|
TaskStackBuilder
|
addNextIntent(Intent nextIntent)
Add a new Intent to the task stack. |
TaskStackBuilder
|
addNextIntentWithParentStack(Intent nextIntent)
Add a new Intent with the resolved chain of parents for the target activity to the task stack. |
TaskStackBuilder
|
addParentStack(ComponentName sourceActivityName)
Add the activity parent chain as specified by the
|
TaskStackBuilder
|
addParentStack(Activity sourceActivity)
Add the activity parent chain as specified by the
|
TaskStackBuilder
|
addParentStack(Class<?> sourceActivityClass)
Add the activity parent chain as specified by the
|
static
TaskStackBuilder
|
create(Context context)
Return a new TaskStackBuilder for launching a fresh task stack consisting of a series of activities. |
Intent
|
editIntentAt(int index)
Return the intent at the specified index for modification. |
int
|
getIntentCount()
|
Intent[]
|
getIntents()
Return an array containing the intents added to this builder. |
PendingIntent
|
getPendingIntent(int requestCode, int flags)
Obtain a |
PendingIntent
|
getPendingIntent(int requestCode, int flags, Bundle options)
Obtain a |
void
|
startActivities()
Start the task stack constructed by this builder. |
void
|
startActivities(Bundle options)
Start the task stack constructed by this builder. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
TaskStackBuilder addNextIntent (Intent nextIntent)
Add a new Intent to the task stack. The most recently added Intent will invoke the Activity at the top of the final task stack.
| Parameters | |
|---|---|
nextIntent |
Intent:
Intent for the next Activity in the synthesized task stack |
| Returns | |
|---|---|
TaskStackBuilder |
This TaskStackBuilder for method chaining |
TaskStackBuilder addNextIntentWithParentStack (Intent nextIntent)
Add a new Intent with the resolved chain of parents for the target activity to the task stack.
This is equivalent to calling addParentStack
with the resolved ComponentName of nextIntent (if it can be resolved), followed by
addNextIntent with nextIntent.
| Parameters | |
|---|---|
nextIntent |
Intent:
Intent for the topmost Activity in the synthesized task stack.
Its chain of parents as specified in the manifest will be added. |
| Returns | |
|---|---|
TaskStackBuilder |
This TaskStackBuilder for method chaining. |
TaskStackBuilder addParentStack (ComponentName sourceActivityName)
Add the activity parent chain as specified by the
parentActivityName attribute of the activity
(or activity-alias) element in the application's manifest to the task stack builder.
| Parameters | |
|---|---|
sourceActivityName |
ComponentName:
Must specify an Activity component. All parents of
this activity will be added |
| Returns | |
|---|---|
TaskStackBuilder |
This TaskStackBuilder for method chaining |
TaskStackBuilder addParentStack (Activity sourceActivity)
Add the activity parent chain as specified by the
getParentActivityIntent() method of the activity
specified and the parentActivityName attributes
of each successive activity (or activity-alias) element in the application's manifest
to the task stack builder.
| Parameters | |
|---|---|
sourceActivity |
Activity:
All parents of this activity will be added |
| Returns | |
|---|---|
TaskStackBuilder |
This TaskStackBuilder for method chaining |
TaskStackBuilder addParentStack (Class<?> sourceActivityClass)
Add the activity parent chain as specified by the
parentActivityName attribute of the activity
(or activity-alias) element in the application's manifest to the task stack builder.
| Parameters | |
|---|---|
sourceActivityClass |
Class:
All parents of this activity will be added |
| Returns | |
|---|---|
TaskStackBuilder |
This TaskStackBuilder for method chaining |
TaskStackBuilder create (Context context)
Return a new TaskStackBuilder for launching a fresh task stack consisting of a series of activities.
| Parameters | |
|---|---|
context |
Context:
The context that will launch the new task stack or generate a PendingIntent |
| Returns | |
|---|---|
TaskStackBuilder |
A new TaskStackBuilder |
Intent editIntentAt (int index)
Return the intent at the specified index for modification.
Useful if you need to modify the flags or extras of an intent that was previously added,
for example with addParentStack(Activity).
| Parameters | |
|---|---|
index |
int:
Index from 0-getIntentCount() |
| Returns | |
|---|---|
Intent |
the intent at position index |
int getIntentCount ()
| Returns | |
|---|---|
int |
the number of intents added so far. |
Intent[] getIntents ()
Return an array containing the intents added to this builder. The intent at the root of the task stack will appear as the first item in the array and the intent at the top of the stack will appear as the last item.
| Returns | |
|---|---|
Intent[] |
An array containing the intents added to this builder. |
PendingIntent getPendingIntent (int requestCode, int flags)
Obtain a PendingIntent for launching the task constructed by this builder so far.
| Parameters | |
|---|---|
requestCode |
int:
Private request code for the sender |
flags |
int:
May be FLAG_ONE_SHOT,
FLAG_NO_CREATE, FLAG_CANCEL_CURRENT,
FLAG_UPDATE_CURRENT, or any of the flags supported by
fillIn(Intent, int) to control which unspecified parts of the
intent that can be supplied when the actual send happens. |
| Returns | |
|---|---|
PendingIntent |
The obtained PendingIntent |
PendingIntent getPendingIntent (int requestCode, int flags, Bundle options)
Obtain a PendingIntent for launching the task constructed by this builder so far.
| Parameters | |
|---|---|
requestCode |
int:
Private request code for the sender |
flags |
int:
May be FLAG_ONE_SHOT,
FLAG_NO_CREATE, FLAG_CANCEL_CURRENT,
FLAG_UPDATE_CURRENT, or any of the flags supported by
fillIn(Intent, int) to control which unspecified parts of the
intent that can be supplied when the actual send happens. |
options |
Bundle:
Additional options for how the Activity should be started.
See Context.startActivity(Intent, Bundle) for more details. |
| Returns | |
|---|---|
PendingIntent |
The obtained PendingIntent |
void startActivities ()
Start the task stack constructed by this builder.
void startActivities (Bundle options)
Start the task stack constructed by this builder.
| Parameters | |
|---|---|
options |
Bundle:
Additional options for how the Activity should be started.
See Context.startActivity(Intent, Bundle) for more details.
|
Developers