# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Nested Classes | XML Attrs | Inherited Constants | Ctors | Methods | Inherited Methods

# Fragment

`public class Fragment`
`extends Object` `implements ComponentCallbacks2, View.OnCreateContextMenuListener`

java.lang.Object
↳ | android.app.Fragment

Known direct subclasses DialogFragment, ListFragment, PreferenceFragment, WebViewFragment
DialogFragment | This class is deprecated. Use the Support Library `DialogFragment` for consistent behavior across all devices and access to Lifecycle.
ListFragment | This class is deprecated. Use the Support Library `ListFragment` for consistent behavior across all devices and access to Lifecycle.
PreferenceFragment | This class is deprecated. Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.
WebViewFragment | This class is deprecated. Manually call `WebView#onPause()` and `WebView#onResume()`

This class is deprecated.
Use the Jetpack Fragment Library `Fragment` for consistent behavior across all devices and access to Lifecycle.

A Fragment is a piece of an application's user interface or behavior that can be placed in an `Activity`. Interaction with fragments is done through `FragmentManager`, which can be obtained via `Activity.getFragmentManager()` and `Fragment.getFragmentManager()`.

The Fragment class can be used many ways to achieve a wide variety of results. In its core, it represents a particular operation or interface that is running within a larger `Activity`. A Fragment is closely tied to the Activity it is in, and can not be used apart from one. Though Fragment defines its own lifecycle, that lifecycle is dependent on its activity: if the activity is stopped, no fragments inside of it can be started; when the activity is destroyed, all fragments will be destroyed.

All subclasses of Fragment must include a public no-argument constructor. The framework will often re-instantiate a fragment class when needed, in particular during state restore, and needs to be able to find this constructor to instantiate it. If the no-argument constructor is not available, a runtime exception will occur in some cases during state restore.

Topics covered here:

1. Older Platforms
2. Lifecycle
3. Layout
4. Back Stack

### Developer Guides

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

### Older Platforms

While the Fragment API was introduced in `Build.VERSION_CODES.HONEYCOMB`, a version of the API at is also available for use on older platforms through `FragmentActivity`. See the blog post Fragments For All for more details.

### Lifecycle

Though a Fragment's lifecycle is tied to its owning activity, it has its own wrinkle on the standard activity lifecycle. It includes basic activity lifecycle methods such as `onResume()`, but also important are methods related to interactions with the activity and UI generation.

The core series of lifecycle methods that are called to bring a fragment up to resumed state (interacting with the user) are:

1. `onAttach(Activity)` called once the fragment is associated with its activity.
2. `onCreate(Bundle)` called to do initial creation of the fragment.
3. `onCreateView(LayoutInflater, ViewGroup, Bundle)` creates and returns the view hierarchy associated with the fragment.
4. `onActivityCreated(Bundle)` tells the fragment that its activity has completed its own `Activity.onCreate()`.
5. `onViewStateRestored(Bundle)` tells the fragment that all of the saved state of its view hierarchy has been restored.
6. `onStart()` makes the fragment visible to the user (based on its containing activity being started).
7. `onResume()` makes the fragment begin interacting with the user (based on its containing activity being resumed).

As a fragment is no longer being used, it goes through a reverse series of callbacks:

1. `onPause()` fragment is no longer interacting with the user either because its activity is being paused or a fragment operation is modifying it in the activity.
2. `onStop()` fragment is no longer visible to the user either because its activity is being stopped or a fragment operation is modifying it in the activity.
3. `onDestroyView()` allows the fragment to clean up resources associated with its View.
4. `onDestroy()` called to do final cleanup of the fragment's state.
5. `onDetach()` called immediately prior to the fragment no longer being associated with its activity.

### Layout

Fragments can be used as part of your application's layout, allowing you to better modularize your code and more easily adjust your user interface to the screen it is running on. As an example, we can look at a simple program consisting of a list of items, and display of the details of each item.

An activity's layout XML can include `<fragment>` tags to embed fragment instances inside of the layout. For example, here is a simple layout that embeds one fragment:

    <FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent" android:layout_height="match_parent">
        <fragment class="com.example.android.apis.app.FragmentLayout$TitlesFragment"
                android:id="@+id/titles"
                android:layout_width="match_parent" android:layout_height="match_parent" />
    </FrameLayout>

The layout is installed in the activity in the normal way:

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.fragment_layout);
    }

The titles fragment, showing a list of titles, is fairly simple, relying on `ListFragment` for most of its work. Note the implementation of clicking an item: depending on the current activity's layout, it can either create and display a new fragment to show the details in-place (more about this later), or start a new activity to show the details.

    public static class TitlesFragment extends ListFragment {
        boolean mDualPane;
        int mCurCheckPosition = 0;

        @Override
        public void onActivityCreated(Bundle savedInstanceState) {
            super.onActivityCreated(savedInstanceState);

            // Populate list with our static array of titles.
            setListAdapter(new ArrayAdapter<String>(getActivity(),
                    android.R.layout.simple_list_item_activated_1, Shakespeare.TITLES));

            // Check to see if we have a frame in which to embed the details
            // fragment directly in the containing UI.
            View detailsFrame = getActivity().findViewById(R.id.details);
            mDualPane = detailsFrame != null && detailsFrame.getVisibility() == View.VISIBLE;

            if (savedInstanceState != null) {
                // Restore last state for checked position.
                mCurCheckPosition = savedInstanceState.getInt("curChoice", 0);
            }

            if (mDualPane) {
                // In dual-pane mode, the list view highlights the selected item.
                getListView().setChoiceMode(ListView.CHOICE_MODE_SINGLE);
                // Make sure our UI is in the correct state.
                showDetails(mCurCheckPosition);
            }
        }

        @Override
        public void onSaveInstanceState(Bundle outState) {
            super.onSaveInstanceState(outState);
            outState.putInt("curChoice", mCurCheckPosition);
        }

        @Override
        public void onListItemClick(ListView l, View v, int position, long id) {
            showDetails(position);
        }

        /**
         * Helper function to show the details of a selected item, either by
         * displaying a fragment in-place in the current UI, or starting a
         * whole new activity in which it is displayed.
         */
        void showDetails(int index) {
            mCurCheckPosition = index;

            if (mDualPane) {
                // We can display everything in-place with fragments, so update
                // the list to highlight the selected item and show the data.
                getListView().setItemChecked(index, true);

                // Check what fragment is currently shown, replace if needed.
                DetailsFragment details = (DetailsFragment)
                        getFragmentManager().findFragmentById(R.id.details);
                if (details == null || details.getShownIndex() != index) {
                    // Make new fragment to show this selection.
                    details = DetailsFragment.newInstance(index);

                    // Execute a transaction, replacing any existing fragment
                    // with this one inside the frame.
                    FragmentTransaction ft = getFragmentManager().beginTransaction();
                    if (index == 0) {
                        ft.replace(R.id.details, details);
                    } else {
                        ft.replace(R.id.a_item, details);
                    }
                    ft.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_FADE);
                    ft.commit();
                }

            } else {
                // Otherwise we need to launch a new activity to display
                // the dialog fragment with selected text.
                Intent intent = new Intent();
                intent.setClass(getActivity(), DetailsActivity.class);
                intent.putExtra("index", index);
                startActivity(intent);
            }
        }
    }

The details fragment showing the contents of a selected item just displays a string of text based on an index of a string array built in to the app:

    public static class DetailsFragment extends Fragment {
        /**
         * Create a new instance of DetailsFragment, initialized to
         * show the text at 'index'.
         */
        public static DetailsFragment newInstance(int index) {
            DetailsFragment f = new DetailsFragment();

            // Supply index input as an argument.
            Bundle args = new Bundle();
            args.putInt("index", index);
            f.setArguments(args);

            return f;
        }

        public int getShownIndex() {
            return getArguments().getInt("index", 0);
        }

        @Override
        public View onCreateView(LayoutInflater inflater, ViewGroup container,
                Bundle savedInstanceState) {
            if (container == null) {
                // We have different layouts, and in one of them this
                // fragment's containing frame doesn't exist.  The fragment
                // may still be created from its saved state, but there is
                // no reason to try to create its view hierarchy because it
                // won't be displayed.  Note this is not needed -- we could
                // just run the code below, where we would create and return
                // the view hierarchy; it would just never be used.
                return null;
            }

            ScrollView scroller = new ScrollView(getActivity());
            TextView text = new TextView(getActivity());
            int padding = (int)TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP,
                    4, getActivity().getResources().getDisplayMetrics());
            text.setPadding(padding, padding, padding, padding);
            scroller.addView(text);
            text.setText(Shakespeare.DIALOGUE[getShownIndex()]);
            return scroller;
        }
    }

