added in version 22.1.0
belongs to Maven artifact com.android.support:support-fragment:28.0.0-alpha1

Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

Fragment

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class Fragment
extends Object implements ComponentCallbacks, View.OnCreateContextMenuListener, LifecycleOwner, ViewModelStoreOwner

java.lang.Object
↳	android.support.v4.app.Fragment

Known Direct Subclasses AmbientModeSupport,BrandedSupportFragment,DialogFragment,GuidedStepSupportFragment,HeadersSupportFragment,ListFragment,MediaRouteDiscoveryFragment,OnboardingSupportFragment,PlaybackSupportFragment,PreferenceFragmentCompat,RowsSupportFragment,SearchSupportFragment AmbientModeSupport Use this as a headless Fragment to add ambient support to an Activity on Wearable devices.  BrandedSupportFragment Fragment class for managing search and branding using a view that implements TitleViewAdapter.Provider.  DialogFragment Static library support version of the framework's DialogFragment.  GuidedStepSupportFragment A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions.  HeadersSupportFragment An fragment containing a list of row headers.  ListFragment Static library support version of the framework's ListFragment.  MediaRouteDiscoveryFragment Media route discovery fragment.  OnboardingSupportFragment An OnboardingSupportFragment provides a common and simple way to build onboarding screen for applications.  PlaybackSupportFragment A fragment for displaying playback controls and related content.  PreferenceFragmentCompat Shows a hierarchy of Preference objects as lists.  RowsSupportFragment An ordered set of rows of leanback widgets.  SearchSupportFragment A fragment to handle searches.

Known Indirect Subclasses AppCompatDialogFragment,BaseSupportFragment,BrowseSupportFragment,DetailsSupportFragment,EditTextPreferenceDialogFragmentCompat,ErrorSupportFragment,ListPreferenceDialogFragmentCompat,MediaRouteChooserDialogFragment,MediaRouteControllerDialogFragment,MultiSelectListPreferenceDialogFragmentCompat,PreferenceDialogFragmentCompat,VerticalGridSupportFragment,VideoSupportFragment AppCompatDialogFragment A special version of DialogFragment which uses an AppCompatDialog in place of a platform-styled dialog.  BaseSupportFragment Base class for leanback Fragments.  BrowseSupportFragment A fragment for creating Leanback browse screens.  DetailsSupportFragment A fragment for creating Leanback details screens.  EditTextPreferenceDialogFragmentCompat   ErrorSupportFragment A fragment for displaying an error indication.  ListPreferenceDialogFragmentCompat   MediaRouteChooserDialogFragment Media route chooser dialog fragment.  MediaRouteControllerDialogFragment Media route controller dialog fragment.  MultiSelectListPreferenceDialogFragmentCompat   PreferenceDialogFragmentCompat Abstract base class which presents a dialog associated with a DialogPreference.  VerticalGridSupportFragment A fragment for creating leanback vertical grids.  VideoSupportFragment Subclass of PlaybackSupportFragment that is responsible for providing a SurfaceView and rendering video.

---

Static library support version of the framework's Fragment. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework Fragment documentation for a class overview.

The main differences when using this support version instead of the framework version are:

• Your activity must extend FragmentActivity
• You must call getSupportFragmentManager() to get the FragmentManager

Summary

Nested classes
class	Fragment.InstantiationException Thrown by instantiate(Context, String, Bundle) when there is an instantiation failure.
class	Fragment.SavedState State information that has been retrieved from a fragment instance through FragmentManager.saveFragmentInstanceState.

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 FragmentActivity	getActivity() Return the FragmentActivity this fragment is currently associated with.
boolean	getAllowEnterTransitionOverlap() Returns whether the the exit transition and enter transition overlap or not.
boolean	getAllowReturnTransitionOverlap() Returns whether the the return transition and reenter transition overlap or not.
final Bundle	getArguments() Return the arguments supplied when the fragment was instantiated, 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.
Object	getEnterTransition() Returns the Transition that will be used to move Views into the initial scene.
Object	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.
Lifecycle	getLifecycle()
LoaderManager	getLoaderManager() Return the LoaderManager for this fragment.
final Fragment	getParentFragment() Returns the parent Fragment containing this Fragment.
Object	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 requireActivity().getResources().
final boolean	getRetainInstance()
Object	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.
Object	getSharedElementEnterTransition() Returns the Transition that will be used for shared elements transferred into the content Scene.
Object	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 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.
ViewModelStore	getViewModelStore()
final int	hashCode() Subclasses can not override hashCode().
static Fragment	instantiate(Context context, String fname) Like instantiate(Context, String, 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(Intent, int).
void	onAttach(Activity activity) This method was deprecated in API level 24.1.0. See onAttach(Context).
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)
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.
Animation	onCreateAnimation(int transit, boolean enter, int nextAnim) Called when a fragment loads an animation.
Animator	onCreateAnimator(int transit, boolean enter, int nextAnim) Called when a fragment loads an animator.
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 Fragment host'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(Activity activity, AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 24.1.0. See onInflate(Context, AttributeSet, Bundle).
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()
void	onMultiWindowModeChanged(boolean isInMultiWindowMode) 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) Called by the system when the activity changes to and from picture-in-picture mode.
void	onPrepareOptionsMenu(Menu menu) Prepare the Fragment host'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	onViewCreated(View view, Bundle savedInstanceState) Called immediately after onCreateView(LayoutInflater, ViewGroup, 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 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.
final FragmentActivity	requireActivity() Return the FragmentActivity this fragment is currently associated with.
final Context	requireContext() Return the Context this fragment is currently associated with.
final FragmentManager	requireFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity.
final Object	requireHost() Return the host object of this fragment.
void	setAllowEnterTransitionOverlap(boolean allow) Sets whether the the exit transition and enter transition overlap or not.
void	setAllowReturnTransitionOverlap(boolean allow) Sets whether the 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(Object 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(Object 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(Object 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 fr