FragmentManager
public
abstract
class
FragmentManager
extends Object
| java.lang.Object | |
| ↳ | android.app.FragmentManager |
This class was deprecated
in API level 28.
Use the Support Library
FragmentManager for consistent behavior across all devices
and access to Lifecycle.
Interface for interacting with Fragment objects inside of an
Activity
Developer Guides
For more information about using fragments, read the Fragments developer guide.
Build.VERSION_CODES.HONEYCOMB, a version of the API
at is also available for use on older platforms through
FragmentActivity. See the blog post
Fragments For All for more details.
Summary
Nested classes | |
|---|---|
interface |
FragmentManager.BackStackEntry
This interface was deprecated
in API level 28.
Use the
Support Library |
class |
FragmentManager.FragmentLifecycleCallbacks
This class was deprecated
in API level 28.
Use the
Support Library
|
interface |
FragmentManager.OnBackStackChangedListener
This interface was deprecated
in API level 28.
Use the
Support Library
|
Constants | |
|---|---|
int |
POP_BACK_STACK_INCLUSIVE
Flag for |
Public constructors | |
|---|---|
FragmentManager()
|
|
Public methods | |
|---|---|
abstract
void
|
addOnBackStackChangedListener(FragmentManager.OnBackStackChangedListener listener)
Add a new listener for changes to the fragment back stack. |
abstract
FragmentTransaction
|
beginTransaction()
Start a series of edit operations on the Fragments associated with this FragmentManager. |
abstract
void
|
dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)
Print the FragmentManager's state into the given stream. |
static
void
|
enableDebugLogging(boolean enabled)
Control whether the framework's internal fragment manager debugging logs are turned on. |
abstract
boolean
|
executePendingTransactions()
After a |
abstract
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. |
abstract
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. |
abstract
FragmentManager.BackStackEntry
|
getBackStackEntryAt(int index)
Return the BackStackEntry at index index in the back stack; where the item on the bottom of the stack has index 0. |
abstract
int
|
getBackStackEntryCount()
Return the number of entries currently in the back stack. |
abstract
Fragment
|
getFragment(Bundle bundle, String key)
Retrieve the current Fragment instance for a reference previously
placed with |
abstract
List<Fragment>
|
getFragments()
Get a list of all fragments that are currently added to the FragmentManager. |
abstract
Fragment
|
getPrimaryNavigationFragment()
Return the currently active primary navigation fragment for this FragmentManager. |
void
|
invalidateOptionsMenu()
Invalidate the attached activity's options menu as necessary. |
abstract
boolean
|
isDestroyed()
Returns true if the final |
abstract
boolean
|
isStateSaved()
Returns |
abstract
void
|
popBackStack()
Pop the top state off the back stack. |
abstract
void
|
popBackStack(int id, int flags)
Pop all back stack states up to the one with the given identifier. |
abstract
void
|
popBackStack(String name, int flags)
Pop the last fragment transition from the manager's fragment back stack. |
abstract
boolean
|
popBackStackImmediate()
Like |
abstract
boolean
|
popBackStackImmediate(int id, int flags)
Like |
abstract
boolean
|
popBackStackImmediate(String name, int flags)
Like |
abstract
void
|
putFragment(Bundle bundle, String key, Fragment fragment)
Put a reference to a fragment in a Bundle. |
abstract
void
|
registerFragmentLifecycleCallbacks(FragmentManager.FragmentLifecycleCallbacks cb, boolean recursive)
Registers a |
abstract
void
|
removeOnBackStackChangedListener(FragmentManager.OnBackStackChangedListener listener)
Remove a listener that was previously added with
|
abstract
Fragment.SavedState
|
saveFragmentInstanceState(Fragment f)
Save the current instance state of the given Fragment. |
abstract
void
|
unregisterFragmentLifecycleCallbacks(FragmentManager.FragmentLifecycleCallbacks cb)
Unregisters a previously registered |
Inherited methods | |
|---|---|
Constants
POP_BACK_STACK_INCLUSIVE
public static final int POP_BACK_STACK_INCLUSIVE
Flag for popBackStack(java.lang.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)
Public constructors
FragmentManager
public FragmentManager ()
Public methods
addOnBackStackChangedListener
public abstract void addOnBackStackChangedListener (FragmentManager.OnBackStackChangedListener listener)
Add a new listener for changes to the fragment back stack.
| Parameters | |
|---|---|
listener |
FragmentManager.OnBackStackChangedListener |
beginTransaction
public abstract 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 Activity.onSaveInstanceState()
(and prior to a following Activity.onStart
or Activity.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.
| Returns | |
|---|---|
FragmentTransaction |
|
dump
public abstract void dump (String prefix, FileDescriptor fd, PrintWriter writer, String[] args)
Print the FragmentManager's state into the given stream.
| Parameters | |
|---|---|
prefix |
String: Text to print at the front of each line. |
fd |
FileDescriptor: The raw file descriptor that the dump is being sent to. |
writer |
PrintWriter: A PrintWriter to which the dump is to be set. |
args |
String: Additional arguments to the dump request. |
enableDebugLogging
public static 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.
| Parameters | |
|---|---|
enabled |
boolean |
executePendingTransactions
public abstract 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.
This also forces the start of any postponed Transactions where
Fragment#postponeEnterTransition() has been called.
| Returns | |
|---|---|
boolean |
Returns true if there were any pending transactions to be executed. |
findFragmentById
public abstract 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.
| Parameters | |
|---|---|
id |
int |
| Returns | |
|---|---|
Fragment |
The fragment if found or null otherwise. |
findFragmentByTag
public abstract 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.
| Parameters | |
|---|---|
tag |
String |
| Returns | |
|---|---|
Fragment |
The fragment if found or null otherwise. |
getBackStackEntryAt
public abstract FragmentManager.BackStackEntry getBackStackEntryAt (int index)
Return the BackStackEntry at index index in the back stack; where the item on the bottom of the stack has index 0.
| Parameters | |
|---|---|
index |
int |
| Returns | |
|---|---|
FragmentManager.BackStackEntry |
|
getBackStackEntryCount
public abstract int getBackStackEntryCount ()
Return the number of entries currently in the back stack.
| Returns | |
|---|---|
int |
|
getFragment
public abstract Fragment getFragment (Bundle bundle, String key)
Retrieve the current Fragment instance for a reference previously
placed with putFragment(android.os.Bundle, java.lang.String, android.app.Fragment).
| Parameters | |
|---|---|
bundle |
Bundle: The bundle from which to retrieve the fragment reference. |
key |
String: The name of the entry in the bundle. |
| Returns | |
|---|---|
Fragment |
Returns the current Fragment instance that is associated with the given reference. |
getFragments
public abstract 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.
| Returns | |
|---|---|
List<Fragment> |
A list of all fragments that are added to the FragmentManager. |
getPrimaryNavigationFragment
public abstract Fragment getPrimaryNavigationFragment ()
Return the currently active primary navigation fragment for this FragmentManager.
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.
| Returns | |
|---|---|
Fragment |
the fragment designated as the primary navigation fragment |
invalidateOptionsMenu
public void invalidateOptionsMenu ()
Invalidate the attached activity's options menu as necessary. This may end up being deferred until we move to the resumed state.
isDestroyed
public abstract boolean isDestroyed ()
Returns true if the final Activity.onDestroy()
call has been made on the FragmentManager's Activity, so this instance is now dead.
| Returns | |
|---|---|
boolean |
|
isStateSaved
public abstract 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
FragmentTransaction#commit() instead of
FragmentTransaction#commitAllowingStateLoss() will change
the state and will result in an error.
| Returns | |
|---|---|
boolean |
true if this FragmentManager's state has already been saved by its host |
popBackStack
public abstract void popBackStack ()
Pop the top state off the back stack. 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
public abstract 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.
| Parameters | |
|---|---|
id |
int: Identifier of the stated to be popped. If no identifier exists,
false is returned.
The identifier is the number returned by
FragmentTransaction.commit(). The
POP_BACK_STACK_INCLUSIVE flag can be used to control whether
the named state itself is popped. |
flags |
int: Either 0 or POP_BACK_STACK_INCLUSIVE. |
popBackStack
public abstract 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.
| Parameters | |
|---|---|
name |
String: If non-null, this is the name of a previous back state
to look for; if found, all states up to that state will be popped. The
POP_BACK_STACK_INCLUSIVE flag can be used to control whether
the named state itself is popped. If null, only the top state is popped. |
flags |
int: Either 0 or POP_BACK_STACK_INCLUSIVE. |
popBackStackImmediate
public abstract 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.
| Returns | |
|---|---|
boolean |
Returns true if there was something popped, else false. |
popBackStackImmediate
public abstract 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.
| Parameters | |
|---|---|
id |
int |
flags |
int |
| Returns | |
|---|---|
boolean |
Returns true if there was something popped, else false. |
popBackStackImmediate
public abstract boolean popBackStackImmediate (String name, int flags)
Like popBackStack(java.lang.String, int), but performs the operation immediately
inside of the call. This is like calling executePendingTransactions()
afterwards without forcing the start of postponed Transactions.
| Parameters | |
|---|---|
name |
String |
flags |
int |
| Returns | |
|---|---|
boolean |
Returns true if there was something popped, else false. |
putFragment
public abstract 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(android.os.Bundle, java.lang.String) will return the current
instance of the same fragment.
| Parameters | |
|---|---|
bundle |
Bundle: The bundle in which to put the fragment reference. |
key |
String: The name of the entry in the bundle. |
fragment |
Fragment: The Fragment whose reference is to be stored. |
registerFragmentLifecycleCallbacks
public abstract void registerFragmentLifecycleCallbacks (FragmentManager.FragmentLifecycleCallbacks cb, boolean recursive)
Registers a FragmentLifecycleCallbacks to listen to fragment lifecycle events
happening in this FragmentManager. All registered callbacks will be automatically
unregistered when this FragmentManager is destroyed.
| Parameters | |
|---|---|
cb |
FragmentManager.FragmentLifecycleCallbacks: Callbacks to register |
recursive |
boolean: true to automatically register this callback for all child FragmentManagers |
removeOnBackStackChangedListener
public abstract void removeOnBackStackChangedListener (FragmentManager.OnBackStackChangedListener listener)
Remove a listener that was previously added with
addOnBackStackChangedListener(android.app.FragmentManager.OnBackStackChangedListener).
| Parameters | |
|---|---|
listener |
FragmentManager.OnBackStackChangedListener |
saveFragmentInstanceState
public abstract 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(android.os.Bundle, java.lang.String, android.app.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.
| Parameters | |
|---|---|
f |
Fragment: The Fragment whose state is to be saved. |
| Returns | |
|---|---|
Fragment.SavedState |
The generated state. This will be null if there was no interesting state created by the fragment. |
unregisterFragmentLifecycleCallbacks
public abstract void unregisterFragmentLifecycleCallbacks (FragmentManager.FragmentLifecycleCallbacks cb)
Unregisters a previously registered 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.
| Parameters | |
|---|---|
cb |
FragmentManager.FragmentLifecycleCallbacks: Callbacks to unregister |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-04 UTC.