In this case when the user clicks on a title, there is no details container in the current activity, so the titles fragment's click code will launch a new activity to display the details fragment:

    public static class DetailsActivity extends Activity {

        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            if (getResources().getConfiguration().orientation
                    == Configuration.ORIENTATION_LANDSCAPE) {
                // If the screen is now in landscape mode, we can show the
                // dialog in-line with the list so we don't need this activity.
                finish();
                return;
            }

            if (savedInstanceState == null) {
                // During initial setup, plug in the details fragment.
                DetailsFragment details = new DetailsFragment();
                details.setArguments(getIntent().getExtras());
                getFragmentManager().beginTransaction().add(android.R.id.content, details).commit();
            }
        }
    }

However the screen may be large enough to show both the list of titles and details about the currently selected title. To use such a layout on a landscape screen, this alternative layout can be placed under layout-land:

    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:orientation="horizontal"
        android:layout_width="match_parent" android:layout_height="match_parent">

        <fragment class="com.example.android.apis.app.FragmentLayout$TitlesFragment"
                android:id="@+id/titles" android:layout_weight="1"
                android:layout_width="0px" android:layout_height="match_parent" />

        <FrameLayout android:id="@+id/details" android:layout_weight="1"
                android:layout_width="0px" android:layout_height="match_parent"
                android:background="?android:attr/detailsElementBackground" />

    </LinearLayout>

Note how the prior code will adjust to this alternative UI flow: the titles fragment will now embed the details fragment inside of this activity, and the details activity will finish itself if it is running in a configuration where the details can be shown in-place.

When a configuration change causes the activity hosting these fragments to restart, its new instance may use a different layout that doesn't include the same fragments as the previous layout. In this case all of the previous fragments will still be instantiated and running in the new instance. However, any that are no longer associated with a <fragment> tag in the view hierarchy will not have their content view created and will return false from `isInLayout()`. (The code here also shows how you can determine if a fragment placed in a container is no longer running in a layout with that container and avoid creating its view hierarchy in that case.)

The attributes of the <fragment> tag are used to control the LayoutParams provided when attaching the fragment's view to the parent container. They can also be parsed by the fragment in `onInflate(Activity, AttributeSet, Bundle)` as parameters.

The fragment being instantiated must have some kind of unique identifier so that it can be re-associated with a previous instance if the parent activity needs to be destroyed and recreated. This can be provided these ways:

- If nothing is explicitly supplied, the view ID of the container will be used.
- `android:tag` can be used in <fragment> to provide a specific tag name for the fragment.
- `android:id` can be used in <fragment> to provide a specific identifier for the fragment.

### Back Stack

The transaction in which fragments are modified can be placed on an internal back-stack of the owning activity. When the user presses back in the activity, any transactions on the back stack are popped off before the activity itself is finished.

For example, consider this simple fragment that is instantiated with an integer argument and displays that in a TextView in its UI:

    public static class CountingFragment extends Fragment {
        int mNum;

        /**
         * Create a new instance of CountingFragment, providing "num"
         * as an argument.
         */
        static CountingFragment newInstance(int num) {
            CountingFragment f = new CountingFragment();

            // Supply num input as an argument.
            Bundle args = new Bundle();
            args.putInt("num", num);
            f.setArguments(args);

            return f;
        }

        /**
         * When creating, retrieve this instance's number from its arguments.
         */
        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            mNum = getArguments() != null ? getArguments().getInt("num") : 1;
        }

        /**
         * The Fragment's UI is just a simple text view showing its
         * instance number.
         */
        @Override
        public View onCreateView(LayoutInflater inflater, ViewGroup container,
                Bundle savedInstanceState) {
            View v = inflater.inflate(R.layout.hello_world, container, false);
            View tv = v.findViewById(R.id.text);
            ((TextView)tv).setText("Fragment #" + mNum);
            tv.setBackgroundDrawable(getResources().getDrawable(android.R.drawable.gallery_thumb));
            return v;
        }
    }

A function that creates a new instance of the fragment, replacing whatever current fragment instance is being shown and pushing that change on to the back stack could be written as:

    void addFragmentToStack() {
        mStackLevel++;

        // Instantiate a new fragment.
        Fragment newFragment = CountingFragment.newInstance(mStackLevel);

        // Add the fragment to the activity, pushing this transaction
        // on to the back stack.
        FragmentTransaction ft = getFragmentManager().beginTransaction();
        ft.replace(R.id.simple_fragment, newFragment);
        ft.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_OPEN);
        ft.addToBackStack(null);
        ft.commit();
    }

After each call to this function, a new entry is on the stack, and pressing back will pop it to return the user to whatever previous state the activity UI was in.

## Summary

### Nested classes
`class` | `Fragment.InstantiationException` This class is deprecated. Use `Fragment.InstantiationException`
`class` | `Fragment.SavedState` This class is deprecated. Use `Fragment.SavedState`

### XML attributes
`android:fragmentAllowEnterTransitionOverlap` | Sets whether the enter and exit transitions should overlap when transitioning forward.
`android:fragmentAllowReturnTransitionOverlap` | Sets whether the enter and exit transitions should overlap when transitioning because of popping the back stack.
`android:fragmentEnterTransition` | The Transition that will be used to move Views into the initial scene.
`android:fragmentExitTransition` | The Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`android:fragmentReenterTransition` | The Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`android:fragmentSharedElementEnterTransition` | The Transition that will be used for shared elements transferred into the content Scene.
`android:fragmentSharedElementReturnTransition` | The Transition that will be used for shared elements transferred back during a pop of the back stack.

### Inherited constants
From interface `android.content.ComponentCallbacks2`
`int` | `TRIM_MEMORY_BACKGROUND` Level for `onTrimMemory(int)`: the process has gone on to the LRU list.
`int` | `TRIM_MEMORY_COMPLETE` Level for `onTrimMemory(int)`: the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed.
`int` | `TRIM_MEMORY_MODERATE` Level for `onTrimMemory(int)`: the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance.
`int` | `TRIM_MEMORY_RUNNING_CRITICAL` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running.
`int` | `TRIM_MEMORY_RUNNING_LOW` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running low on memory.
`int` | `TRIM_MEMORY_RUNNING_MODERATE` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running moderately low on memory.
`int` | `TRIM_MEMORY_UI_HIDDEN` Level for `onTrimMemory(int)`: the process had been showing a user interface, and is no longer doing so.

### Public constructors
`Fragment()` Default constructor.

