FragmentTransaction.java revision 9ff82bf2b33513052500473d0d6d025a80dcecbf 
1package android.app;
2
3/**
4 * API for performing a set of Fragment operations.
5 */
6public interface FragmentTransaction {
7    /**
8     * Calls {@link #add(int, Fragment, String)} with a 0 containerViewId.
9     */
10    public FragmentTransaction add(Fragment fragment, String tag);
11
12    /**
13     * Calls {@link #add(int, Fragment, String)} with a null tag.
14     */
15    public FragmentTransaction add(int containerViewId, Fragment fragment);
16
17    /**
18     * Add a fragment to the activity state.  This fragment may optionally
19     * also have its view (if {@link Fragment#onCreateView Fragment.onCreateView}
20     * returns non-null) into a container view of the activity.
21     *
22     * @param containerViewId Optional identifier of the container this fragment is
23     * to be placed in.  If 0, it will not be placed in a container.
24     * @param fragment The fragment to be added.  This fragment must not already
25     * be added to the activity.
26     * @param tag Optional tag name for the fragment, to later retrieve the
27     * fragment with {@link Activity#findFragmentByTag(String)
28     * Activity.findFragmentByTag(String)}.
29     *
30     * @return Returns the same FragmentTransaction instance.
31     */
32    public FragmentTransaction add(int containerViewId, Fragment fragment, String tag);
33
34    /**
35     * Calls {@link #replace(int, Fragment, String)} with a null tag.
36     */
37    public FragmentTransaction replace(int containerViewId, Fragment fragment);
38
39    /**
40     * Replace an existing fragment that was added to a container.  This is
41     * essentially the same as calling {@link #remove(Fragment)} for all
42     * currently added fragments that were added with the same containerViewId
43     * and then {@link #add(int, Fragment, String)} with the same arguments
44     * given here.
45     *
46     * @param containerViewId Identifier of the container whose fragment(s) are
47     * to be replaced.
48     * @param fragment The new fragment to place in the container.
49     * @param tag Optional tag name for the fragment, to later retrieve the
50     * fragment with {@link Activity#findFragmentByTag(String)
51     * Activity.findFragmentByTag(String)}.
52     *
53     * @return Returns the same FragmentTransaction instance.
54     */
55    public FragmentTransaction replace(int containerViewId, Fragment fragment, String tag);
56
57    /**
58     * Remove an existing fragment.  If it was added to a container, its view
59     * is also removed from that container.
60     *
61     * @param fragment The fragment to be removed.
62     *
63     * @return Returns the same FragmentTransaction instance.
64     */
65    public FragmentTransaction remove(Fragment fragment);
66
67    /**
68     * Hides an existing fragment.  This is only relevant for fragments whose
69     * views have been added to a container, as this will cause the view to
70     * be hidden.
71     *
72     * @param fragment The fragment to be hidden.
73     *
74     * @return Returns the same FragmentTransaction instance.
75     */
76    public FragmentTransaction hide(Fragment fragment);
77
78    /**
79     * Hides a previously hidden fragment.  This is only relevant for fragments whose
80     * views have been added to a container, as this will cause the view to
81     * be shown.
82     *
83     * @param fragment The fragment to be shown.
84     *
85     * @return Returns the same FragmentTransaction instance.
86     */
87    public FragmentTransaction show(Fragment fragment);
88
89    /**
90     * @return <code>true</code> if this transaction contains no operations,
91     * <code>false</code> otherwise.
92     */
93    public boolean isEmpty();
94
95    /**
96     * Bit mask that is set for all enter transitions.
97     */
98    public final int TRANSIT_ENTER_MASK = 0x1000;
99
100    /**
101     * Bit mask that is set for all exit transitions.
102     */
103    public final int TRANSIT_EXIT_MASK = 0x2000;
104
105    /** Not set up for a transition. */
106    public final int TRANSIT_UNSET = -1;
107    /** No animation for transition. */
108    public final int TRANSIT_NONE = 0;
109    /** Fragment is being added onto the stack */
110    public final int TRANSIT_FRAGMENT_OPEN = 1 | TRANSIT_ENTER_MASK;
111    /** Fragment is being removed from the stack */
112    public final int TRANSIT_FRAGMENT_CLOSE = 2 | TRANSIT_EXIT_MASK;
113    /** Fragment is being added in a 'next' operation*/
114    public final int TRANSIT_FRAGMENT_NEXT = 3 | TRANSIT_ENTER_MASK;
115    /** Fragment is being removed in a 'previous' operation */
116    public final int TRANSIT_FRAGMENT_PREV = 4 | TRANSIT_EXIT_MASK;
117
118    /**
119     * Set specific animation resources to run for the fragments that are
120     * entering and exiting in this transaction.
121     */
122    public FragmentTransaction setCustomAnimations(int enter, int exit);
123
124    /**
125     * Select a standard transition animation for this transaction.  May be
126     * one of {@link #TRANSIT_NONE}, {@link #TRANSIT_FRAGMENT_OPEN},
127     * or {@link #TRANSIT_FRAGMENT_CLOSE}
128     */
129    public FragmentTransaction setTransition(int transit);
130
131    /**
132     * Set a custom style resource that will be used for resolving transit
133     * animations.
134     */
135    public FragmentTransaction setTransitionStyle(int styleRes);
136
137    /**
138     * Add this transaction to the back stack.  This means that the transaction
139     * will be remembered after it is committed, and will reverse its operation
140     * when later popped off the stack.
141     *
142     * @param name An optional name for this back stack state, or null.
143     */
144    public FragmentTransaction addToBackStack(String name);
145
146    /**
147     * Set the full title to show as a bread crumb when this transaction
148     * is on the back stack, as used by {@link FragmentBreadCrumbs}.
149     *
150     * @param res A string resource containing the title.
151     */
152    public FragmentTransaction setBreadCrumbTitle(int res);
153
154    /**
155     * Like {@link #setBreadCrumbTitle(int)} but taking a raw string; this
156     * method is <em>not</em> recommended, as the string can not be changed
157     * later if the locale changes.
158     */
159    public FragmentTransaction setBreadCrumbTitle(CharSequence text);
160
161    /**
162     * Set the short title to show as a bread crumb when this transaction
163     * is on the back stack, as used by {@link FragmentBreadCrumbs}.
164     *
165     * @param res A string resource containing the title.
166     */
167    public FragmentTransaction setBreadCrumbShortTitle(int res);
168
169    /**
170     * Like {@link #setBreadCrumbShortTitle(int)} but taking a raw string; this
171     * method is <em>not</em> recommended, as the string can not be changed
172     * later if the locale changes.
173     */
174    public FragmentTransaction setBreadCrumbShortTitle(CharSequence text);
175
176    /**
177     * Schedules a commit of this transaction.  Note that the commit does
178     * not happen immediately; it will be scheduled as work on the main thread
179     * to be done the next time that thread is ready.
180     *
181     * @return Returns the identifier of this transaction's back stack entry,
182     * if {@link #addToBackStack(String)} had been called.  Otherwise, returns
183     * a negative number.
184     */
185    public int commit();
186}
187