Android APIs
public abstract class

FragmentTransaction

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

Class Overview

API for performing a set of Fragment operations.

Developer Guides

For more information about using fragments, read the Fragments developer guide.

Summary

Constants
int TRANSIT_ENTER_MASK Bit mask that is set for all enter transitions.
int TRANSIT_EXIT_MASK Bit mask that is set for all exit transitions.
int TRANSIT_FRAGMENT_CLOSE Fragment is being removed from the stack
int TRANSIT_FRAGMENT_FADE Fragment should simply fade in or out; that is, no strong navigation associated with it except that it is appearing or disappearing for some reason.
int TRANSIT_FRAGMENT_OPEN Fragment is being added onto the stack
int TRANSIT_NONE No animation for transition.
int TRANSIT_UNSET Not set up for a transition.
Public Constructors
FragmentTransaction()
Public Methods
abstract FragmentTransaction add(int containerViewId, Fragment fragment)
Calls add(int, Fragment, String) with a null tag.
abstract FragmentTransaction add(Fragment fragment, String tag)
Calls add(int, Fragment, String) with a 0 containerViewId.
abstract FragmentTransaction add(int containerViewId, Fragment fragment, String tag)
Add a fragment to the activity state.
abstract FragmentTransaction addSharedElement(View sharedElement, String name)
Used with to map a View from a removed or hidden Fragment to a View from a shown or added Fragment.
abstract FragmentTransaction addToBackStack(String name)
Add this transaction to the back stack.
abstract FragmentTransaction attach(Fragment fragment)
Re-attach a fragment after it had previously been detached from the UI with detach(Fragment).
abstract int commit()
Schedules a commit of this transaction.
abstract int commitAllowingStateLoss()
Like commit() but allows the commit to be executed after an activity's state is saved.
abstract FragmentTransaction detach(Fragment fragment)
Detach the given fragment from the UI.
abstract FragmentTransaction disallowAddToBackStack()
Disallow calls to addToBackStack(String).
abstract FragmentTransaction hide(Fragment fragment)
Hides an existing fragment.
abstract boolean isAddToBackStackAllowed()
Returns true if this FragmentTransaction is allowed to be added to the back stack.
abstract boolean isEmpty()
abstract FragmentTransaction remove(Fragment fragment)
Remove an existing fragment.
abstract FragmentTransaction replace(int containerViewId, Fragment fragment, String tag)
Replace an existing fragment that was added to a container.
abstract FragmentTransaction replace(int containerViewId, Fragment fragment)
Calls replace(int, Fragment, String) with a null tag.
abstract FragmentTransaction setBreadCrumbShortTitle(int res)
Set the short title to show as a bread crumb when this transaction is on the back stack, as used by FragmentBreadCrumbs.
abstract FragmentTransaction setBreadCrumbShortTitle(CharSequence text)
Like setBreadCrumbShortTitle(int) but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.
abstract FragmentTransaction setBreadCrumbTitle(CharSequence text)
Like setBreadCrumbTitle(int) but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.
abstract FragmentTransaction setBreadCrumbTitle(int res)
Set the full title to show as a bread crumb when this transaction is on the back stack, as used by FragmentBreadCrumbs.
abstract FragmentTransaction setCustomAnimations(int enter, int exit, int popEnter, int popExit)
Set specific animation resources to run for the fragments that are entering and exiting in this transaction.
abstract FragmentTransaction setCustomAnimations(int enter, int exit)
Set specific animation resources to run for the fragments that are entering and exiting in this transaction.
abstract FragmentTransaction setTransition(int transit)
Select a standard transition animation for this transaction.
abstract FragmentTransaction setTransitionStyle(int styleRes)
Set a custom style resource that will be used for resolving transit animations.
abstract FragmentTransaction show(Fragment fragment)
Shows a previously hidden fragment.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int TRANSIT_ENTER_MASK

Added in API level 11

Bit mask that is set for all enter transitions.

Constant Value: 4096 (0x00001000)

public static final int TRANSIT_EXIT_MASK

Added in API level 11

Bit mask that is set for all exit transitions.

Constant Value: 8192 (0x00002000)

public static final int TRANSIT_FRAGMENT_CLOSE

Added in API level 11

Fragment is being removed from the stack

Constant Value: 8194 (0x00002002)

public static final int TRANSIT_FRAGMENT_FADE

Added in API level 11