### Public methods
`void` | `dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean` | `equals(Object o)` Subclasses can not override equals().
`final Activity` | `getActivity()` Return the Activity this fragment is currently associated with.
`boolean` | `getAllowEnterTransitionOverlap()` Returns whether the exit transition and enter transition overlap or not.
`boolean` | `getAllowReturnTransitionOverlap()` Returns whether the return transition and reenter transition overlap or not.
`final Bundle` | `getArguments()` Return the arguments supplied to `setArguments(Bundle)`, if any.
`final FragmentManager` | `getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context` | `getContext()` Return the `Context` this fragment is currently associated with.
`Transition` | `getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Transition` | `getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`final FragmentManager` | `getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object` | `getHost()` Return the host object of this fragment.
`final int` | `getId()` Return the identifier this fragment is known by.
`final LayoutInflater` | `getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`LoaderManager` | `getLoaderManager()` This method is deprecated. Use `Fragment.getLoaderManager()`
`final Fragment` | `getParentFragment()` Returns the parent Fragment containing this Fragment.
`Transition` | `getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`final Resources` | `getResources()` Return `getActivity().getResources()`.
`final boolean` | `getRetainInstance()`
`Transition` | `getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`Transition` | `getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Transition` | `getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final String` | `getString(int resId, Object... formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `String.format(String, Object...)`.
`final String` | `getString(int resId)` Return a localized string from the application's package's default string table.
`final String` | `getTag()` Get the tag name of the fragment, if specified.
`final Fragment` | `getTargetFragment()` Return the target fragment set by `setTargetFragment(Fragment, int)`.
`final int` | `getTargetRequestCode()` Return the target request code set by `setTargetFragment(Fragment, int)`.
`final CharSequence` | `getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean` | `getUserVisibleHint()`
`View` | `getView()` Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.
`final int` | `hashCode()` Subclasses can not override hashCode().
`static Fragment` | `instantiate(Context context, String fname)` Like `instantiate(android.content.Context, java.lang.String, android.os.Bundle)` but with a null argument Bundle.
`static Fragment` | `instantiate(Context context, String fname, Bundle args)` Create a new instance of a Fragment with the given class name.
`final boolean` | `isAdded()` Return true if the fragment is currently added to its activity.
`final boolean` | `isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean` | `isHidden()` Return true if the fragment has been hidden.
`final boolean` | `isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
`final boolean` | `isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean` | `isResumed()` Return true if the fragment is in the resumed state.
`final boolean` | `isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`final boolean` | `isVisible()` Return true if the fragment is currently visible to the user.
`void` | `onActivityCreated(Bundle savedInstanceState)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void` | `onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(android.content.Intent, int)`.
`void` | `onAttach(Activity activity)` This method is deprecated. Use `onAttach(android.content.Context)` instead.
`void` | `onAttach(Context context)` Called when a fragment is first attached to its context.
`void` | `onAttachFragment(Fragment childFragment)` Called when a fragment is attached as a child of this fragment.
`void` | `onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running. If you override this method you must call through to the superclass implementation.
`boolean` | `onContextItemSelected(MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void` | `onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`Animator` | `onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`void` | `onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when a context menu for the `view` is about to be shown.
`void` | `onCreateOptionsMenu(Menu menu, MenuInflater inflater)` Initialize the contents of the Activity's standard options menu.
`View` | `onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void` | `onDestroy()` Called when the fragment is no longer in use.
`void` | `onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
`void` | `onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void` | `onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater` | `onGetLayoutInflater(Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void` | `onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
`void` | `onInflate(AttributeSet attrs, Bundle savedInstanceState)` This method is deprecated. Use `onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)` instead.
`void` | `onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState)` This method is deprecated. Use `onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)` instead.
`void` | `onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void` | `onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. If you override this method you must call through to the superclass implementation.
`void` | `onMultiWindowModeChanged(boolean isInMultiWindowMode)` This method is deprecated. Use `onMultiWindowModeChanged(boolean, android.content.res.Configuration)` instead.
`void` | `onMultiWindowModeChanged(boolean isInMultiWindowMode, Configuration newConfig)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean` | `onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void` | `onOptionsMenuClosed(Menu menu)` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
`void` | `onPause()` Called when the Fragment is no longer resumed.
`void` | `onPictureInPictureModeChanged(boolean isInPictureInPictureMode, Configuration newConfig)` Called by the system when the activity changes to and from picture-in-picture mode.
`void` | `onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` This method is deprecated. Use `onPictureInPictureModeChanged(boolean, android.content.res.Configuration)` instead.
`void` | `onPrepareOptionsMenu(Menu menu)` Prepare the Screen's standard options menu to be displayed.
`void` | `onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Callback for the result from requesting permissions.
`void` | `onResume()` Called when the fragment is visible to the user and actively running.
`void` | `onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`void` | `onStart()` Called when the Fragment is visible to the user.
`void` | `onStop()` Called when the Fragment is no longer started.
`void` | `onTrimMemory(int level)` Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process. If you override this method you must call through to the superclass implementation.
`void` | `onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)` has returned, but before any saved state has been restored in to the view.
`void` | `onViewStateRestored(Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void` | `postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `FragmentManager#executePendingTransactions()` has been called.
`void` | `registerForContextMenu(View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void` | `requestPermissions(String[] permissions, int requestCode)` Requests permissions to be granted to this application.
`void` | `setAllowEnterTransitionOverlap(boolean allow)` Sets whether the exit transition and enter transition overlap or not.
`void` | `setAllowReturnTransitionOverlap(boolean allow)` Sets whether the return transition and reenter transition overlap or not.
`void` | `setArguments(Bundle args)` Supply the construction arguments for this fragment.
`void` | `setEnterSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`void` | `setEnterTransition(Transition transition)` Sets the Transition that will be used to move Views into the initial scene.
`void` | `setExitSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`void` | `setExitTransition(Transition transition)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`void` | `setHasOptionsMenu(boolean hasMenu)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
`void` | `setInitialSavedState(Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void` | `setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void` | `setReenterTransition(Transition transition)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`void` | `setRetainInstance(boolean retain)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
`void` | `setReturnTransition(Transition transition)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`void` | `setSharedElementEnterTransition(Transition transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void` | `setSharedElementReturnTransition(Transition transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void` | `setTargetFragment(Fragment fragment, int requestCode)` Optional target for this fragment.
`void` | `setUserVisibleHint(boolean isVisibleToUser)` Set a hint to the system about whether this fragment's UI is currently visible to the user.
`boolean` | `shouldShowRequestPermissionRationale(String permission)` Gets whether you should show UI with rationale before requesting a permission.
`void` | `startActivity(Intent intent)` Call `Activity#startActivity(Intent)` from the fragment's containing Activity.
`void` | `startActivity(Intent intent, Bundle options)` Call `Activity#startActivity(Intent, Bundle)` from the fragment's containing Activity.
`void` | `startActivityForResult(Intent intent, int requestCode)` Call `Activity#startActivityForResult(Intent, int)` from the fragment's containing Activity.
`void` | `startActivityForResult(Intent intent, int requestCode, Bundle options)` Call `Activity#startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`void` | `startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Call `Activity#startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.
`void` | `startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called.
`String` | `toString()` Returns a string representation of the object.
`void` | `unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
From interface `android.content.ComponentCallbacks2`
`abstract void` | `onTrimMemory(int level)` Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
From interface `android.view.View.OnCreateContextMenuListener`
`abstract void` | `onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when the context menu for this view is being built.
From interface `android.content.ComponentCallbacks`
`abstract void` | `onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running.
`abstract void` | `onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.

## XML attributes

### android:fragmentAllowEnterTransitionOverlap

Sets whether the enter and exit transitions should overlap when transitioning forward. Corresponds to `Fragment.setAllowEnterTransitionOverlap(boolean)`

May be a reference to another resource, in the form "`@[+][package:]type/name`" or a theme attribute in the form "`?[package:]type/name`".

Related methods:

- `setAllowEnterTransitionOverlap(boolean)`

### android:fragmentAllowReturnTransitionOverlap

Sets whether the enter and exit transitions should overlap when transitioning because of popping the back stack. Corresponds to `Fragment.setAllowReturnTransitionOverlap(boolean)`

May be a reference to another resource, in the form "`@[+][package:]type/name`" or a theme attribute in the form "`?[package:]type/name`".

Related methods:

- `setAllowReturnTransitionOverlap(boolean)`

### android:fragmentEnterTransition

The Transition that will be used to move Views into the initial scene. Corresponds to `Fragment.setEnterTransition(android.transition.Transition)`

May be a reference to another resource, in the form "`@[+][package:]type/name`" or a theme attribute in the form "`?[package:]type/name`".

Related methods:

- `setEnterTransition(Transition)`

### android:fragmentExitTransition

The Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. Corresponds to `Fragment.setExitTransition(android.transition.Transition)`

May be a reference to another resource, in the form "`@[+][package:]type/name`" or a theme attribute in the form "`?[package:]type/name`".

Related methods:

- `setReturnTransition(Transition)`

### android:fragmentReenterTransition

The Transition that will be used to move Views in to the scene when returning due to popping a back stack. Corresponds to `Fragment.setReenterTransition(android.transition.Transition)`

May be a reference to another resource, in the form "`@[+][package:]type/name`" or a theme attribute in the form "`?[package:]type/name`".

Related methods:

- `setReenterTransition(Transition)`

### android:fragmentSharedElementEnterTransition

The Transition that will be used for shared elements transferred into the content Scene. Corresponds to `Fragment.setSharedElementEnterTransition(android.transition.Transition)`

May be a reference to another resource, in the form "`@[+][package:]type/name`" or a theme attribute in the form "`?[package:]type/name`".

Related methods:

- `setSharedElementEnterTransition(Transition)`

### android:fragmentSharedElementReturnTransition

The Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Corresponds to `Fragment.setSharedElementReturnTransition(android.transition.Transition)`

May be a reference to another resource, in the form "`@[+][package:]type/name`" or a theme attribute in the form "`?[package:]type/name`".

Related methods:

- `setSharedElementReturnTransition(Transition)`

## Public constructors

### Fragment

    public Fragment ()

Default constructor. Every fragment must have an empty constructor, so it can be instantiated when restoring its activity's state. It is strongly recommended that subclasses do not have other constructors with parameters, since these constructors will not be called when the fragment is re-instantiated; instead, arguments can be supplied by the caller with `setArguments(Bundle)` and later retrieved by the Fragment with `getArguments()`.

Applications should generally not implement a constructor. Prefer `onAttach(android.content.Context)` instead. It is the first place application code can run where the fragment is ready to be used - the point where the fragment is actually associated with its context. Some applications may also want to implement `onInflate(Activity, AttributeSet, Bundle)` to retrieve attributes from a layout resource, although note this happens when the fragment is attached.

## Public methods

### dump

    public void dump (String prefix,
                    FileDescriptor fd,
                    PrintWriter writer,
                    String[] args)

Print the Fragments's state into the given stream.

Parameters
`prefix` | `String`: Text to print at the front of each line.
`fd` | `FileDescriptor`: The raw file descriptor that the dump is being sent to.
`writer` | `PrintWriter`: The PrintWriter to which you should dump your state. This will be closed for you after you return.
`args` | `String`: additional arguments to the dump request.

### equals

    public final boolean equals (Object o)

Subclasses can not override equals().

Parameters
`o` | `Object`: This value may be `null`.

Returns
`boolean` | `true` if this object is the same as the obj argument; `false` otherwise.

### getActivity

    public final Activity getActivity ()

Return the Activity this fragment is currently associated with.

Returns
`Activity` |

### getAllowEnterTransitionOverlap

    public boolean getAllowEnterTransitionOverlap ()

Returns whether the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.

Related XML Attributes:

- android:fragmentAllowEnterTransitionOverlap

Returns
`boolean` | true when the enter transition should start as soon as possible or false to when it should wait until the exiting transition completes.

### getAllowReturnTransitionOverlap

    public boolean getAllowReturnTransitionOverlap ()

Returns whether the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.

Related XML Attributes:

- android:fragmentAllowReturnTransitionOverlap

Returns
`boolean` | true to start the reenter transition when possible or false to wait until the return transition completes.

### getArguments

    public final Bundle getArguments ()

Return the arguments supplied to `setArguments(Bundle)`, if any.

Returns
`Bundle` |

### getChildFragmentManager

    public final FragmentManager getChildFragmentManager ()

Return a private FragmentManager for placing and managing Fragments inside of this Fragment.

Returns
`FragmentManager` |

### getContext

    public Context getContext ()

Return the `Context` this fragment is currently associated with.

Returns
`Context` |

### getEnterTransition

    public Transition getEnterTransition ()

Returns the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as entering is governed by changing visibility from `View#INVISIBLE` to `View#VISIBLE`.

Related XML Attributes:

- android:fragmentEnterTransition

Returns
`Transition` | the Transition to use to move Views into the initial Scene.

### getExitTransition

    public Transition getExitTransition ()

Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected.

Related XML Attributes:

- android:fragmentExitTransition

Returns
`Transition` | the Transition to use to move Views out of the Scene when the Fragment is being closed not due to popping the back stack.

### getFragmentManager

    public final FragmentManager getFragmentManager ()

Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will be non-null slightly before `getActivity()`, during the time from when the fragment is placed in a `FragmentTransaction` until it is committed and attached to its activity.

If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's `getChildFragmentManager()`.

Returns
`FragmentManager` |

### getHost

    public final Object getHost ()

Return the host object of this fragment. May return `null` if the fragment isn't currently being hosted.

Returns
`Object` |

### getId

    public final int getId ()

Return the identifier this fragment is known by. This is either the android:id value supplied in a layout or the container view ID supplied when adding the fragment.

Returns
`int` |

### getLayoutInflater

    public final LayoutInflater getLayoutInflater ()

Returns the cached LayoutInflater used to inflate Views of this Fragment. If `onGetLayoutInflater(android.os.Bundle)` has not been called `onGetLayoutInflater(android.os.Bundle)` will be called with a `null` argument and that value will be cached.

The cached LayoutInflater will be replaced immediately prior to `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)` and cleared immediately after `onDetach()`.

Returns
`LayoutInflater` | The LayoutInflater used to inflate Views of this Fragment.

### getLoaderManager

    public LoaderManager getLoaderManager ()

This method is deprecated.
Use `Fragment.getLoaderManager()`

Return the LoaderManager for this fragment, creating it if needed.

Returns
`LoaderManager` |

### getParentFragment

    public final Fragment getParentFragment ()

Returns the parent Fragment containing this Fragment. If this Fragment is attached directly to an Activity, returns null.

Returns
`Fragment` |

### getReenterTransition

    public Transition getReenterTransition ()

Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected. If nothing is set, the default will be to use the same transition as `setExitTransition(android.transition.Transition)`.

Related XML Attributes:

- android:fragmentReenterTransition

Returns
`Transition` | the Transition to use to move Views into the scene when reentering from a previously-started Activity.

### getResources

    public final Resources getResources ()

Return `getActivity().getResources()`.

Returns
`Resources` |

### getRetainInstance

    public final boolean getRetainInstance ()

Returns
`boolean` |

### getReturnTransition

    public Transition getReturnTransition ()

Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as entering is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If `transition` is null, entering Views will remain unaffected.

Related XML Attributes:

- android:fragmentExitTransition

Returns
`Transition` | the Transition to use to move Views out of the Scene when the Fragment is preparing to close.

### getSharedElementEnterTransition

    public Transition getSharedElementEnterTransition ()

Returns the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as `ChangeBounds`. A null value will cause transferred shared elements to blink to the final position.

Related XML Attributes:

- android:fragmentSharedElementEnterTransition

Returns
`Transition` | The Transition to use for shared elements transferred into the content Scene.

### getSharedElementReturnTransition

    public Transition getSharedElementReturnTransition ()

Return the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as `ChangeBounds`. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as `setSharedElementEnterTransition(android.transition.Transition)`.

Related XML Attributes:

- android:fragmentSharedElementReturnTransition

Returns
`Transition` | The Transition to use for shared elements transferred out of the content Scene.

### getString

    public final String getString (int resId,
                    Object... formatArgs)

Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `String.format(String, Object...)`.

Parameters
`resId` | `int`: Resource id for the format string
`formatArgs` | `Object`: The format arguments that will be used for substitution.

Returns
`String` |

### getString

    public final String getString (int resId)

Return a localized string from the application's package's default string table.

Parameters
`resId` | `int`: Resource id for the string

Returns
`String` |

### getTag

    public final String getTag ()

Get the tag name of the fragment, if specified.

Returns
`String` |

### getTargetFragment

    public final Fragment getTargetFragment ()

Return the target fragment set by `setTargetFragment(Fragment, int)`.

Returns
`Fragment` |

### getTargetRequestCode

    public final int getTargetRequestCode ()

Return the target request code set by `setTargetFragment(Fragment, int)`.

Returns
`int` |

### getText

    public final CharSequence getText (int resId)

Return a localized, styled CharSequence from the application's package's default string table.

Parameters
`resId` | `int`: Resource id for the CharSequence text

Returns
`CharSequence` |

### getUserVisibleHint

    public boolean getUserVisibleHint ()

Returns
`boolean` | The current value of the user-visible hint on this fragment.

See also:

- `setUserVisibleHint(boolean)`

### getView

    public View getView ()

Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.

Returns
`View` | The fragment's root view, or null if it has no layout.

### hashCode

    public final int hashCode ()

Subclasses can not override hashCode().

Returns
`int` | a hash code value for this object.

### instantiate

    public static Fragment instantiate (Context context,
                    String fname)

Like `instantiate(android.content.Context, java.lang.String, android.os.Bundle)` but with a null argument Bundle.

Parameters
`context` | `Context`
`fname` | `String`

Returns
`Fragment` |

### instantiate

    public static Fragment instantiate (Context context,
                    String fname,
                    Bundle args)

Create a new instance of a Fragment with the given class name. This is the same as calling its empty constructor.

Parameters
`context` | `Context`: The calling context being used to instantiate the fragment. This is currently just used to get its ClassLoader.
`fname` | `String`: The class name of the fragment to instantiate.
`args` | `Bundle`: Bundle of arguments to supply to the fragment, which it can retrieve with `getArguments()`. May be null. This value may be `null`.

Returns
`Fragment` | Returns a new fragment instance.

Throws
`Fragment.InstantiationException` | If there is a failure in instantiating the given fragment class. This is a runtime exception; it is not normally expected to happen.

### isAdded

    public final boolean isAdded ()

Return true if the fragment is currently added to its activity.

Returns
`boolean` |

### isDetached

    public final boolean isDetached ()

Return true if the fragment has been explicitly detached from the UI. That is, `FragmentTransaction.detach(Fragment)` has been used on it.

Returns
`boolean` |

### isHidden

    public final boolean isHidden ()

Return true if the fragment has been hidden. By default fragments are shown. You can find out about changes to this state with `onHiddenChanged(boolean)`. Note that the hidden state is orthogonal to other states -- that is, to be visible to the user, a fragment must be both started and not hidden.

Returns
`boolean` |

### isInLayout

    public final boolean isInLayout ()

Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. This will always be true when fragments are created through the <fragment> tag, except in the case where an old fragment is restored from a previous state and it does not appear in the layout of the current state.

Returns
`boolean` |

### isRemoving

    public final boolean isRemoving ()

Return true if this fragment is currently being removed from its activity. This is not whether its activity is finishing, but rather whether it is in the process of being removed from its activity.

Returns
`boolean` |

### isResumed

    public final boolean isResumed ()

Return true if the fragment is in the resumed state. This is true for the duration of `onResume()` and `onPause()` as well.

Returns
`boolean` |

### isStateSaved

    public final boolean isStateSaved ()

Returns true if this fragment is added and its state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true, and some operations such as `setArguments(android.os.Bundle)` will fail.

Returns
`boolean` | true if this fragment's state has already been saved by its host

### isVisible

    public final boolean isVisible ()

Return true if the fragment is currently visible to the user. This means it: (1) has been added, (2) has its view attached to the window, and (3) is not hidden.

Returns
`boolean` |

### onActivityCreated

    public void onActivityCreated (Bundle savedInstanceState)

Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. It can be used to do final initialization once these pieces are in place, such as retrieving views or restoring state. It is also useful for fragments that use `setRetainInstance(boolean)` to retain their instance, as this callback tells the fragment when it is fully associated with the new activity instance. This is called after `onCreateView(LayoutInflater, ViewGroup, Bundle)` and before `onViewStateRestored(android.os.Bundle)`.
If you override this method you must call through to the superclass implementation.

Parameters
`savedInstanceState` | `Bundle`: If the fragment is being re-created from a previous saved state, this is the state. This value may be `null`.

### onActivityResult

    public void onActivityResult (int requestCode,
                    int resultCode,
                    Intent data)

Receive the result from a previous call to `startActivityForResult(android.content.Intent, int)`. This follows the related Activity API as described there in `Activity#onActivityResult(int, int, Intent)`.

Parameters
`requestCode` | `int`: The integer request code originally supplied to startActivityForResult(), allowing you to identify who this result came from.
`resultCode` | `int`: The integer result code returned by the child activity through its setResult().
`data` | `Intent`: An Intent, which can return result data to the caller (various data can be attached to Intent "extras").

### onAttach

    public void onAttach (Activity activity)

This method is deprecated.
Use `onAttach(android.content.Context)` instead.

If you override this method you must call through to the superclass implementation.

Parameters
`activity` | `Activity`

### onAttach

    public void onAttach (Context context)

Called when a fragment is first attached to its context. `onCreate(android.os.Bundle)` will be called after this.
If you override this method you must call through to the superclass implementation.

Parameters
`context` | `Context`

### onAttachFragment

    public void onAttachFragment (Fragment childFragment)

Called when a fragment is attached as a child of this fragment.

This is called after the attached fragment's `onAttach` and before the attached fragment's `onCreate` if the fragment has not yet had a previous call to `onCreate`.

Parameters
`childFragment` | `Fragment`: child fragment being attached

### onConfigurationChanged

    public void onConfigurationChanged (Configuration newConfig)

Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources.

At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration.

For more information, read Handling Runtime Changes. If you override this method you must call through to the superclass implementation.

Parameters
`newConfig` | `Configuration`: The new device configuration. This value cannot be `null`.

### onContextItemSelected

    public boolean onContextItemSelected (MenuItem item)

This hook is called whenever an item in a context menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities.

Use `MenuItem#getMenuInfo()` to get extra information set by the View that added this menu item.

Derived classes should call through to the base class for it to perform the default menu handling.

Parameters
`item` | `MenuItem`: The context menu item that was selected.

Returns
`boolean` | boolean Return false to allow normal context menu processing to proceed, true to consume it here.

### onCreate

    public void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after `onAttach(android.app.Activity)` and before `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)`, but is not called if the fragment instance is retained across Activity re-creation (see `setRetainInstance(boolean)`).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see `onActivityCreated(android.os.Bundle)`.

If your app's `targetSdkVersion` is `Build.VERSION_CODES.M` or lower, child fragments being restored from the savedInstanceState are restored after `onCreate` returns. When targeting `Build.VERSION_CODES.N` or above and running on an N or newer platform version they are restored by `Fragment.onCreate`.

If you override this method you must call through to the superclass implementation.

Parameters
`savedInstanceState` | `Bundle`: If the fragment is being re-created from a previous saved state, this is the state. This value may be `null`.

### onCreateAnimator

    public Animator onCreateAnimator (int transit,
                    boolean enter,
                    int nextAnim)

Called when a fragment loads an animation.

Parameters
`transit` | `int`
`enter` | `boolean`
`nextAnim` | `int`

Returns
`Animator` |

### onCreateContextMenu

    public void onCreateContextMenu (ContextMenu menu,
                    View v,
                    ContextMenu.ContextMenuInfo menuInfo)

Called when a context menu for the `view` is about to be shown. Unlike `onCreateOptionsMenu(Menu, MenuInflater)`, this will be called every time the context menu is about to be shown and should be populated for the view (or item inside the view for `AdapterView` subclasses, this can be found in the `menuInfo`)).

Use `onContextItemSelected(android.view.MenuItem)` to know when an item has been selected.

The default implementation calls up to `Activity.onCreateContextMenu`, though you can not call this implementation if you don't want that behavior.

It is not safe to hold onto the context menu after this method returns. Called when the context menu for this view is being built. It is not safe to hold onto the menu after this method returns.

Parameters
`menu` | `ContextMenu`: The context menu that is being built
`v` | `View`: The view for which the context menu is being built
`menuInfo` | `ContextMenu.ContextMenuInfo`: Extra information about the item for which the context menu should be shown. This information will vary depending on the class of v.

### onCreateOptionsMenu

    public void onCreateOptionsMenu (Menu menu,
                    MenuInflater inflater)

Initialize the contents of the Activity's standard options menu. You should place your menu items in to menu. For this method to be called, you must have first called `setHasOptionsMenu(boolean)`. See `Activity.onCreateOptionsMenu` for more information.

Parameters
`menu` | `Menu`: The options menu in which you place your items.
`inflater` | `MenuInflater`

See also:

- `setHasOptionsMenu(boolean)`
- `onPrepareOptionsMenu(Menu)`
- `onOptionsItemSelected(MenuItem)`

### onCreateView

    public View onCreateView (LayoutInflater inflater,
                    ViewGroup container,
                    Bundle savedInstanceState)

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null (which is the default implementation). This will be called between `onCreate(android.os.Bundle)` and `onActivityCreated(android.os.Bundle)`.

If you return a View from here, you will later be called in `onDestroyView()` when the view is being released.

Parameters
`inflater` | `LayoutInflater`: The LayoutInflater object that can be used to inflate any views in the fragment,
`container` | `ViewGroup`: If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view. This value may be `null`.
`savedInstanceState` | `Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`View` | Return the View for the fragment's UI, or null.

### onDestroy

    public void onDestroy ()

Called when the fragment is no longer in use. This is called after `onStop()` and before `onDetach()`.
If you override this method you must call through to the superclass implementation.

### onDestroyOptionsMenu

    public void onDestroyOptionsMenu ()

Called when this fragment's option menu items are no longer being included in the overall options menu. Receiving this call means that the menu needed to be rebuilt, but this fragment's items were not included in the newly built menu (its `onCreateOptionsMenu(android.view.Menu, android.view.MenuInflater)` was not called).

### onDestroyView

    public void onDestroyView ()

Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after `onStop()` and before `onDestroy()`. It is called regardless of whether `onCreateView(LayoutInflater, ViewGroup, Bundle)` returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.
If you override this method you must call through to the superclass implementation.

### onDetach

    public void onDetach ()

Called when the fragment is no longer attached to its activity. This is called after `onDestroy()`, except in the cases where the fragment instance is retained across Activity re-creation (see `setRetainInstance(boolean)`), in which case it is called after `onStop()`.
If you override this method you must call through to the superclass implementation.

### onGetLayoutInflater

    public LayoutInflater onGetLayoutInflater (Bundle savedInstanceState)

Returns the LayoutInflater used to inflate Views of this Fragment. The default implementation will throw an exception if the Fragment is not attached.

Parameters
`savedInstanceState` | `Bundle`

Returns
`LayoutInflater` | The LayoutInflater used to inflate Views of this Fragment.

### onHiddenChanged

    public void onHiddenChanged (boolean hidden)

Called when the hidden state (as returned by `isHidden()` of the fragment has changed. Fragments start out not hidden; this will be called whenever the fragment changes state from that.

Parameters
`hidden` | `boolean`: True if the fragment is now hidden, false otherwise.

### onInflate

    public void onInflate (AttributeSet attrs,
                    Bundle savedInstanceState)

This method is deprecated.
Use `onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)` instead.

If you override this method you must call through to the superclass implementation.

Parameters
`attrs` | `AttributeSet`
`savedInstanceState` | `Bundle`

### onInflate

    public void onInflate (Activity activity,
                    AttributeSet attrs,
                    Bundle savedInstanceState)

This method is deprecated.
Use `onInflate(android.content.Context, android.util.AttributeSet, android.os.Bundle)` instead.

If you override this method you must call through to the superclass implementation.

Parameters
`activity` | `Activity`
`attrs` | `AttributeSet`
`savedInstanceState` | `Bundle`

### onInflate

    public void onInflate (Context context,
                    AttributeSet attrs,
                    Bundle savedInstanceState)

Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity. This may be called immediately after the fragment is created from a tag in a layout file. Note this is before the fragment's `onAttach(android.app.Activity)` has been called; all you should do here is parse the attributes and save them away.

This is called every time the fragment is inflated, even if it is being inflated into a new instance with saved state. It typically makes sense to re-parse the parameters each time, to allow them to change with different configurations.

Here is a typical implementation of a fragment that can take parameters both through attributes supplied here as well from `getArguments()`:

    public static class MyFragment extends Fragment {
        CharSequence mLabel;

        /**
         * Create a new instance of MyFragment that will be initialized
         * with the given arguments.
         */
        static MyFragment newInstance(CharSequence label) {
            MyFragment f = new MyFragment();
            Bundle b = new Bundle();
            b.putCharSequence("label", label);
            f.setArguments(b);
            return f;
        }

        /**
         * Parse attributes during inflation from a view hierarchy into the
         * arguments we handle.
         */
        @Override public void onInflate(Activity activity, AttributeSet attrs,
                Bundle savedInstanceState) {
            super.onInflate(activity, attrs, savedInstanceState);

            TypedArray a = activity.obtainStyledAttributes(attrs,
                    R.styleable.FragmentArguments);
            mLabel = a.getText(R.styleable.FragmentArguments_android_label);
            a.recycle();
        }

        /**
         * During creation, if arguments have been supplied to the fragment
         * then parse those out.
         */
        @Override public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            Bundle args = getArguments();
            if (args != null) {
                mLabel = args.getCharSequence("label", mLabel);
            }
        }

        /**
         * Create the view for this fragment, using the arguments given to it.
         */
        @Override public View onCreateView(LayoutInflater inflater, ViewGroup container,
                Bundle savedInstanceState) {
            View v = inflater.inflate(R.layout.hello_world, container, false);
            View tv = v.findViewById(R.id.text);
            ((TextView)tv).setText(mLabel != null ? mLabel : "(no label)");
            tv.setBackgroundDrawable(getResources().getDrawable(android.R.drawable.gallery_thumb));
            return v;
        }
    }

Note that parsing the XML attributes uses a "styleable" resource. The declaration for the styleable used here is:

    <declare-styleable name="FragmentArguments">
        <attr name="android:label" />
    </declare-styleable>

The fragment can then be declared within its activity's content layout through a tag like this:

    <fragment class="com.example.android.apis.app.FragmentArguments$MyFragment"
            android:id="@+id/embedded"
            android:layout_width="0px" android:layout_height="wrap_content"
            android:layout_weight="1"
            android:label="@string/fragment_arguments_embedded" />

This fragment can also be created dynamically from arguments given at runtime in the arguments Bundle; here is an example of doing so at creation of the containing activity:

    @Override protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.fragment_arguments);

        if (savedInstanceState == null) {
            // First-time init; create fragment to embed in activity.
            FragmentTransaction ft = getFragmentManager().beginTransaction();
            Fragment newFragment = MyFragment.newInstance("From Arguments");
            ft.add(R.id.created, newFragment);
            ft.commit();
        }
    }

If you override this method you must call through to the superclass implementation.

Parameters
`context` | `Context`: The Context that is inflating this fragment.
`attrs` | `AttributeSet`: The attributes at the tag where the fragment is being created.
`savedInstanceState` | `Bundle`: If the fragment is being re-created from a previous saved state, this is the state.

### onLowMemory

    public void onLowMemory ()

This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing.

You should implement this method to release any caches or other unnecessary resources you may be holding on to. The system will perform a garbage collection for you after returning from this method.

Preferably, you should implement `ComponentCallbacks2#onTrimMemory` from `ComponentCallbacks2` to incrementally unload your resources based on various levels of memory demands. That API is available for API level 14 and higher, so you should only use this `onLowMemory()` method as a fallback for older versions, which can be treated the same as `ComponentCallbacks2#onTrimMemory` with the `ComponentCallbacks2.TRIM_MEMORY_COMPLETE` level.

