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.
|
ViewModelProvider.Factory
|
getDefaultViewModelProviderFactory()
Returns the default ViewModelProvider.Factory that should be
used when no custom Factory is provided to the
ViewModelProvider constructors.
The Fragment's arguments when this is first called will be used
as the defaults to any SavedStateHandle passed to a view model
created using this factory.
|
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()
This method is deprecated.
This has been removed in favor of getParentFragmentManager() which
throws an IllegalStateException if the FragmentManager is null. Check if
isAdded() returns false to determine if the FragmentManager is
null .
|
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()
Returns the Lifecycle of the provider.
Overriding this method is no longer supported and this method will be made
final in a future version of Fragment.
|
LoaderManager
|
getLoaderManager()
This method is deprecated.
Use
LoaderManager.getInstance(this) .
|
final
Fragment
|
getParentFragment()
Returns the parent Fragment containing this Fragment.
|
final
FragmentManager
|
getParentFragmentManager()
Return the FragmentManager for interacting with fragments associated
with this fragment's activity.
|
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()
This method is deprecated.
Instead of retaining the Fragment itself, use a non-retained Fragment and keep
retained state in a ViewModel attached to that Fragment. The ViewModel's constructor and
its onCleared() callback provide the signal for initial creation and final destruction of
the retained state.
|
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.
|
final
SavedStateRegistry
|
getSavedStateRegistry()
Returns owned SavedStateRegistry
|
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 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()
This method is deprecated.
Instead of using a target fragment to pass results, use
FragmentManager.setFragmentResult(String, Bundle) to deliver results to
FragmentResultListener instances registered by other fragments via
FragmentManager.setFragmentResultListener(String, LifecycleOwner, FragmentResultListener) .
|
final
int
|
getTargetRequestCode()
This method is deprecated.
When using the target fragment replacement of
FragmentManager.setFragmentResultListener(String, LifecycleOwner, FragmentResultListener) and FragmentManager.setFragmentResult(String, Bundle) ,
consider using setArguments(Bundle) to pass a requestKey if you need to support
dynamic request keys.
|
final
CharSequence
|
getText(int resId)
Return a localized, styled CharSequence from the application's package's
default string table.
|
boolean
|
getUserVisibleHint()
This method is deprecated.
Use FragmentTransaction.setMaxLifecycle(Fragment, Lifecycle.State)
instead.
|
View
|
getView()
Get the root view for the fragment's layout (the one returned by onCreateView(LayoutInflater, ViewGroup, Bundle) ),
if provided.
|
LifecycleOwner
|
getViewLifecycleOwner()
Get a LifecycleOwner that represents the Fragment's View
lifecycle.
|
LiveData<LifecycleOwner>
|
getViewLifecycleOwnerLiveData()
Retrieve a LiveData which allows you to observe the
lifecycle of the Fragment's View .
|
ViewModelStore
|
getViewModelStore()
Returns the ViewModelStore associated with this Fragment
Overriding this method is no longer supported and this method will be made
final in a future version of Fragment.
|
final
int
|
hashCode()
Subclasses can not override hashCode().
|
static
Fragment
|
instantiate(Context context, String fname)
This method is deprecated.
Use FragmentManager.getFragmentFactory() and
FragmentFactory.instantiate(ClassLoader, String)
|
static
Fragment
|
instantiate(Context context, String fname, Bundle args)
This method is deprecated.
Use FragmentManager.getFragmentFactory() and
FragmentFactory.instantiate(ClassLoader, String) , manually calling
setArguments(Bundle) on the returned Fragment.
|
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)
This method is deprecated.
use onViewCreated(View, Bundle) for code touching
the Fragment's view and onCreate(Bundle) for other initialization.
To get a callback specifically when a Fragment activity's
Activity.onCreate(Bundle) is called, register a
LifecycleObserver on the Activity's
Lifecycle in onAttach(Context) , removing it when it receives the
Lifecycle.State.CREATED callback.
|
void
|
onActivityResult(int requestCode, int resultCode, Intent data)
This method is deprecated.
use
registerForActivityResult(ActivityResultContract, ActivityResultCallback)
with the appropriate ActivityResultContract and handling the result in the
callback .
|
void
|
onAttach(Activity activity)
This method is deprecated.
See onAttach(Context) .
|
void
|
onAttach(Context context)
Called when a fragment is first attached to its context.
|
void
|
onAttachFragment(Fragment childFragment)
This method is deprecated.
The responsibility for listening for fragments being attached has been moved
to FragmentManager. You can add a listener to
getChildFragmentManager() the child FragmentManager} by calling
FragmentManager.addFragmentOnAttachListener(FragmentOnAttachListener)
in onAttach(Context) to get callbacks when a child fragment is attached.
|
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 is deprecated.
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
|
onPrimaryNavigationFragmentChanged(boolean isPrimaryNavigationFragment)
Callback for when the primary navigation state of this Fragment has changed.
|
void
|
onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)
This method is deprecated.
use
registerForActivityResult(ActivityResultContract, ActivityResultCallback) passing
in a ActivityResultContracts.RequestMultiplePermissions object for the ActivityResultContract and
handling the result in the callback .
|
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 if 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 FragmentManager.executePendingTransactions() has been called.
|
final
void
|
postponeEnterTransition(long duration, TimeUnit timeUnit)
Postpone the entering Fragment transition for a given amount of time and then call
startPostponedEnterTransition() .
|
final
<I, O>
ActivityResultLauncher<I>
|
registerForActivityResult(ActivityResultContract<I, O> contract, ActivityResultCallback<O> callback)
Register a request to start an activity for result ,
designated by the given contract .
If the host of this fragment is an ActivityResultRegistryOwner the
ActivityResultRegistry of the host will be used.
|
final
<I, O>
ActivityResultLauncher<I>
|
registerForActivityResult(ActivityResultContract<I, O> contract, ActivityResultRegistry registry, ActivityResultCallback<O> callback)
Register a request to start an activity for result ,
designated by the given contract .
|
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)
This method is deprecated.
use
registerForActivityResult(ActivityResultContract, ActivityResultCallback) passing
in a ActivityResultContracts.RequestMultiplePermissions object for the ActivityResultContract and
handling the result in the callback .
|
final
FragmentActivity
|
requireActivity()
Return the FragmentActivity this fragment is currently associated with.
|
final
Bundle
|
requireArguments()
Return the arguments supplied when the fragment was instantiated.
|
final
Context
|
requireContext()
Return the Context this fragment is currently associated with.
|
final
FragmentManager
|
requireFragmentManager()
This method is deprecated.
This has been renamed to getParentFragmentManager() to make it
clear that you are accessing the FragmentManager that contains this Fragment and not the
FragmentManager associated with child Fragments.
|
final
Object
|
requireHost()
Return the host object of this fragment.
|
final
Fragment
|
requireParentFragment()
Returns the parent Fragment containing this Fragment.
|
final
View
|
requireView()
Get the root view for the fragment's layout (the one returned by onCreateView(LayoutInflater, ViewGroup, Bundle) ).
|
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)
This method is deprecated.
Instead of retaining the Fragment itself, use a non-retained Fragment and keep
retained state in a ViewModel attached to that Fragment. The ViewModel's constructor and
its onCleared() callback provide the signal for initial creation and final destruction of
the retained state.
|
void
|
setReturnTransition(Object 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(Object transition)
Sets the Transition that will be used for shared elements transferred into the content
Scene.
|
void
|
setSharedElementReturnTransition(Object 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)
This method is deprecated.
Instead of using a target fragment to pass results, the fragment requesting a
result should use
FragmentManager.setFragmentResultListener(String, LifecycleOwner, FragmentResultListener) to register a FragmentResultListener with a requestKey using its parent fragment manager . The
fragment delivering a result should then call
FragmentManager.setFragmentResult(String, Bundle) using the same requestKey .
Consider using setArguments(Bundle) to pass the requestKey if you need to support
dynamic request keys.
|
void
|
setUserVisibleHint(boolean isVisibleToUser)
This method is deprecated.
If you are manually calling this method, use
FragmentTransaction.setMaxLifecycle(Fragment, Lifecycle.State) instead. If
overriding this method, behavior implemented when passing in true should be
moved to onResume() , and behavior implemented when passing in
false should be moved to onPause() .
|
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)
This method is deprecated.
use
registerForActivityResult(ActivityResultContract, ActivityResultCallback)
passing in a ActivityResultContracts.StartActivityForResult object for the ActivityResultContract .
|
void
|
startActivityForResult(Intent intent, int requestCode, Bundle options)
This method is deprecated.
use
registerForActivityResult(ActivityResultContract, ActivityResultCallback)
passing in a ActivityResultContracts.StartActivityForResult object for the ActivityResultContract .
|
void
|
startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)
This method is deprecated.
use
registerForActivityResult(ActivityResultContract, ActivityResultCallback)
passing in a ActivityResultContracts.StartIntentSenderForResult object for the
ActivityResultContract .
|
void
|
startPostponedEnterTransition()
Begin postponed transitions after postponeEnterTransition() was called.
|
String
|
toString()
|
void
|
unregisterForContextMenu(View view)
Prevents a context menu to be shown for the given view.
|