Fragment should simply fade in or out; that is, no strong navigation associated with it except that it is appearing or disappearing for some reason.

Constant Value: 4099 (0x00001003)

public static final int TRANSIT_FRAGMENT_OPEN

Added in API level 11

Fragment is being added onto the stack

Constant Value: 4097 (0x00001001)

public static final int TRANSIT_NONE

Added in API level 11

No animation for transition.

Constant Value: 0 (0x00000000)

public static final int TRANSIT_UNSET

Added in API level 11

Not set up for a transition.

Constant Value: -1 (0xffffffff)

Public Constructors

public FragmentTransaction ()

Added in API level 11

Public Methods

public abstract FragmentTransaction add (int containerViewId, Fragment fragment)

Added in API level 11

Calls add(int, Fragment, String) with a null tag.

Parameters
containerViewId int
fragment Fragment
Returns
FragmentTransaction

public abstract FragmentTransaction add (Fragment fragment, String tag)

Added in API level 11

Calls add(int, Fragment, String) with a 0 containerViewId.

Parameters
fragment Fragment
tag String
Returns
FragmentTransaction

public abstract FragmentTransaction add (int containerViewId, Fragment fragment, String tag)

Added in API level 11

Add a fragment to the activity state. This fragment may optionally also have its view (if Fragment.onCreateView returns non-null) inserted into a container view of the activity.

Parameters
containerViewId int: Optional identifier of the container this fragment is to be placed in. If 0, it will not be placed in a container.
fragment Fragment: The fragment to be added. This fragment must not already be added to the activity.
tag String: Optional tag name for the fragment, to later retrieve the fragment with FragmentManager.findFragmentByTag(String).
Returns
FragmentTransaction Returns the same FragmentTransaction instance.

public abstract FragmentTransaction addSharedElement (View sharedElement, String name)

Added in API level 21

Used with to map a View from a removed or hidden Fragment to a View from a shown or added Fragment.

Parameters
sharedElement View: A View in a disappearing Fragment to match with a View in an appearing Fragment.
name String: The transitionName for a View in an appearing Fragment to match to the shared element.
Returns
FragmentTransaction

public abstract FragmentTransaction addToBackStack (String name)

Added in API level 11

Add this transaction to the back stack. This means that the transaction will be remembered after it is committed, and will reverse its operation when later popped off the stack.

Parameters
name String: An optional name for this back stack state, or null.
Returns
FragmentTransaction

public abstract FragmentTransaction attach (Fragment fragment)

Added in API level 13

Re-attach a fragment after it had previously been detached from the UI with detach(Fragment). This causes its view hierarchy to be re-created, attached to the UI, and displayed.

Parameters
fragment Fragment: The fragment to be attached.
Returns
FragmentTransaction Returns the same FragmentTransaction instance.

public abstract int commit ()

Added in API level 11

Schedules a commit of this transaction. The commit does not happen immediately; it will be scheduled as work on the main thread to be done the next time that thread is ready.

A transaction can only be committed with this method prior to its containing activity saving its state. If the commit is attempted after that point, an exception will be thrown. This is because the state after the commit can be lost if the activity needs to be restored from its state. See commitAllowingStateLoss() for situations where it may be okay to lose the commit.

Returns
int Returns the identifier of this transaction's back stack entry, if addToBackStack(String) had been called. Otherwise, returns a negative number.

public abstract int commitAllowingStateLoss ()

Added in API level 11

Like commit() but allows the commit to be executed after an activity's state is saved. This is dangerous because the commit can be lost if the activity needs to later be restored from its state, so this should only be used for cases where it is okay for the UI state to change unexpectedly on the user.

Returns
int

public abstract FragmentTransaction detach (Fragment fragment)

Added in API level 13

Detach the given fragment from the UI. This is the same state as when it is put on the back stack: the fragment is removed from the UI, however its state is still being actively managed by the fragment manager. When going into this state its view hierarchy is destroyed.

Parameters
fragment Fragment: The fragment to be detached.
Returns
FragmentTransaction Returns the same FragmentTransaction instance.

public abstract FragmentTransaction disallowAddToBackStack ()

Added in API level 11

Disallow calls to addToBackStack(String). Any future calls to addToBackStack will throw IllegalStateException. If addToBackStack has already been called, this method will throw IllegalStateException.

Returns
FragmentTransaction