If you override this method you must call through to the superclass implementation.

### onMultiWindowModeChanged

    public void onMultiWindowModeChanged (boolean isInMultiWindowMode)

This method is deprecated.
Use `onMultiWindowModeChanged(boolean, android.content.res.Configuration)` instead.

Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. This is generally tied to `Activity#onMultiWindowModeChanged` of the containing Activity.

Parameters
`isInMultiWindowMode` | `boolean`: True if the activity is in multi-window mode.

### onMultiWindowModeChanged

    public void onMultiWindowModeChanged (boolean isInMultiWindowMode,
                    Configuration newConfig)

Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. This is generally tied to `Activity#onMultiWindowModeChanged` of the containing Activity. This method provides the same configuration that will be sent in the following `onConfigurationChanged(android.content.res.Configuration)` call after the activity enters this mode.

Parameters
`isInMultiWindowMode` | `boolean`: True if the activity is in multi-window mode.
`newConfig` | `Configuration`: The new configuration of the activity with the state .

### onOptionsItemSelected

    public boolean onOptionsItemSelected (MenuItem item)

This hook is called whenever an item in your options menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities.

Derived classes should call through to the base class for it to perform the default menu handling.

Parameters
`item` | `MenuItem`: The menu item that was selected.

Returns
`boolean` | boolean Return false to allow normal menu processing to proceed, true to consume it here.

