FragmentManager

POP_BACK_STACK_INCLUSIVE

int POP_BACK_STACK_INCLUSIVE

Flag for popBackStack(String, int) and popBackStack(int, int): If set, and the name or ID of a back stack entry has been supplied, then all matching entries will be consumed until one that doesn't match is found or the bottom of the stack is reached. Otherwise, all entries up to but not including that entry will be removed.

Constant Value: 1 (0x00000001)

FragmentManager

FragmentManager ()

addOnBackStackChangedListener

void addOnBackStackChangedListener (FragmentManager.OnBackStackChangedListener listener)

Add a new listener for changes to the fragment back stack.

beginTransaction

FragmentTransaction beginTransaction ()

Start a series of edit operations on the Fragments associated with this FragmentManager.

Note: A fragment transaction can only be created/committed prior to an activity saving its state. If you try to commit a transaction after FragmentActivity.onSaveInstanceState() (and prior to a following FragmentActivity.onStart or FragmentActivity.onResume(), you will get an error. This is because the framework takes care of saving your current fragments in the state, and if changes are made after the state is saved then they will be lost.

dump

void dump (String prefix, 
                FileDescriptor fd, 
                PrintWriter writer, 
                String[] args)

Print the FragmentManager's state into the given stream.

enableDebugLogging

void enableDebugLogging (boolean enabled)

Control whether the framework's internal fragment manager debugging logs are turned on. If enabled, you will see output in logcat as the framework performs fragment operations.

executePendingTransactions

boolean executePendingTransactions ()

After a FragmentTransaction is committed with FragmentTransaction.commit(), it is scheduled to be executed asynchronously on the process's main thread. If you want to immediately executing any such pending operations, you can call this function (only from the main thread) to do so. Note that all callbacks and other related behavior will be done from within this call, so be careful about where this is called from.

If you are committing a single transaction that does not modify the fragment back stack, strongly consider using commitNow() instead. This can help avoid unwanted side effects when other code in your app has pending committed transactions that expect different timing.

This also forces the start of any postponed Transactions where postponeEnterTransition() has been called.

findFragmentById

Fragment findFragmentById (int id)

Finds a fragment that was identified by the given id either when inflated from XML or as the container ID when added in a transaction. This first searches through fragments that are currently added to the manager's activity; if no such fragment is found, then all fragments currently on the back stack associated with this ID are searched.

findFragmentByTag

Fragment findFragmentByTag (String tag)

Finds a fragment that was identified by the given tag either when inflated from XML or as supplied when added in a transaction. This first searches through fragments that are currently added to the manager's activity; if no such fragment is found, then all fragments currently on the back stack are searched.

getBackStackEntryAt

FragmentManager.BackStackEntry getBackStackEntryAt (int index)

Return the BackStackEntry at index index in the back stack; entries start index 0 being the bottom of the stack.

getBackStackEntryCount

int getBackStackEntryCount ()

Return the number of entries currently in the back stack.

getFragment

Fragment getFragment (Bundle bundle, 
                String key)

Retrieve the current Fragment instance for a reference previously placed with putFragment(Bundle, String, Fragment).

getFragments

List<Fragment> getFragments ()

Get a list of all fragments that are currently added to the FragmentManager. This may include those that are hidden as well as those that are shown. This will not include any fragments only in the back stack, or fragments that are detached or removed.

The order of the fragments in the list is the order in which they were added or attached.

getPrimaryNavigationFragment

Fragment getPrimaryNavigationFragment ()

Return the currently active primary navigation fragment for this FragmentManager. The primary navigation fragment is set by fragment transactions using setPrimaryNavigationFragment(Fragment).

The primary navigation fragment's child FragmentManager will be called first to process delegated navigation actions such as popBackStack() if no ID or transaction name is provided to pop to.

isDestroyed

boolean isDestroyed ()

Returns true if the final Activity.onDestroy() call has been made on the FragmentManager's Activity, so this instance is now dead.

isStateSaved

boolean isStateSaved ()

Returns true if the FragmentManager's state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true. For example, any popBackStack() method, such as popBackStackImmediate() or any FragmentTransaction using commit() instead of commitAllowingStateLoss() will change the state and will result in an error.

popBackStack

void popBackStack ()

Pop the top state off the back stack. Returns true if there was one to pop, else false. This function is asynchronous -- it enqueues the request to pop, but the action will not be performed until the application returns to its event loop.

popBackStack

void popBackStack (int id, 
                int flags)

Pop all back stack states up to the one with the given identifier. This function is asynchronous -- it enqueues the request to pop, but the action will not be performed until the application returns to its event loop.

popBackStack

void popBackStack (String name, 
                int flags)

Pop the last fragment transition from the manager's fragment back stack. If there is nothing to pop, false is returned. This function is asynchronous -- it enqueues the request to pop, but the action will not be performed until the application returns to its event loop.

popBackStackImmediate

boolean popBackStackImmediate ()

Like popBackStack(), but performs the operation immediately inside of the call. This is like calling executePendingTransactions() afterwards without forcing the start of postponed Transactions.

popBackStackImmediate

boolean popBackStackImmediate (int id, 
                int flags)

Like popBackStack(int, int), but performs the operation immediately inside of the call. This is like calling executePendingTransactions() afterwards without forcing the start of postponed Transactions.

popBackStackImmediate

boolean popBackStackImmediate (String name, 
                int flags)

Like popBackStack(String, int), but performs the operation immediately inside of the call. This is like calling executePendingTransactions() afterwards without forcing the start of postponed Transactions.

putFragment

void putFragment (Bundle bundle, 
                String key, 
                Fragment fragment)

Put a reference to a fragment in a Bundle. This Bundle can be persisted as saved state, and when later restoring getFragment(Bundle, String) will return the current instance of the same fragment.

registerFragmentLifecycleCallbacks

void registerFragmentLifecycleCallbacks (FragmentManager.FragmentLifecycleCallbacks cb, 
                boolean recursive)

Registers a FragmentManager.FragmentLifecycleCallbacks to listen to fragment lifecycle events happening in this FragmentManager. All registered callbacks will be automatically unregistered when this FragmentManager is destroyed.

removeOnBackStackChangedListener

void removeOnBackStackChangedListener (FragmentManager.OnBackStackChangedListener listener)

Remove a listener that was previously added with addOnBackStackChangedListener(OnBackStackChangedListener).

saveFragmentInstanceState

Fragment.SavedState saveFragmentInstanceState (Fragment f)

Save the current instance state of the given Fragment. This can be used later when creating a new instance of the Fragment and adding it to the fragment manager, to have it create itself to match the current state returned here. Note that there are limits on how this can be used:

• The Fragment must currently be attached to the FragmentManager.
• A new Fragment created using this saved state must be the same class type as the Fragment it was created from.
• The saved state can not contain dependencies on other fragments -- that is it can't use putFragment(Bundle, String, Fragment) to store a fragment reference because that reference may not be valid when this saved state is later used. Likewise the Fragment's target and result code are not included in this state.

unregisterFragmentLifecycleCallbacks

void unregisterFragmentLifecycleCallbacks (FragmentManager.FragmentLifecycleCallbacks cb)

Unregisters a previously registered FragmentManager.FragmentLifecycleCallbacks. If the callback was not previously registered this call has no effect. All registered callbacks will be automatically unregistered when this FragmentManager is destroyed.