FragmentTransaction.java revision f121be737c59390d97e21a92be8e166001534c7d
1501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brownpackage android.app;
2501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown
3501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown/**
4501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown * API for performing a set of Fragment operations.
5501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown */
6501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brownpublic interface FragmentTransaction {
7501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public FragmentTransaction add(Fragment fragment);
8501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public FragmentTransaction add(Fragment fragment, int containerViewId);
9501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public FragmentTransaction replace(Fragment fragment, int containerViewId);
10501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public FragmentTransaction remove(Fragment fragment);
11501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown
12501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /**
13501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * Bit mask that is set for all enter transition.
14501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     */
15501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_ENTER_MASK = 0x1000;
16501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown
17501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /**
18501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * Bit mask that is set for all exit transitions.
19501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     */
20501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_EXIT_MASK = 0x2000;
21501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown
22501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** Not set up for a transition. */
23501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_UNSET = -1;
24501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** No animation for transition. */
25501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_NONE = 0;
26501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** Window has been added to the screen. */
27501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_ENTER = 1 | TRANSIT_ENTER_MASK;
28501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** Window has been removed from the screen. */
29501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_EXIT = 2 | TRANSIT_EXIT_MASK;
30501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** Window has been made visible. */
31501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_SHOW = 3 | TRANSIT_ENTER_MASK;
32501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** Window has been made invisible. */
33501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_HIDE = 4 | TRANSIT_EXIT_MASK;
349524e4158fbb988b6a5e4f5be68ee10b7e4dd6d8Jeff Brown    /** The "application starting" preview window is no longer needed, and will
35501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * animate away to show the real window. */
36501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_PREVIEW_DONE = 5;
37501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in a new activity is being opened on top of an existing one
38501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * in the same task. */
39501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_ACTIVITY_OPEN = 6 | TRANSIT_ENTER_MASK;
40501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** The window in the top-most activity is being closed to reveal the
41501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * previous activity in the same task. */
42501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_ACTIVITY_CLOSE = 7 | TRANSIT_EXIT_MASK;
43501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in a new task is being opened on top of an existing one
44501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * in another activity's task. */
45501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_TASK_OPEN = 8 | TRANSIT_ENTER_MASK;
46501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in the top-most activity is being closed to reveal the
47501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * previous activity in a different task. */
48501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_TASK_CLOSE = 9 | TRANSIT_EXIT_MASK;
49501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in an existing task is being displayed on top of an existing one
50501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * in another activity's task. */
51501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_TASK_TO_FRONT = 10 | TRANSIT_ENTER_MASK;
52501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in an existing task is being put below all other tasks. */
53501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_TASK_TO_BACK = 11 | TRANSIT_EXIT_MASK;
54501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in a new activity that doesn't have a wallpaper is being
55501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * opened on top of one that does, effectively closing the wallpaper. */
56501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_WALLPAPER_CLOSE = 12 | TRANSIT_EXIT_MASK;
57501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in a new activity that does have a wallpaper is being
58501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * opened on one that didn't, effectively opening the wallpaper. */
59501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_WALLPAPER_OPEN = 13 | TRANSIT_ENTER_MASK;
60501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** A window in a new activity is being opened on top of an existing one,
61501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * and both are on top of the wallpaper. */
62501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_WALLPAPER_INTRA_OPEN = 14 | TRANSIT_ENTER_MASK;
63501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    /** The window in the top-most activity is being closed to reveal the
64501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown     * previous activity, and both are on top of he wallpaper. */
65501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public final int TRANSIT_WALLPAPER_INTRA_CLOSE = 15 | TRANSIT_EXIT_MASK;
66501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown
67501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public FragmentTransaction setTransition(int transit);
68501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public FragmentTransaction setTransitionStyle(int styleRes);
69501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown
70501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public FragmentTransaction addToBackStack(String name);
71501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown    public void commit();
72501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown}
73501edd29b823ce1301d2effdd3a9e4b6e2b20b76Jeff Brown