FileDocCategorySizeDatePackage
FragmentTransaction.javaAPI DocAndroid 5.1 API11561Thu Mar 12 22:22:10 GMT 2015android.app

FragmentTransaction

public abstract class FragmentTransaction extends Object
API for performing a set of Fragment operations.

Developer Guides

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

Fields Summary
public static final int
TRANSIT_ENTER_MASK
Bit mask that is set for all enter transitions.
public static final int
TRANSIT_EXIT_MASK
Bit mask that is set for all exit transitions.
public static final int
TRANSIT_UNSET
Not set up for a transition.
public static final int
TRANSIT_NONE
No animation for transition.
public static final int
TRANSIT_FRAGMENT_OPEN
Fragment is being added onto the stack
public static final int
TRANSIT_FRAGMENT_CLOSE
Fragment is being removed from the stack
public static final 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.
Constructors Summary
Methods Summary
public abstract android.app.FragmentTransactionadd(Fragment fragment, java.lang.String tag)
Calls {@link #add(int, Fragment, String)} with a 0 containerViewId.

public abstract android.app.FragmentTransactionadd(int containerViewId, Fragment fragment)
Calls {@link #add(int, Fragment, String)} with a null tag.

public abstract android.app.FragmentTransactionadd(int containerViewId, Fragment fragment, java.lang.String tag)
Add a fragment to the activity state. This fragment may optionally also have its view (if {@link Fragment#onCreateView Fragment.onCreateView} returns non-null) into a container view of the activity.

param
containerViewId Optional identifier of the container this fragment is to be placed in. If 0, it will not be placed in a container.
param
fragment The fragment to be added. This fragment must not already be added to the activity.
param
tag Optional tag name for the fragment, to later retrieve the fragment with {@link FragmentManager#findFragmentByTag(String) FragmentManager.findFragmentByTag(String)}.
return
Returns the same FragmentTransaction instance.

public abstract android.app.FragmentTransactionaddSharedElement(android.view.View sharedElement, java.lang.String name)
Used with to map a View from a removed or hidden Fragment to a View from a shown or added Fragment.

param
sharedElement A View in a disappearing Fragment to match with a View in an appearing Fragment.
param
name The transitionName for a View in an appearing Fragment to match to the shared element.

public abstract android.app.FragmentTransactionaddToBackStack(java.lang.String name)
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.

param
name An optional name for this back stack state, or null.

public abstract android.app.FragmentTransactionattach(Fragment fragment)
Re-attach a fragment after it had previously been detached from the UI with {@link #detach(Fragment)}. This causes its view hierarchy to be re-created, attached to the UI, and displayed.

param
fragment The fragment to be attached.
return
Returns the same FragmentTransaction instance.

public abstract intcommit()
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 {@link #commitAllowingStateLoss()} for situations where it may be okay to lose the commit.

return
Returns the identifier of this transaction's back stack entry, if {@link #addToBackStack(String)} had been called. Otherwise, returns a negative number.

public abstract intcommitAllowingStateLoss()
Like {@link #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.

public abstract android.app.FragmentTransactiondetach(Fragment fragment)
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.

param
fragment The fragment to be detached.
return
Returns the same FragmentTransaction instance.

public abstract android.app.FragmentTransactiondisallowAddToBackStack()
Disallow calls to {@link #addToBackStack(String)}. Any future calls to addToBackStack will throw {@link IllegalStateException}. If addToBackStack has already been called, this method will throw IllegalStateException.

public abstract android.app.FragmentTransactionhide(Fragment fragment)
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.

param
fragment The fragment to be hidden.
return
Returns the same FragmentTransaction instance.

public abstract booleanisAddToBackStackAllowed()
Returns true if this FragmentTransaction is allowed to be added to the back stack. If this method would return false, {@link #addToBackStack(String)} will throw {@link IllegalStateException}.

return
True if {@link #addToBackStack(String)} is permitted on this transaction.

public abstract booleanisEmpty()

return
true if this transaction contains no operations, false otherwise.

public abstract android.app.FragmentTransactionremove(Fragment fragment)
Remove an existing fragment. If it was added to a container, its view is also removed from that container.

param
fragment The fragment to be removed.
return
Returns the same FragmentTransaction instance.

public abstract android.app.FragmentTransactionreplace(int containerViewId, Fragment fragment)
Calls {@link #replace(int, Fragment, String)} with a null tag.

public abstract android.app.FragmentTransactionreplace(int containerViewId, Fragment fragment, java.lang.String tag)
Replace an existing fragment that was added to a container. This is essentially the same as calling {@link #remove(Fragment)} for all currently added fragments that were added with the same containerViewId and then {@link #add(int, Fragment, String)} with the same arguments given here.

param
containerViewId Identifier of the container whose fragment(s) are to be replaced.
param
fragment The new fragment to place in the container.
param
tag Optional tag name for the fragment, to later retrieve the fragment with {@link FragmentManager#findFragmentByTag(String) FragmentManager.findFragmentByTag(String)}.
return
Returns the same FragmentTransaction instance.

public abstract android.app.FragmentTransactionsetBreadCrumbShortTitle(int res)
Set the short title to show as a bread crumb when this transaction is on the back stack, as used by {@link FragmentBreadCrumbs}.

param
res A string resource containing the title.

public abstract android.app.FragmentTransactionsetBreadCrumbShortTitle(java.lang.CharSequence text)
Like {@link #setBreadCrumbShortTitle(int)} but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.

public abstract android.app.FragmentTransactionsetBreadCrumbTitle(int res)
Set the full title to show as a bread crumb when this transaction is on the back stack, as used by {@link FragmentBreadCrumbs}.

param
res A string resource containing the title.

public abstract android.app.FragmentTransactionsetBreadCrumbTitle(java.lang.CharSequence text)
Like {@link #setBreadCrumbTitle(int)} but taking a raw string; this method is not recommended, as the string can not be changed later if the locale changes.

public abstract android.app.FragmentTransactionsetCustomAnimations(int enter, int exit)
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.

public abstract android.app.FragmentTransactionsetCustomAnimations(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. The popEnter and popExit animations will be played for enter/exit operations specifically when popping the back stack.

public android.app.FragmentTransactionsetCustomTransition(int sceneRootId, int transitionId)
TODO: remove from API

hide


                                     
          

                                           
          
               

                             
        

              
          
        return this;
    
public abstract android.app.FragmentTransactionsetSharedElement(android.view.View sharedElement, java.lang.String name)
TODO: remove from API

hide

public abstract android.app.FragmentTransactionsetSharedElements(android.util.Pair sharedElements)
TODO: remove from API

hide

public abstract android.app.FragmentTransactionsetTransition(int transit)
Select a standard transition animation for this transaction. May be one of {@link #TRANSIT_NONE}, {@link #TRANSIT_FRAGMENT_OPEN}, or {@link #TRANSIT_FRAGMENT_CLOSE}

public abstract android.app.FragmentTransactionsetTransitionStyle(int styleRes)
Set a custom style resource that will be used for resolving transit animations.

public abstract android.app.FragmentTransactionshow(Fragment fragment)
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.

param
fragment The fragment to be shown.
return
Returns the same FragmentTransaction instance.