Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

LocalActivityManager

extends Object
java.lang.Object
   ↳ android.app.LocalActivityManager

This class was deprecated in API level 13.
Use the new Fragment and FragmentManager APIs instead; these are also available on older platforms through the Android compatibility package.

Class Overview

Helper class for managing multiple running embedded activities in the same process. This class is not normally used directly, but rather created for you as part of the ActivityGroup implementation.

See Also

Summary

Public Constructors
LocalActivityManager ( Activity parent, boolean singleMode)
Create a new LocalActivityManager for holding activities running within the given parent .
Public Methods
Window destroyActivity ( String id, boolean finish)
Destroy the activity associated with a particular id.
void dispatchCreate ( Bundle state)
Restore a state that was previously returned by saveInstanceState() .
void dispatchDestroy (boolean finishing)
Called by the container activity in its onDestroy() so that LocalActivityManager can perform the corresponding action on the activities it holds.
void dispatchPause (boolean finishing)
Called by the container activity in its onPause() so that LocalActivityManager can perform the corresponding action on the activities it holds.
void dispatchResume ()
Called by the container activity in its onResume() so that LocalActivityManager can perform the corresponding action on the activities it holds.
void dispatchStop ()
Called by the container activity in its onStop() so that LocalActivityManager can perform the corresponding action on the activities it holds.
Activity getActivity ( String id)
Return the Activity object associated with a string ID.
Activity getCurrentActivity ()
Retrieve the Activity that is currently running.
String getCurrentId ()
Retrieve the ID of the activity that is currently running.
void removeAllActivities ()
Remove all activities from this LocalActivityManager, performing an onDestroy() on any that are currently instantiated.
Bundle saveInstanceState ()
Retrieve the state of all activities known by the group.
Window startActivity ( String id, Intent intent)
Start a new activity running in the group.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public LocalActivityManager ( Activity parent, boolean singleMode)

Added in API level 1

Create a new LocalActivityManager for holding activities running within the given parent .

Parameters
parent the host of the embedded activities
singleMode True if the LocalActivityManger should keep a maximum of one activity resumed

Public Methods

public Window destroyActivity ( String id, boolean finish)

Added in API level 1

Destroy the activity associated with a particular id. This activity will go through the normal lifecycle events and fine onDestroy(), and then the id removed from the group.

Parameters
id Unique identifier of the activity to be destroyed
finish If true, this activity will be finished, so its id and all state are removed from the group.
Returns
  • Returns the window that was used to display the activity, or null if there was none.

public void dispatchCreate ( Bundle state)

Added in API level 1

Restore a state that was previously returned by saveInstanceState() . This adds to the activity group information about all activity IDs that had previously been saved, even if they have not been started yet, so if the user later navigates to them the correct state will be restored.

Note: This does not change the current running activity, or start whatever activity was previously running when the state was saved. That is up to the client to do, in whatever way it thinks is best.

Parameters
state a previously saved state; does nothing if this is null
See Also

public void dispatchDestroy (boolean finishing)

Added in API level 1

Called by the container activity in its onDestroy() so that LocalActivityManager can perform the corresponding action on the activities it holds.

See Also

public void dispatchPause (boolean finishing)

Added in API level 1

Called by the container activity in its onPause() so that LocalActivityManager can perform the corresponding action on the activities it holds.

Parameters
finishing set to true if the parent activity has been finished; this can be determined by calling Activity.isFinishing()
See Also

public void dispatchResume ()

Added in API level 1

Called by the container activity in its onResume() so that LocalActivityManager can perform the corresponding action on the activities it holds.

See Also

public void dispatchStop ()

Added in API level 1

Called by the container activity in its onStop() so that LocalActivityManager can perform the corresponding action on the activities it holds.

See Also

public Activity getActivity ( String id)

Added in API level 1

Return the Activity object associated with a string ID.

Returns
  • the associated Activity object, or null if the id is unknown or its activity is not currently instantiated
See Also

public Activity getCurrentActivity ()

Added in API level 1

Retrieve the Activity that is currently running.

Returns
  • the currently running (resumed) Activity, or null if there is not one
See Also

public String getCurrentId ()

Added in API level 1

Retrieve the ID of the activity that is currently running.

Returns
  • the ID of the currently running (resumed) Activity, or null if there is not one
See Also

public void removeAllActivities ()

Added in API level 1

Remove all activities from this LocalActivityManager, performing an onDestroy() on any that are currently instantiated.

public Bundle saveInstanceState ()

Added in API level 1

Retrieve the state of all activities known by the group. For activities that have previously run and are now stopped or finished, the last saved state is used. For the current running activity, its onSaveInstanceState(Bundle) is called to retrieve its current state.

Returns
  • a Bundle holding the newly created state of all known activities
See Also

public Window startActivity ( String id, Intent intent)

Added in API level 1

Start a new activity running in the group. Every activity you start must have a unique string ID associated with it -- this is used to keep track of the activity, so that if you later call startActivity() again on it the same activity object will be retained.

When there had previously been an activity started under this id, it may either be destroyed and a new one started, or the current one re-used, based on these conditions, in order:

  • If the Intent maps to a different activity component than is currently running, the current activity is finished and a new one started.
  • If the current activity uses a non-multiple launch mode (such as singleTop), or the Intent has the FLAG_ACTIVITY_SINGLE_TOP flag set, then the current activity will remain running and its Activity.onNewIntent() method called.
  • If the new Intent is the same (excluding extras) as the previous one, and the new Intent does not have the FLAG_ACTIVITY_CLEAR_TOP set, then the current activity will remain running as-is.
  • Otherwise, the current activity will be finished and a new one started.

If the given Intent can not be resolved to an available Activity, this method throws ActivityNotFoundException .

Warning: There is an issue where, if the Intent does not include an explicit component, we can restore the state for a different activity class than was previously running when the state was saved (if the set of available activities changes between those points).

Parameters
id Unique identifier of the activity to be started
intent The Intent describing the activity to be started
Returns
  • Returns the window of the activity. The caller needs to take care of adding this window to a view hierarchy, and likewise dealing with removing the old window if the activity has changed.
Throws
ActivityNotFoundException