java.lang.Object | |
↳ | android.support.v4.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 backward-compatible way to obey the correct conventions
around cross-task navigation on the device's version of the platform. On devices running
Android 3.0 or newer, calls to the startActivities()
method or sending the
PendingIntent
generated by getPendingIntent(int, int)
will construct
the synthetic back stack as prescribed. On devices running older versions of the platform,
these same calls will invoke the topmost activity in the supplied stack, ignoring
the rest of the synthetic stack and allowing the back key to navigate back to the previous
task.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Add a new Intent to the task stack.
| |||||||||||
Add a new Intent with the resolved chain of parents for the target activity to
the task stack.
| |||||||||||
Add the activity parent chain as specified by manifest <meta-data> elements
to the task stack builder.
| |||||||||||
Add the activity parent chain as specified by manifest <meta-data> elements
to the task stack builder.
| |||||||||||
Add the activity parent chain as specified by manifest <meta-data> elements
to the task stack builder.
| |||||||||||
Return a new TaskStackBuilder for launching a fresh task stack consisting
of a series of activities.
| |||||||||||
Return the intent at the specified index for modification.
| |||||||||||
This method was deprecated
in API level .
use
create(Context) instead
| |||||||||||
This method was deprecated
in API level .
Renamed to editIntentAt to better reflect intended usage
| |||||||||||
Return an array containing the intents added to this builder.
| |||||||||||
Obtain a
PendingIntent for launching the task constructed by this builder so far. | |||||||||||
Obtain a
PendingIntent for launching the task constructed by this builder so far. | |||||||||||
This method was deprecated
in API level .
Use editIntentAt instead
| |||||||||||
Start the task stack constructed by this builder.
| |||||||||||
Start the task stack constructed by this builder.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Iterable
|
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.
nextIntent | Intent for the next Activity in the synthesized task stack |
---|
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.
nextIntent | Intent for the topmost Activity in the synthesized task stack. Its chain of parents as specified in the manifest will be added. |
---|
Add the activity parent chain as specified by manifest <meta-data> elements to the task stack builder.
sourceActivity | All parents of this activity will be added |
---|
Add the activity parent chain as specified by manifest <meta-data> elements to the task stack builder.
sourceActivityName | Must specify an Activity component. All parents of this activity will be added |
---|
Add the activity parent chain as specified by manifest <meta-data> elements to the task stack builder.
sourceActivityClass | All parents of this activity will be added |
---|
Return a new TaskStackBuilder for launching a fresh task stack consisting of a series of activities.
context | The context that will launch the new task stack or generate a PendingIntent |
---|
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)
.
index | Index from 0-getIntentCount() |
---|
This method was deprecated
in API level .
use create(Context)
instead
Return a new TaskStackBuilder for launching a fresh task stack consisting of a series of activities.
context | The context that will launch the new task stack or generate a PendingIntent |
---|
This method was deprecated
in API level .
Renamed to editIntentAt to better reflect intended usage
Get the intent at the specified index.
Useful if you need to modify the flags or extras of an intent that was previously added,
for example with addParentStack(Activity)
.
index | Index from 0-getIntentCount() |
---|
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.
Obtain a PendingIntent
for launching the task constructed by this builder so far.
requestCode | Private request code for the sender |
---|---|
flags | 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. |
Obtain a PendingIntent
for launching the task constructed by this builder so far.
requestCode | Private request code for the sender |
---|---|
flags | 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 | Additional options for how the Activity should be started. See {@link android.content.Context#startActivity(Intent, Bundle) |
This method was deprecated
in API level .
Use editIntentAt instead
Returns an Iterator
for the elements in this object.
Iterator
instance.
Start the task stack constructed by this builder. The Context used to obtain this builder must be an Activity.
On devices that do not support API level 11 or higher the topmost activity will be started as a new task. On devices that do support API level 11 or higher the new task stack will be created in its entirety.
options | Additional options for how the Activity should be started. See {@link android.content.Context#startActivity(Intent, Bundle) |
---|
Start the task stack constructed by this builder. The Context used to obtain this builder must be an Activity.
On devices that do not support API level 11 or higher the topmost activity will be started as a new task. On devices that do support API level 11 or higher the new task stack will be created in its entirety.