See also:

- `onCreateOptionsMenu(Menu, MenuInflater)`

### onOptionsMenuClosed

    public void onOptionsMenuClosed (Menu menu)

This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).

Parameters
`menu` | `Menu`: The options menu as last shown or first initialized by onCreateOptionsMenu().

### onPause

    public void onPause ()

Called when the Fragment is no longer resumed. This is generally tied to `Activity.onPause` of the containing Activity's lifecycle.
If you override this method you must call through to the superclass implementation.

### onPictureInPictureModeChanged

    public void onPictureInPictureModeChanged (boolean isInPictureInPictureMode,
                    Configuration newConfig)

Called by the system when the activity changes to and from picture-in-picture mode. This is generally tied to `Activity#onPictureInPictureModeChanged` of the containing Activity. This method provides the same configuration that will be sent in the following `onConfigurationChanged(android.content.res.Configuration)` call after the activity enters this mode.

Parameters
`isInPictureInPictureMode` | `boolean`: True if the activity is in picture-in-picture mode.
`newConfig` | `Configuration`: The new configuration of the activity with the state .

### onPictureInPictureModeChanged

    public void onPictureInPictureModeChanged (boolean isInPictureInPictureMode)

This method is deprecated.
Use `onPictureInPictureModeChanged(boolean, android.content.res.Configuration)` instead.