public abstract FragmentTransaction hide (Fragment fragment)

Added in API level 11

Hides an existing fragment. This is only relevant for fragments whose views have been added to a container, as this will cause the view to be hidden.

Parameters
fragment Fragment: The fragment to be hidden.
Returns
FragmentTransaction Returns the same FragmentTransaction instance.

public abstract boolean isAddToBackStackAllowed ()

Added in API level 11

Returns true if this FragmentTransaction is allowed to be added to the back stack. If this method would return false, addToBackStack(String) will throw IllegalStateException.

Returns
boolean True if addToBackStack(String) is permitted on this transaction.

public abstract boolean isEmpty ()

Added in API level 11

Returns
boolean true if this transaction contains no operations, false otherwise.

public abstract FragmentTransaction remove (Fragment fragment)

Added in API level 11

Remove an existing fragment. If it was added to a container, its view is also removed from that container.

Parameters
fragment Fragment: The fragment to be removed.
Returns
FragmentTransaction Returns the same FragmentTransaction instance.

public abstract FragmentTransaction replace (int containerViewId, Fragment fragment, String tag)

Added in API level 11

Replace an existing fragment that was added to a container. This is essentially the same as calling remove(Fragment) for all currently added fragments that were added with the same containerViewId and then add(int, Fragment, String) with the same arguments given here.

Parameters
containerViewId int: Identifier of the container whose fragment(s) are to be replaced.
fragment Fragment: The new fragment to place in the container.
tag String: Optional tag name for the fragment, to later retrieve the fragment with FragmentManager.findFragmentByTag(String).
Returns
FragmentTransaction Returns the same FragmentTransaction instance.

public abstract FragmentTransaction replace (int containerViewId, Fragment fragment)

Added in API level 11

Calls replace(int, Fragment, String) with a null tag.

Parameters
containerViewId int
fragment Fragment
Returns
FragmentTransaction

public abstract FragmentTransaction setBreadCrumbShortTitle (int res)

Added in API level 11

Set the short title to show as a bread crumb when this transaction is on the back stack, as used by FragmentBreadCrumbs.

Parameters
res int: A string resource containing the title.
Returns
FragmentTransaction

public abstract FragmentTransaction setBreadCrumbShortTitle (CharSequence text)

Added in API level 11

Like setBreadCrumbShortTitle(int) but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.

Parameters
text CharSequence
Returns
FragmentTransaction

public abstract FragmentTransaction setBreadCrumbTitle (CharSequence text)

Added in API level 11

Like setBreadCrumbTitle(int) but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.

Parameters
text CharSequence
Returns
FragmentTransaction

public abstract FragmentTransaction setBreadCrumbTitle (int res)

Added in API level 11

Set the full title to show as a bread crumb when this transaction is on the back stack, as used by FragmentBreadCrumbs.

Parameters
res int: A string resource containing the title.
Returns
FragmentTransaction

public abstract FragmentTransaction setCustomAnimations (int enter, int exit, int popEnter, int popExit)

Added in API level 13

Set specific animation resources to run for the fragments that are entering and exiting in this transaction. The popEnter and popExit animations will be played for enter/exit operations specifically when popping the back stack.

Parameters
enter int
exit int
popEnter int
popExit int
Returns
FragmentTransaction

public abstract FragmentTransaction setCustomAnimations (int enter, int exit)

Added in API level 11

Set specific animation resources to run for the fragments that are entering and exiting in this transaction. These animations will not be played when popping the back stack.

Parameters
enter int
exit int
Returns
FragmentTransaction

public abstract FragmentTransaction setTransition (int transit)

Added in API level 11

Select a standard transition animation for this transaction. May be one of TRANSIT_NONE, TRANSIT_FRAGMENT_OPEN, or TRANSIT_FRAGMENT_CLOSE

Parameters
transit int
Returns
FragmentTransaction

public abstract FragmentTransaction setTransitionStyle (int styleRes)

Added in API level 11

Set a custom style resource that will be used for resolving transit animations.

Parameters
styleRes int
Returns
FragmentTransaction

public abstract FragmentTransaction show (Fragment fragment)

Added in API level 11

Shows a previously hidden fragment. This is only relevant for fragments whose views have been added to a container, as this will cause the view to be shown.

Parameters
fragment Fragment: The fragment to be shown.
Returns
FragmentTransaction Returns the same FragmentTransaction instance.