java.lang.Object | |
↳ | android.app.FragmentTransaction |
API for performing a set of Fragment operations.
For more information about using fragments, read the Fragments developer guide.
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Calls
add(int, Fragment, String) with a null tag. | |||||||||||
Calls
add(int, Fragment, String) with a 0 containerViewId. | |||||||||||
Add a fragment to the activity state.
| |||||||||||
Add this transaction to the back stack.
| |||||||||||
Re-attach a fragment after it had previously been deatched from
the UI with
detach(Fragment) . | |||||||||||
Schedules a commit of this transaction.
| |||||||||||
Like
commit() but allows the commit to be executed after an
activity's state is saved. | |||||||||||
Detach the given fragment from the UI.
| |||||||||||
Disallow calls to
addToBackStack(String) . | |||||||||||
Hides an existing fragment.
| |||||||||||
Returns true if this FragmentTransaction is allowed to be added to the back
stack.
| |||||||||||
Remove an existing fragment.
| |||||||||||
Replace an existing fragment that was added to a container.
| |||||||||||
Calls
replace(int, Fragment, String) with a null tag. | |||||||||||
Set the short title to show as a bread crumb when this transaction
is on the back stack, as used by
FragmentBreadCrumbs . | |||||||||||
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. | |||||||||||
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. | |||||||||||
Set the full title to show as a bread crumb when this transaction
is on the back stack, as used by
FragmentBreadCrumbs . | |||||||||||
Set specific animation resources to run for the fragments that are
entering and exiting in this transaction.
| |||||||||||
Set specific animation resources to run for the fragments that are
entering and exiting in this transaction.
| |||||||||||
Select a standard transition animation for this transaction.
| |||||||||||
Set a custom style resource that will be used for resolving transit
animations.
| |||||||||||
Shows a previously hidden fragment.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Bit mask that is set for all enter transitions.
Bit mask that is set for all exit transitions.
Fragment is being removed from the stack
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.
Fragment is being added onto the stack
No animation for transition.
Not set up for a transition.
Calls add(int, Fragment, String)
with a null tag.
Calls add(int, Fragment, String)
with a 0 containerViewId.
Add a fragment to the activity state. This fragment may optionally
also have its view (if Fragment.onCreateView
returns non-null) into a container view of the activity.
containerViewId | Optional identifier of the container this fragment is to be placed in. If 0, it will not be placed in a container. |
---|---|
fragment | The fragment to be added. This fragment must not already be added to the activity. |
tag | Optional tag name for the fragment, to later retrieve the
fragment with FragmentManager.findFragmentByTag(String) . |
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.
name | An optional name for this back stack state, or null. |
---|
Re-attach a fragment after it had previously been deatched from
the UI with detach(Fragment)
. This
causes its view hierarchy to be re-created, attached to the UI,
and displayed.
fragment | The fragment to be attached. |
---|
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.
addToBackStack(String)
had been called. Otherwise, returns
a negative number.
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.
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.
fragment | The fragment to be detached. |
---|
Disallow calls to addToBackStack(String)
. Any future calls to
addToBackStack will throw IllegalStateException
. If addToBackStack
has already been called, this method will throw IllegalStateException.
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.
fragment | The fragment to be hidden. |
---|
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
.
addToBackStack(String)
is permitted on this transaction.
true
if this transaction contains no operations,
false
otherwise.
Remove an existing fragment. If it was added to a container, its view is also removed from that container.
fragment | The fragment to be removed. |
---|
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.
containerViewId | Identifier of the container whose fragment(s) are to be replaced. |
---|---|
fragment | The new fragment to place in the container. |
tag | Optional tag name for the fragment, to later retrieve the
fragment with FragmentManager.findFragmentByTag(String) . |
Calls replace(int, Fragment, String)
with a null tag.
Set the short title to show as a bread crumb when this transaction
is on the back stack, as used by FragmentBreadCrumbs
.
res | A string resource containing the title. |
---|
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.
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.
Set the full title to show as a bread crumb when this transaction
is on the back stack, as used by FragmentBreadCrumbs
.
res | A string resource containing the title. |
---|
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.
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.
Select a standard transition animation for this transaction. May be
one of TRANSIT_NONE
, TRANSIT_FRAGMENT_OPEN
,
or TRANSIT_FRAGMENT_CLOSE
Set a custom style resource that will be used for resolving transit animations.
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.
fragment | The fragment to be shown. |
---|