Called by the system when the activity changes to and from picture-in-picture mode. This is generally tied to `Activity#onPictureInPictureModeChanged` of the containing Activity.

Parameters
`isInPictureInPictureMode` | `boolean`: True if the activity is in picture-in-picture mode.

### onPrepareOptionsMenu

    public void onPrepareOptionsMenu (Menu menu)

Prepare the Screen's standard options menu to be displayed. This is called right before the menu is shown, every time it is shown. You can use this method to efficiently enable/disable items or otherwise dynamically modify the contents. See `Activity.onPrepareOptionsMenu` for more information.

Parameters
`menu` | `Menu`: The options menu as last shown or first initialized by onCreateOptionsMenu().

See also:

- `setHasOptionsMenu(boolean)`
- `onCreateOptionsMenu(Menu, MenuInflater)`

### onRequestPermissionsResult

    public void onRequestPermissionsResult (int requestCode,
                    String[] permissions,
                    int[] grantResults)

Callback for the result from requesting permissions. This method is invoked for every call on `requestPermissions(java.lang.String[], int)`.

Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.

Parameters
`requestCode` | `int`: The request code passed in `requestPermissions(java.lang.String[], int)`.
`permissions` | `String`: The requested permissions. Never null. This value cannot be `null`.
`grantResults` | `int`: The grant results for the corresponding permissions which is either `PackageManager.PERMISSION_GRANTED` or `PackageManager.PERMISSION_DENIED`. Never null. This value cannot be `null`.

