Fragment

Kotlin |Java

open class Fragment : ComponentCallbacks, OnCreateContextMenuListener, LifecycleOwner, ViewModelStoreOwner, HasDefaultViewModelProviderFactory, SavedStateRegistryOwner, ActivityResultCaller

kotlin.Any
↳	androidx.fragment.app.Fragment

Known Direct Subclasses

AbstractProgressFragment, AmbientModeSupport, BrandedSupportFragment, DialogFragment, GuidedStepSupportFragment, LeanbackPreferenceDialogFragmentCompat, LeanbackSettingsFragmentCompat, ListFragment, MediaRouteDiscoveryFragment, NavHostFragment, OnboardingSupportFragment, PlaybackSupportFragment, and 2 others.

AbstractProgressFragment	The base class for Fragments that handle dynamic feature installation.
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 `android.app.DialogFragment`.
GuidedStepSupportFragment	A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions.
LeanbackPreferenceDialogFragmentCompat	A fragment that shows `DialogPreference`, for example or `androidx.preference.MultiSelectListPreference`.
LeanbackSettingsFragmentCompat	This fragment provides a container for displaying a `LeanbackPreferenceFragmentCompat`
ListFragment	Static library support version of the framework's `android.app.ListFragment`.
MediaRouteDiscoveryFragment	Media route discovery fragment.
NavHostFragment	NavHostFragment provides an area within your layout for self-contained navigation to occur.
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	A PreferenceFragmentCompat is the entry point to using the Preference library.
SearchSupportFragment	A fragment to handle searches.

Known Indirect Subclasses

AppCompatDialogFragment, BaseLeanbackPreferenceFragmentCompat, BaseSupportFragment, BrowseSupportFragment, DefaultProgressFragment, DetailsSupportFragment, DynamicNavHostFragment, EditTextPreferenceDialogFragmentCompat, ErrorSupportFragment, LeanbackEditTextPreferenceDialogFragmentCompat, LeanbackListPreferenceDialogFragmentCompat, LeanbackPreferenceFragmentCompat, and 7 others.

AppCompatDialogFragment	A special version of `DialogFragment` which uses an `AppCompatDialog` in place of a platform-styled dialog.
BaseLeanbackPreferenceFragmentCompat	This fragment provides a preference fragment with leanback-style behavior, suitable for embedding into broader UI elements.
BaseSupportFragment	Base class for leanback Fragments.
BrowseSupportFragment	A fragment for creating Leanback browse screens.
DefaultProgressFragment	The default androidx.fragment.app.Fragment to display during installation progress.
DetailsSupportFragment	A fragment for creating Leanback details screens.
DynamicNavHostFragment	The NavHostFragment for dynamic features.
EditTextPreferenceDialogFragmentCompat
ErrorSupportFragment	A fragment for displaying an error indication.
LeanbackEditTextPreferenceDialogFragmentCompat	Implemented a dialog to input text.
LeanbackListPreferenceDialogFragmentCompat	Implemented a dialog to show `ListPreference` or `MultiSelectListPreference`.
LeanbackPreferenceFragmentCompat	This fragment provides a fully decorated leanback-style preference fragment, including a list background and header.
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 android.app.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 android.app.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 FragmentActivity#getSupportFragmentManager to get the FragmentManager

Summary

Nested classes
open	`InstantiationException` Thrown by `FragmentFactory#instantiate(ClassLoader, String)` when there is an instantiation failure.
open	`SavedState` State information that has been retrieved from a fragment instance through `FragmentManager.saveFragmentInstanceState`.

Public constructors
`<init>()` Constructor used by the default `FragmentFactory`.
`<init>(@LayoutRes contentLayoutId: Int)` Alternate constructor that can be called from your default, no argument constructor to provide a default layout that will be inflated by `onCreateView(LayoutInflater, ViewGroup, Bundle)`.

Public methods
open Unit	`dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<String!>?)` Print the Fragments's state into the given stream.
Boolean	`equals(@Nullable other: Any?)` Subclasses can not override equals().
FragmentActivity?	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
open Boolean	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
open Boolean	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
Bundle?	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
FragmentManager	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
open Context?	`getContext()` Return the `Context` this fragment is currently associated with.
open ViewModelProvider.Factory	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors.
open Any?	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
open Any?	`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.
FragmentManager?	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
Any?	`getHost()` Return the host object of this fragment.
Int	`getId()` Return the identifier this fragment is known by.
LayoutInflater	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
open Lifecycle	`getLifecycle()` Returns the Lifecycle of the provider.
open LoaderManager	`getLoaderManager()` Return the LoaderManager for this fragment.
Fragment?	`getParentFragment()` Returns the parent Fragment containing this Fragment.
FragmentManager	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
open Any?	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
Resources	`getResources()` Return `requireActivity().getResources()`.
Boolean	`getRetainInstance()` Returns `true` if this fragment instance's state will be retained across configuration changes, and `false` if it will not.
open Any?	`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.
SavedStateRegistry	`getSavedStateRegistry()`
open Any?	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
open Any?	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
String	`getString(@StringRes resId: Int)` Return a localized string from the application's package's default string table.
String	`getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any!)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `java.util.Formatter` and java.
String?	`getTag()` Get the tag name of the fragment, if specified.
Fragment?	`getTargetFragment()` Return the target fragment set by `setTargetFragment`.
Int	`getTargetRequestCode()` Return the target request code set by `setTargetFragment`.
CharSequence	`getText(@StringRes resId: Int)` Return a localized, styled CharSequence from the application's package's default string table.
open Boolean	`getUserVisibleHint()`
open View?	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
open LifecycleOwner	`getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
open LiveData<LifecycleOwner!>	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
open ViewModelStore	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment
Int	`hashCode()` Subclasses can not override hashCode().
open static Fragment	`instantiate(@NonNull context: Context, @NonNull fname: String)` Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
open static Fragment	`instantiate(@NonNull context: Context, @NonNull fname: String, @Nullable args: Bundle?)` Create a new instance of a Fragment with the given class name.
Boolean	`isAdded()` Return true if the fragment is currently added to its activity.
Boolean	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
Boolean	`isHidden()` Return true if the fragment has been hidden.
Boolean	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
Boolean	`isRemoving()` Return true if this fragment is currently being removed from its activity.
Boolean	`isResumed()` Return true if the fragment is in the resumed state.
Boolean	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
Boolean	`isVisible()` Return true if the fragment is currently visible to the user.
open Unit	`onActivityCreated(@Nullable savedInstanceState: Bundle?)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
open Unit	`onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?)` Receive the result from a previous call to `startActivityForResult(Intent, int)`.
open Unit	`onAttach(@NonNull context: Context)` Called when a fragment is first attached to its context.
open Unit	`onAttach(@NonNull activity: Activity)` Called when a fragment is first attached to its activity.
open Unit	`onAttachFragment(@NonNull childFragment: Fragment)` Called when a fragment is attached as a child of this fragment.
open Unit	`onConfigurationChanged(@NonNull newConfig: Configuration)`
open Boolean	`onContextItemSelected(@NonNull item: MenuItem)` This hook is called whenever an item in a context menu is selected.
open Unit	`onCreate(@Nullable savedInstanceState: Bundle?)` Called to do initial creation of a fragment.
open Animation?	`onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation.
open Animator?	`onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animator.
open Unit	`onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenuInfo?)` Called when a context menu for the `view` is about to be shown.
open Unit	`onCreateOptionsMenu(@NonNull menu: Menu, @NonNull inflater: MenuInflater)` Initialize the contents of the Fragment host's standard options menu.
open View?	`onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?)` Called to have the fragment instantiate its user interface view.
open Unit	`onDestroy()` Called when the fragment is no longer in use.
open Unit	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
open Unit	`onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
open Unit	`onDetach()` Called when the fragment is no longer attached to its activity.
open LayoutInflater	`onGetLayoutInflater(@Nullable savedInstanceState: Bundle?)` Returns the LayoutInflater used to inflate Views of this Fragment.
open Unit	`onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
open Unit	`onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
open Unit	`onInflate(@NonNull activity: Activity, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
open Unit	`onLowMemory()`
open Unit	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
open Boolean	`onOptionsItemSelected(@NonNull item: MenuItem)` This hook is called whenever an item in your options menu is selected.
open Unit	`onOptionsMenuClosed(@NonNull 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).
open Unit	`onPause()` Called when the Fragment is no longer resumed.
open Unit	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode.
open Unit	`onPrepareOptionsMenu(@NonNull menu: Menu)` Prepare the Fragment host's standard options menu to be displayed.
open Unit	`onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)` Callback for when the primary navigation state of this Fragment has changed.
open Unit	`onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<String!>, @NonNull grantResults: IntArray)` Callback for the result from requesting permissions.
open Unit	`onResume()` Called when the fragment is visible to the user and actively running.
open Unit	`onSaveInstanceState(@NonNull outState: Bundle)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
open Unit	`onStart()` Called when the Fragment is visible to the user.
open Unit	`onStop()` Called when the Fragment is no longer started.
open Unit	`onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
open Unit	`onViewStateRestored(@Nullable savedInstanceState: Bundle?)` Called when all saved state has been restored into the view hierarchy of the fragment.
open Unit	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `FragmentManager#executePendingTransactions()` has been called.
Unit	`postponeEnterTransition(duration: Long, @NonNull timeUnit:`