See also:

- `requestPermissions(String[], int)`

### onResume

    public void onResume ()

Called when the fragment is visible to the user and actively running. This is generally tied to `Activity.onResume` of the containing Activity's lifecycle.
If you override this method you must call through to the superclass implementation.

### onSaveInstanceState

    public void onSaveInstanceState (Bundle outState)

Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to `onCreate(android.os.Bundle)`, `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)`, and `onActivityCreated(android.os.Bundle)`.

This corresponds to `Activity.onSaveInstanceState(Bundle)` and most of the discussion there applies here as well. Note however: this method may be called at any time before `onDestroy()`. There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

Parameters
`outState` | `Bundle`: Bundle in which to place your saved state.

### onStart

    public void onStart ()

Called when the Fragment is visible to the user. This is generally tied to `Activity.onStart` of the containing Activity's lifecycle.
If you override this method you must call through to the superclass implementation.

### onStop

    public void onStop ()

Called when the Fragment is no longer started. This is generally tied to `Activity.onStop` of the containing Activity's lifecycle.
If you override this method you must call through to the superclass implementation.

### onTrimMemory

    public void onTrimMemory (int level)

Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process. This will happen for example when it goes in the background and there is not enough memory to keep as many background processes running as desired. You should never compare to exact values of the level, since new intermediate values may be added -- you will typically want to compare if the value is greater or equal to a level you are interested in.

To retrieve the processes current trim level at any point, you can use `ActivityManager.getMyMemoryState(RunningAppProcessInfo)`. If you override this method you must call through to the superclass implementation.

Parameters
`level` | `int`: The context of the trim, giving a hint of the amount of trimming the application may like to perform. Value is `ComponentCallbacks2.TRIM_MEMORY_COMPLETE`, `ComponentCallbacks2.TRIM_MEMORY_MODERATE`, `ComponentCallbacks2.TRIM_MEMORY_BACKGROUND`, `ComponentCallbacks2.TRIM_MEMORY_UI_HIDDEN`, `ComponentCallbacks2.TRIM_MEMORY_RUNNING_CRITICAL`, `ComponentCallbacks2.TRIM_MEMORY_RUNNING_LOW`, or `ComponentCallbacks2.TRIM_MEMORY_RUNNING_MODERATE`

### onViewCreated

    public void onViewCreated (View view,
                    Bundle savedInstanceState)

Called immediately after `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)` has returned, but before any saved state has been restored in to the view. This gives subclasses a chance to initialize themselves once they know their view hierarchy has been completely created. The fragment's view hierarchy is not however attached to its parent at this point.

Parameters
`view` | `View`: The View returned by `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)`.
`savedInstanceState` | `Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here. This value may be `null`.

### onViewStateRestored

    public void onViewStateRestored (Bundle savedInstanceState)

Called when all saved state has been restored into the view hierarchy of the fragment. This can be used to do initialization based on saved state that you are letting the view hierarchy track itself, such as whether check box widgets are currently checked. This is called after `onActivityCreated(android.os.Bundle)` and before `onStart()`.
If you override this method you must call through to the superclass implementation.

Parameters
`savedInstanceState` | `Bundle`: If the fragment is being re-created from a previous saved state, this is the state.

### postponeEnterTransition

    public void postponeEnterTransition ()

Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `FragmentManager#executePendingTransactions()` has been called.

This method gives the Fragment the ability to delay Fragment animations until all data is loaded. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called `startPostponedEnterTransition()`.

This method should be called before being added to the FragmentTransaction or in `onCreate(android.os.Bundle)`, `onAttach(android.content.Context)`, or `onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)`}. `startPostponedEnterTransition()` must be called to allow the Fragment to start the transitions.

When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement.

Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if FragmentTransaction optimizations are enabled.

See also:

- `Activity.postponeEnterTransition()`
- `FragmentTransaction.setReorderingAllowed(boolean)`

### registerForContextMenu

    public void registerForContextMenu (View view)

Registers a context menu to be shown for the given view (multiple views can show the context menu). This method will set the `OnCreateContextMenuListener` on the view to this fragment, so `onCreateContextMenu(android.view.ContextMenu, android.view.View, android.view.ContextMenu.ContextMenuInfo)` will be called when it is time to show the context menu.

Parameters
`view` | `View`: The view that should show a context menu.

See also:

- `unregisterForContextMenu(View)`

### requestPermissions

    public final void requestPermissions (String[] permissions,
                    int requestCode)

Requests permissions to be granted to this application. These permissions must be requested in your manifest, they should not be granted to your app, and they should have protection level `#PROTECTION_DANGEROUS dangerous`, regardless whether they are declared by the platform or a third-party app.

Normal permissions `PermissionInfo.PROTECTION_NORMAL` are granted at install time if requested in the manifest. Signature permissions `PermissionInfo.PROTECTION_SIGNATURE` are granted at install time if requested in the manifest and the signature of your app matches the signature of the app declaring the permissions.

Call `shouldShowRequestPermissionRationale(java.lang.String)` before calling this API to check if the system recommends to show a rationale UI before asking for a permission.

If your app does not have the requested permissions the user will be presented with UI for accepting them. After the user has accepted or rejected the requested permissions you will receive a callback on `onRequestPermissionsResult(int, java.lang.String[], int[])` reporting whether the permissions were granted or not.

Note that requesting a permission does not guarantee it will be granted and your app should be able to run without having this permission.

This method may start an activity allowing the user to choose which permissions to grant and which to reject. Hence, you should be prepared that your activity may be paused and resumed. Further, granting some permissions may require a restart of you application. In such a case, the system will recreate the activity stack before delivering the result to `onRequestPermissionsResult(int, java.lang.String[], int[])`.

When checking whether you have a permission you should use `Context.checkSelfPermission(String)`.

Calling this API for permissions already granted to your app would show UI to the user to decide whether the app can still hold these permissions. This can be useful if the way your app uses data guarded by the permissions changes significantly.

You cannot request a permission if your activity sets `noHistory` to `true` because in this case the activity would not receive result callbacks including `onRequestPermissionsResult(int, java.lang.String[], int[])`.

Parameters
`permissions` | `String`: The requested permissions. Must me non-null and not empty. This value cannot be `null`.
`requestCode` | `int`: Application specific request code to match with a result reported to `onRequestPermissionsResult(int, java.lang.String[], int[])`. Should be >= 0.

See also:

- `onRequestPermissionsResult(int, String[], int[])`
- `Context.checkSelfPermission(String)`

### setAllowEnterTransitionOverlap

    public void setAllowEnterTransitionOverlap (boolean allow)

Sets whether the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.

Related XML Attributes:

- android:fragmentAllowEnterTransitionOverlap

Parameters
`allow` | `boolean`: true to start the enter transition when possible or false to wait until the exiting transition completes.

### setAllowReturnTransitionOverlap

    public void setAllowReturnTransitionOverlap (boolean allow)

Sets whether the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.

Related XML Attributes:

- android:fragmentAllowReturnTransitionOverlap

Parameters
`allow` | `boolean`: true to start the reenter transition when possible or false to wait until the return transition completes.

### setArguments

    public void setArguments (Bundle args)

Supply the construction arguments for this fragment. The arguments supplied here will be retained across fragment destroy and creation.

This method cannot be called if the fragment is added to a FragmentManager and if `isStateSaved()` would return true. Prior to `Build.VERSION_CODES#O`, this method may only be called if the fragment has not yet been added to a FragmentManager.

Parameters
`args` | `Bundle`

### setEnterSharedElementCallback

    public void setEnterSharedElementCallback (SharedElementCallback callback)

When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.

Parameters
`callback` | `SharedElementCallback`: Used to manipulate the shared element transitions on this Fragment when added not as a pop from the back stack.

### setEnterTransition

    public void setEnterTransition (Transition transition)

Sets the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as entering is governed by changing visibility from `View#INVISIBLE` to `View#VISIBLE`. If `transition` is null, entering Views will remain unaffected.

Related XML Attributes:

- android:fragmentEnterTransition

Parameters
`transition` | `Transition`: The Transition to use to move Views into the initial Scene.

### setExitSharedElementCallback

    public void setExitSharedElementCallback (SharedElementCallback callback)

When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.

Parameters
`callback` | `SharedElementCallback`: Used to manipulate the shared element transitions on this Fragment when added as a pop from the back stack.

### setExitTransition

    public void setExitTransition (Transition transition)

Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected.

Related XML Attributes:

- android:fragmentExitTransition

Parameters
`transition` | `Transition`: The Transition to use to move Views out of the Scene when the Fragment is being closed not due to popping the back stack.

### setHasOptionsMenu

    public void setHasOptionsMenu (boolean hasMenu)

Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.

Parameters
`hasMenu` | `boolean`: If true, the fragment has menu items to contribute.

### setInitialSavedState

    public void setInitialSavedState (Fragment.SavedState state)

Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.

Parameters
`state` | `Fragment.SavedState`: The state the fragment should be restored from.

### setMenuVisibility

    public void setMenuVisibility (boolean menuVisible)

Set a hint for whether this fragment's menu should be visible. This is useful if you know that a fragment has been placed in your view hierarchy so that the user can not currently seen it, so any menu items it has should also not be shown.

Parameters
`menuVisible` | `boolean`: The default is true, meaning the fragment's menu will be shown as usual. If false, the user will not see the menu.

### setReenterTransition

    public void setReenterTransition (Transition transition)

Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as exiting is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If transition is null, the views will remain unaffected. If nothing is set, the default will be to use the same transition as `setExitTransition(android.transition.Transition)`.

Related XML Attributes:

- android:fragmentReenterTransition

Parameters
`transition` | `Transition`: The Transition to use to move Views into the scene when reentering from a previously-started Activity.

### setRetainInstance

    public void setRetainInstance (boolean retain)

Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). This can only be used with fragments not in the back stack. If set, the fragment lifecycle will be slightly different when an activity is recreated:

- `onDestroy()` will not be called (but `onDetach()` still will be, because the fragment is being detached from its current activity).
- `onCreate(android.os.Bundle)` will not be called since the fragment is not being re-created.
- `onAttach(android.app.Activity)` and `onActivityCreated(android.os.Bundle)` will still be called.

Parameters
`retain` | `boolean`

### setReturnTransition

    public void setReturnTransition (Transition transition)

Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup#isTransitionGroup` return true. Typical Transitions will extend `Visibility` as entering is governed by changing visibility from `View#VISIBLE` to `View#INVISIBLE`. If `transition` is null, entering Views will remain unaffected. If nothing is set, the default will be to use the same value as set in `setEnterTransition(android.transition.Transition)`.

Related XML Attributes:

- android:fragmentExitTransition

Parameters
`transition` | `Transition`: The Transition to use to move Views out of the Scene when the Fragment is preparing to close.

### setSharedElementEnterTransition

    public void setSharedElementEnterTransition (Transition transition)

Sets the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as `ChangeBounds`. A null value will cause transferred shared elements to blink to the final position.

Related XML Attributes:

- android:fragmentSharedElementEnterTransition

Parameters
`transition` | `Transition`: The Transition to use for shared elements transferred into the content Scene.

### setSharedElementReturnTransition

    public void setSharedElementReturnTransition (Transition transition)

Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as `ChangeBounds`. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as `setSharedElementEnterTransition(android.transition.Transition)`.

Related XML Attributes:

- android:fragmentSharedElementReturnTransition

Parameters
`transition` | `Transition`: The Transition to use for shared elements transferred out of the content Scene.

### setTargetFragment

    public void setTargetFragment (Fragment fragment,
                    int requestCode)

Optional target for this fragment. This may be used, for example, if this fragment is being started by another, and when done wants to give a result back to the first. The target set here is retained across instances via `FragmentManager.putFragment()`.

Parameters
`fragment` | `Fragment`: The fragment that is the target of this one.
`requestCode` | `int`: Optional request code, for convenience if you are going to call back with `onActivityResult(int, int, android.content.Intent)`.

### setUserVisibleHint

    public void setUserVisibleHint (boolean isVisibleToUser)

Set a hint to the system about whether this fragment's UI is currently visible to the user. This hint defaults to true and is persistent across fragment instance state save and restore.

An app may set this to false to indicate that the fragment's UI is scrolled out of visibility or is otherwise not directly visible to the user. This may be used by the system to prioritize operations such as fragment lifecycle updates or loader ordering behavior.

Note: This method may be called outside of the fragment lifecycle and thus has no ordering guarantees with regard to fragment lifecycle method calls.

Note: Prior to Android N there was a platform bug that could cause `setUserVisibleHint` to bring a fragment up to the started state before its `FragmentTransaction` had been committed. As some apps relied on this behavior, it is preserved for apps that declare a `targetSdkVersion` of 23 or lower.

Parameters
`isVisibleToUser` | `boolean`: true if this fragment's UI is currently visible to the user (default), false if it is not.

### shouldShowRequestPermissionRationale

    public boolean shouldShowRequestPermissionRationale (String permission)

Gets whether you should show UI with rationale before requesting a permission.

Parameters
`permission` | `String`: A permission your app wants to request. This value cannot be `null`.

Returns
`boolean` | Whether you should show permission rationale UI.

See also:

- `Context.checkSelfPermission(String)`
- `requestPermissions(String[], int)`
- `onRequestPermissionsResult(int, String[], int[])`

### startActivity

    public void startActivity (Intent intent)

Call `Activity#startActivity(Intent)` from the fragment's containing Activity.

Parameters
`intent` | `Intent`: The intent to start.

### startActivity

    public void startActivity (Intent intent,
                    Bundle options)

Call `Activity#startActivity(Intent, Bundle)` from the fragment's containing Activity.

Parameters
`intent` | `Intent`: The intent to start.
`options` | `Bundle`: Additional options for how the Activity should be started. See `Context.startActivity(Intent, Bundle)` Context.startActivity(Intent, Bundle)} for more details.

### startActivityForResult

    public void startActivityForResult (Intent intent,
                    int requestCode)

Call `Activity#startActivityForResult(Intent, int)` from the fragment's containing Activity.

Parameters
`intent` | `Intent`
`requestCode` | `int`

### startActivityForResult

    public void startActivityForResult (Intent intent,
                    int requestCode,
                    Bundle options)

Call `Activity#startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.

Parameters
`intent` | `Intent`
`requestCode` | `int`
`options` | `Bundle`

### startIntentSenderForResult

    public void startIntentSenderForResult (IntentSender intent,
                    int requestCode,
                    Intent fillInIntent,
                    int flagsMask,
                    int flagsValues,
                    int extraFlags,
                    Bundle options)

Call `Activity#startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.

Parameters
`intent` | `IntentSender`
`requestCode` | `int`
`fillInIntent` | `Intent`: This value may be `null`.
`flagsMask` | `int`
`flagsValues` | `int`
`extraFlags` | `int`
`options` | `Bundle`

Throws
`IntentSender.SendIntentException` |

### startPostponedEnterTransition

    public void startPostponedEnterTransition ()

Begin postponed transitions after `postponeEnterTransition()` was called. If postponeEnterTransition() was called, you must call startPostponedEnterTransition() or `FragmentManager#executePendingTransactions()` to complete the FragmentTransaction. If postponement was interrupted with `FragmentManager#executePendingTransactions()`, before `startPostponedEnterTransition()`, animations may not run or may execute improperly.

See also:

- `Activity.startPostponedEnterTransition()`

### toString

    public String toString ()

Returns a string representation of the object. In general, the `toString` method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The `toString` method for class `Object` returns a string consisting of the name of the class of which the object is an instance, the at-sign character ``@`', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

>      getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String` | a string representation of the object.

### unregisterForContextMenu

    public void unregisterForContextMenu (View view)

Prevents a context menu to be shown for the given view. This method will remove the `OnCreateContextMenuListener` on the view.

Parameters
`view` | `View`: The view that should stop showing a context menu.

See also:

- `registerForContextMenu(View)`

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*