Fragment

open class Fragment : ComponentCallbacks, OnCreateContextMenuListener
kotlin.Any
   ↳ androidx.fragment.app.Fragment

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:

Summary

Nested classes
open

Thrown by Fragment#instantiate(Context, String, Bundle) when there is an instantiation failure.

open

State information that has been retrieved from a fragment instance through FragmentManager.saveFragmentInstanceState.

Public constructors

Default constructor.

Public methods
open Unit

Called when a context menu for the view is about to be shown.

open Boolean

This hook is called whenever an item in a context menu is selected.

open View?

Get the root view for the fragment's layout (the one returned by #onCreateView), if provided.

open Unit
setExitSharedElementCallback(callback: SharedElementCallback!)

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.

open Boolean

Returns whether the the return transition and reenter transition overlap or not.

open Unit
startIntentSenderForResult(intent: IntentSender!, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle!)

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

Unit
requestPermissions(permissions: Array<String!>, requestCode: Int)

Requests permissions to be granted to this application.

open Boolean

Returns whether the the exit transition and enter transition overlap or not.

open Unit
setExitTransition(transition: Any?)

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.

open Unit

open Unit
onAttach(context: Context!)

Called when a fragment is first attached to its context.

open Unit
onAttach(activity: Activity!)

Called when a fragment is first attached to its activity.

open Unit

Called when the Fragment is no longer resumed.

Any?

Return the host object of this fragment.

open Unit

Supply the construction arguments for this fragment.

open Unit

Sets the Transition that will be used for shared elements transferred into the content Scene.

Boolean

Returns true if this fragment is added and its state has already been saved by its host.

open Unit

Sets whether the the exit transition and enter transition overlap or not.

open Unit
dump(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)

Print the Fragments's state into the given stream.

open Unit

Prepare the Fragment host's standard options menu to be displayed.

Boolean

Return true if the fragment is currently visible to the user.

open Unit
setEnterSharedElementCallback(callback: SharedElementCallback!)

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.

open Unit
onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)

Receive the result from a previous call to #startActivityForResult(Intent, int).

open Any?

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.

open Animator!
onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)

Called when a fragment loads an animator.

Bundle?

Return the arguments supplied when the fragment was instantiated, if any.

LayoutInflater!

Returns the cached LayoutInflater used to inflate Views of this Fragment.

open Unit
onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.

open Unit
setEnterTransition(transition: Any?)

Sets the Transition that will be used to move Views into the initial scene.

open Unit
onInflate(context: Context!, attrs: AttributeSet!, 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(activity: Activity!, attrs: AttributeSet!, 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
onViewCreated(view: View, savedInstanceState: Bundle?)

Called immediately after #onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view.

FragmentActivity

Return the FragmentActivity this fragment is currently associated with.

open Unit
onActivityCreated(savedInstanceState: Bundle?)

Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.

open Unit
onCreate(savedInstanceState: Bundle?)

Called to do initial creation of a fragment.

open Unit

open Unit
onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!)

Initialize the contents of the Fragment host's standard options menu.

Int

Return the target request code set by #setTargetFragment.

open Unit

Begin postponed transitions after #postponeEnterTransition() was called.

open LoaderManager!

Return the LoaderManager for this fragment.

open Any?

Returns the Transition that will be used to move Views into the initial scene.

open Unit

Called when the Fragment is visible to the user.

Fragment?

Returns the parent Fragment containing this Fragment.

open Unit

Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).

open Unit

Prevents a context menu to be shown for the given view.

Boolean
equals(other: Any?)

Subclasses can not override equals().

open Unit

Registers a context menu to be shown for the given view (multiple views can show the context menu).

open Any!

Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.

open Unit

Called when this fragment's option menu items are no longer being included in the overall options menu.

open Lifecycle!

open Unit
setTargetFragment(fragment: Fragment?, requestCode: Int)

Optional target for this fragment.

open Unit

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 Any?

Returns the Transition that will be used for shared elements transferred into the content Scene.

Context

Return the Context this fragment is currently associated with.

open Unit
onRequestPermissionsResult(requestCode: Int, permissions: Array<String!>, grantResults: IntArray)

Callback for the result from requesting permissions.

Resources

Return requireActivity().getResources().

String
getString(resId: Int)

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

String
getString(resId: Int, 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.lang.String#format.

Boolean

Return true if this fragment is currently being removed from its activity.

open Unit

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

Boolean

FragmentActivity?

Return the FragmentActivity this fragment is currently associated with.

open Unit

Called when the fragment is visible to the user and actively running.

Int

Return the identifier this fragment is known by.

Boolean

Return true if the fragment has been explicitly detached from the UI.

open Unit

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.

open LiveData

Retrieve a LiveData which allows you to observe the lifecycle of the Fragment's View.

CharSequence
getText(resId: Int)

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

open Unit

Called when the fragment is no longer attached to its activity.

open Boolean

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

String?

Get the tag name of the fragment, if specified.

open Unit

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

open Unit
startActivity(intent: Intent!, options: Bundle?)

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

open Animation!
onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)

Called when a fragment loads an animation.

Any

Return the host object of this fragment.

open View?
onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?)

Called to have the fragment instantiate its user interface view.

Int

Subclasses can not override hashCode().

open Boolean

open String

open Unit
onAttachFragment(childFragment: Fragment!)

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

open LayoutInflater
onGetLayoutInflater(savedInstanceState: Bundle?)

Returns the LayoutInflater used to inflate Views of this Fragment.

Boolean

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

open Unit

Called when the hidden state (as returned by #isHidden() of the fragment has changed.

open Context?

Return the Context this fragment is currently associated with.

open Unit
setMenuVisibility(menuVisible: Boolean)

Set a hint for whether this fragment's menu should be visible.

open Unit

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

open Unit
setReturnTransition(transition: Any?)

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.

open Unit
setReenterTransition(transition: Any?)

Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.

FragmentManager

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

open Unit
setUserVisibleHint(isVisibleToUser: Boolean)

Set a hint to the system about whether this fragment's UI is currently visible to the user.

Fragment?

Return the target fragment set by #setTargetFragment.

open Any?

Return the Transition that will be used for shared elements transferred back during a pop of the back stack.

open Unit
startActivityForResult(intent: Intent!, requestCode: Int)

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

open Unit
startActivityForResult(intent: Intent!, requestCode: Int, options: Bundle?)

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

open Unit

Called when the view previously created by #onCreateView has been detached from the fragment.

FragmentManager

Return the FragmentManager for interacting with fragments associated with this fragment's activity.

open Unit

Report that this fragment would like to participate in populating the options menu by receiving a call to #onCreateOptionsMenu and related methods.

open Unit

Called when the Fragment is no longer started.

open Unit

Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.

open LifecycleOwner

Get a LifecycleOwner that represents the Fragment's View lifecycle.

open Boolean

This hook is called whenever an item in your options menu is selected.

FragmentManager?

Return the FragmentManager for interacting with fragments associated with this fragment's activity.

open Any?

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.

Boolean

Return true if the fragment has been hidden.

open Unit

Sets whether the the return transition and reenter transition overlap or not.

open Unit
onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

Called by the system when the activity changes to and from picture-in-picture mode.

open ViewModelStore

open Unit
onViewStateRestored(savedInstanceState: Bundle?)

Called when all saved state has been restored into the view hierarchy of the fragment.

Boolean

Return true if the fragment is in the resumed state.

Boolean

Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.

open Unit

Called when the fragment is no longer in use.

open static Fragment!
instantiate(context: Context!, fname: String!)

Like #instantiate(Context, String, Bundle) but with a null argument Bundle.

open static Fragment!
instantiate(context: Context!, fname: String!, args: Bundle?)

Create a new instance of a Fragment with the given class name.

Public constructors

<init>

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 and later retrieved by the Fragment with #getArguments.

Applications should generally not implement a constructor. Prefer #onAttach(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 to retrieve attributes from a layout resource, although note this happens when the fragment is attached.

Public methods

onCreateContextMenu

open fun onCreateContextMenu(menu: ContextMenu!, v: View!, menuInfo: ContextMenuInfo!): Unit

Called when a context menu for the view is about to be shown. Unlike #onCreateOptionsMenu, 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.

onContextItemSelected

open fun onContextItemSelected(item: MenuItem!): Boolean

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.
Return
Boolean: boolean Return false to allow normal context menu processing to proceed, true to consume it here.

getView

open fun getView(): View?

Get the root view for the fragment's layout (the one returned by #onCreateView), if provided.

Return
View?: The fragment's root view, or null if it has no layout.

setExitSharedElementCallback

open fun setExitSharedElementCallback(callback: SharedElementCallback!): Unit

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.

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

Returns whether the 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.

Return
Boolean: true to start the reenter transition when possible or false to wait until the return transition completes.

startIntentSenderForResult

open fun startIntentSenderForResult(intent: IntentSender!, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle!): Unit

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

requestPermissions

fun requestPermissions(permissions: Array<String!>, requestCode: Int): Unit

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 android.content.pm.PermissionInfo#PROTECTION_NORMAL are granted at install time if requested in the manifest. Signature permissions android.content.pm.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.

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 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 .

When checking whether you have a permission you should use .

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

A sample permissions request looks like this:


            

private void showContacts() { if (getActivity().checkSelfPermission(Manifest.permission.READ_CONTACTS) != PackageManager.PERMISSION_GRANTED) { requestPermissions(new String[]{Manifest.permission.READ_CONTACTS}, PERMISSIONS_REQUEST_READ_CONTACTS); } else { doShowContacts(); } } @Override public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) { if (requestCode == PERMISSIONS_REQUEST_READ_CONTACTS && grantResults[0] == PackageManager.PERMISSION_GRANTED) { doShowContacts(); } }

Parameters
permissions Array<String!>: The requested permissions.
requestCode Array<String!>: Application specific request code to match with a result reported to #onRequestPermissionsResult(int, String[], int[]).

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

Returns whether the 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.

Return
Boolean: true when the enter transition should start as soon as possible or false to when it should wait until the exiting transition completes.

setExitTransition

open fun setExitTransition(transition: Any?): Unit

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 android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected.

Parameters
transition Any?: The Transition to use to move Views out of the Scene when the Fragment is being closed not due to popping the back stack. transition must be an android.transition.Transition or androidx.transition.Transition.

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration!): Unit

onAttach

open fun onAttach(context: Context!): Unit

Called when a fragment is first attached to its context. #onCreate(Bundle) will be called after this.

onAttach

open fun onAttach(activity: Activity!): Unit

Called when a fragment is first attached to its activity. #onCreate(Bundle) will be called after this.

onPause

open fun onPause(): Unit

Called when the Fragment is no longer resumed. This is generally tied to Activity.onPause of the containing Activity's lifecycle.

getHost

fun getHost(): Any?

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

See Also

setArguments

open fun setArguments(args: Bundle?): Unit

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.

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(transition: Any?): Unit

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

Parameters
transition Any?: The Transition to use for shared elements transferred into the content Scene. transition must be an android.transition.Transition or androidx.transition.Transition.

isStateSaved

fun isStateSaved(): Boolean

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(Bundle) will fail.

Return
Boolean: true if this fragment's state has already been saved by its host

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(allow: Boolean): Unit

Sets whether the 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.

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

dump

open fun dump(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!): Unit

Print the Fragments's state into the given stream.

Parameters
prefix String!: Text to print at the front of each line.
fd String!: The raw file descriptor that the dump is being sent to.
writer String!: 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.

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(menu: Menu!): Unit

Prepare the Fragment host'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().

isVisible

fun isVisible(): Boolean

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.

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(callback: SharedElementCallback!): Unit

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.

onActivityResult

open fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent!): Unit

Receive the result from a previous call to #startActivityForResult(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 Int: An Intent, which can return result data to the caller (various data can be attached to Intent "extras").

getReturnTransition

open fun getReturnTransition(): Any?

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 android.transition.Visibility as entering is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, entering Views will remain unaffected.

Return
Any?: the Transition to use to move Views out of the Scene when the Fragment is preparing to close.

onCreateAnimator

open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): Animator!

Called when a fragment loads an animator. This will be called when #onCreateAnimation(int, boolean, int) returns null. Note that if FragmentTransaction#setCustomAnimations(int, int) was called with Animation resources instead of Animator resources, nextAnim will be an animation resource.

Parameters
transit Int: The value set in FragmentTransaction#setTransition(int) or 0 if not set.
enter Int: true when the fragment is added/attached/shown or false when the fragment is removed/detached/hidden.
nextAnim Int: The resource set in FragmentTransaction#setCustomAnimations(int, int), FragmentTransaction#setCustomAnimations(int, int, int, int), or 0 if neither was called. The value will depend on the current operation.

getArguments

fun getArguments(): Bundle?

Return the arguments supplied when the fragment was instantiated, if any.

getLayoutInflater

fun getLayoutInflater(): LayoutInflater!

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

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

Return
LayoutInflater!: The LayoutInflater used to inflate Views of this Fragment.

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean): Unit

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.

setEnterTransition

open fun setEnterTransition(transition: Any?): Unit

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 android.transition.Visibility as entering is governed by changing visibility from View#INVISIBLE to View#VISIBLE. If transition is null, entering Views will remain unaffected.

Parameters
transition Any?: The Transition to use to move Views into the initial Scene.

onInflate

open fun onInflate(context: Context!, attrs: AttributeSet!, savedInstanceState: Bundle!): Unit

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(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():

{@sample frameworks/support/samples/Support4Demos/src/main/java/com/example/android/supportv4/app/FragmentArgumentsSupport.java * fragment}

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

{@sample frameworks/support/samples/Support4Demos/src/main/res/values/attrs.xml fragment_arguments}

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

{@sample frameworks/support/samples/Support4Demos/src/main/res/layout/fragment_arguments_support.xml from_attributes}

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:

{@sample frameworks/support/samples/Support4Demos/src/main/java/com/example/android/supportv4/app/FragmentArgumentsSupport.java * create}

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

onInflate

open fun onInflate(activity: Activity!, attrs: AttributeSet!, savedInstanceState: Bundle!): Unit

Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.

onViewCreated

open fun onViewCreated(view: View, savedInstanceState: Bundle?): Unit

Called immediately after #onCreateView(LayoutInflater, ViewGroup, 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(LayoutInflater, ViewGroup, Bundle).
savedInstanceState View: If non-null, this fragment is being re-constructed from a previous saved state as given here.

requireActivity

fun requireActivity(): FragmentActivity

Return the FragmentActivity this fragment is currently associated with.

Exceptions
IllegalStateException if not currently associated with an activity or if associated only with a context.

See Also

onActivityCreated

open fun onActivityCreated(savedInstanceState: Bundle?): Unit

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 and before #onViewStateRestored(Bundle).

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

onCreate

open fun onCreate(savedInstanceState: Bundle?): Unit

Called to do initial creation of a fragment. This is called after #onAttach(Activity) and before #onCreateView(LayoutInflater, ViewGroup, Bundle).

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(Bundle).

Any restored child fragments will be created before the base Fragment.onCreate method returns.

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

onLowMemory

open fun onLowMemory(): Unit

onCreateOptionsMenu

open fun onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!): Unit

Initialize the contents of the Fragment host'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. See Activity.onCreateOptionsMenu for more information.

Parameters
menu Menu!: The options menu in which you place your items.

getTargetRequestCode

fun getTargetRequestCode(): Int

Return the target request code set by #setTargetFragment.

startPostponedEnterTransition

open fun startPostponedEnterTransition(): Unit

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.

getLoaderManager

open fun getLoaderManager(): LoaderManager!

Return the LoaderManager for this fragment.

getEnterTransition

open fun getEnterTransition(): Any?

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 android.transition.Visibility as entering is governed by changing visibility from View#INVISIBLE to View#VISIBLE.

Return
Any?: the Transition to use to move Views into the initial Scene.

onStart

open fun onStart(): Unit

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

getParentFragment

fun getParentFragment(): Fragment?

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

setRetainInstance

open fun setRetainInstance(retain: Boolean): Unit

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:

unregisterForContextMenu

open fun unregisterForContextMenu(view: View!): Unit

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.

equals

fun equals(other: Any?): Boolean

Subclasses can not override equals().

registerForContextMenu

open fun registerForContextMenu(view: View!): Unit

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(ContextMenu, View, ContextMenuInfo) will be called when it is time to show the context menu.

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

getReenterTransition

open fun getReenterTransition(): Any!

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 android.transition.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(Object).

Return
Any!: the Transition to use to move Views into the scene when reentering from a previously-started Activity.

onDestroyOptionsMenu

open fun onDestroyOptionsMenu(): Unit

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(Menu, MenuInflater) was not called).

getLifecycle

open fun getLifecycle(): Lifecycle!

setTargetFragment

open fun setTargetFragment(fragment: Fragment?, requestCode: Int): Unit

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 Fragment?: Optional request code, for convenience if you are going to call back with #onActivityResult(int, int, Intent).

onOptionsMenuClosed

open fun onOptionsMenuClosed(menu: Menu!): Unit

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().

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Any?

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

Return
Any?: The Transition to use for shared elements transferred into the content Scene.

requireContext

fun requireContext(): Context

Return the Context this fragment is currently associated with.

Exceptions
IllegalStateException if not currently associated with a context.

See Also

onRequestPermissionsResult

open fun onRequestPermissionsResult(requestCode: Int, permissions: Array<String!>, grantResults: IntArray): Unit

Callback for the result from requesting permissions. This method is invoked for every call on #requestPermissions(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(String[], int).
permissions Int: The requested permissions. Never null.
grantResults Int: The grant results for the corresponding permissions which is either android.content.pm.PackageManager#PERMISSION_GRANTED or android.content.pm.PackageManager#PERMISSION_DENIED. Never null.

getResources

fun getResources(): Resources

Return requireActivity().getResources().

getString

fun getString(resId: Int): String

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

Parameters
resId Int: Resource id for the string

getString

fun getString(resId: Int, vararg formatArgs: Any!): String

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.lang.String#format.

Parameters
resId Int: Resource id for the format string
formatArgs Int: The format arguments that will be used for substitution.

isRemoving

fun isRemoving(): Boolean

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.

postponeEnterTransition

open fun postponeEnterTransition(): Unit

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 {. #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 reordering is enabled.

getRetainInstance

fun getRetainInstance(): Boolean

getActivity

fun getActivity(): FragmentActivity?

Return the FragmentActivity this fragment is currently associated with. May return null if the fragment is associated with a Context instead.

onResume

open fun onResume(): Unit

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.

getId

fun getId(): Int

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.

isDetached

fun isDetached(): Boolean

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

onSaveInstanceState

open fun onSaveInstanceState(outState: Bundle): Unit

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(Bundle), #onCreateView(LayoutInflater, ViewGroup, Bundle), and #onActivityCreated(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.

getViewLifecycleOwnerLiveData

open fun getViewLifecycleOwnerLiveData(): LiveData

Retrieve a LiveData which allows you to observe the lifecycle of the Fragment's View.

This will be set to the new LifecycleOwner after #onCreateView returns a non-null View and will set to null after #onDestroyView().

Return
LiveData: A LiveData that changes in sync with #getViewLifecycleOwner().

getText

fun getText(resId: Int): CharSequence

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

Parameters
resId Int: Resource id for the CharSequence text

onDetach

open fun onDetach(): Unit

Called when the fragment is no longer attached to its activity. This is called after #onDestroy().

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(permission: String): Boolean

Gets whether you should show UI with rationale for requesting a permission. You should do this only if you do not have the permission and the context in which the permission is requested does not clearly communicate to the user what would be the benefit from granting this permission.

For example, if you write a camera app, requesting the camera permission would be expected by the user and no rationale for why it is requested is needed. If however, the app needs location for tagging photos then a non-tech savvy user may wonder how location is related to taking photos. In this case you may choose to show UI with rationale of requesting this permission.

Parameters
permission String: A permission your app wants to request.
Return
Boolean: Whether you can show permission rationale UI.

getTag

fun getTag(): String?

Get the tag name of the fragment, if specified.

startActivity

open fun startActivity(intent: Intent!): Unit

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

startActivity

open fun startActivity(intent: Intent!, options: Bundle?): Unit

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

onCreateAnimation

open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): Animation!

Called when a fragment loads an animation. Note that if FragmentTransaction#setCustomAnimations(int, int) was called with Animator resources instead of Animation resources, nextAnim will be an animator resource.

Parameters
transit Int: The value set in FragmentTransaction#setTransition(int) or 0 if not set.
enter Int: true when the fragment is added/attached/shown or false when the fragment is removed/detached/hidden.
nextAnim Int: The resource set in FragmentTransaction#setCustomAnimations(int, int), FragmentTransaction#setCustomAnimations(int, int, int, int), or 0 if neither was called. The value will depend on the current operation.

requireHost

fun requireHost(): Any

Return the host object of this fragment.

Exceptions
IllegalStateException if not currently associated with a host.

See Also

onCreateView

open fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?

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(Bundle) and #onActivityCreated(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 LayoutInflater: 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.
savedInstanceState LayoutInflater: If non-null, this fragment is being re-constructed from a previous saved state as given here.
Return
View?: Return the View for the fragment's UI, or null.

hashCode

fun hashCode(): Int

Subclasses can not override hashCode().

getUserVisibleHint

open fun getUserVisibleHint(): Boolean
Return
Boolean: The current value of the user-visible hint on this fragment.

toString

open fun toString(): String

onAttachFragment

open fun onAttachFragment(childFragment: Fragment!): Unit

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

onGetLayoutInflater

open fun onGetLayoutInflater(savedInstanceState: Bundle?): LayoutInflater

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?: If the fragment is being re-created from a previous saved state, this is the state.
Return
LayoutInflater: The LayoutInflater used to inflate Views of this Fragment.

isAdded

fun isAdded(): Boolean

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

onHiddenChanged

open fun onHiddenChanged(hidden: Boolean): Unit

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.

getContext

open fun getContext(): Context?

Return the Context this fragment is currently associated with.

setMenuVisibility

open fun setMenuVisibility(menuVisible: Boolean): Unit

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.

setInitialSavedState

open fun setInitialSavedState(state: Fragment.SavedState?): Unit

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.

setReturnTransition

open fun setReturnTransition(transition: Any?): Unit

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 android.transition.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(Object).

Parameters
transition Any?: The Transition to use to move Views out of the Scene when the Fragment is preparing to close. transition must be an android.transition.Transition or androidx.transition.Transition.

setReenterTransition

open fun setReenterTransition(transition: Any?): Unit

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 android.transition.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(Object).

Parameters
transition Any?: The Transition to use to move Views into the scene when reentering from a previously-started Activity. transition must be an android.transition.Transition or androidx.transition.Transition.

getChildFragmentManager

fun getChildFragmentManager(): FragmentManager

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

setUserVisibleHint

open fun setUserVisibleHint(isVisibleToUser: Boolean): Unit

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.

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

getTargetFragment

fun getTargetFragment(): Fragment?

Return the target fragment set by #setTargetFragment.

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Any?

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 android.transition.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(Object).

Return
Any?: The Transition to use for shared elements transferred out of the content Scene.

startActivityForResult

open fun startActivityForResult(intent: Intent!, requestCode: Int): Unit

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

startActivityForResult

open fun startActivityForResult(intent: Intent!, requestCode: Int, options: Bundle?): Unit

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

onDestroyView

open fun onDestroyView(): Unit

Called when the view previously created by #onCreateView 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 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.

requireFragmentManager

fun requireFragmentManager(): FragmentManager

Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will available 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().

Exceptions
IllegalStateException if not associated with a transaction or host.

setHasOptionsMenu

open fun setHasOptionsMenu(hasMenu: Boolean): Unit

Report that this fragment would like to participate in populating the options menu by receiving a call to #onCreateOptionsMenu and related methods.

Parameters
hasMenu Boolean: If true, the fragment has menu items to contribute.

onStop

open fun onStop(): Unit

Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle.

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(transition: Any?): Unit

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 android.transition.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(Object).

Parameters
transition Any?: The Transition to use for shared elements transferred out of the content Scene. transition must be an android.transition.Transition or androidx.transition.Transition.

getViewLifecycleOwner

open fun getViewLifecycleOwner(): LifecycleOwner

Get a LifecycleOwner that represents the Fragment's View lifecycle. In most cases, this mirrors the lifecycle of the Fragment itself, but in cases of detached Fragments, the lifecycle of the Fragment can be considerably longer than the lifecycle of the View itself.

Namely, the lifecycle of the Fragment's View is:

  1. Lifecycle.Event#ON_CREATE in #onViewStateRestored(Bundle)
  2. Lifecycle.Event#ON_START in #onStart()
  3. Lifecycle.Event#ON_RESUME in #onResume()
  4. Lifecycle.Event#ON_PAUSE in #onPause()
  5. Lifecycle.Event#ON_STOP in #onStop()
  6. Lifecycle.Event#ON_DESTROY in #onDestroyView()
The first method where it is safe to access the view lifecycle is #onCreateView(LayoutInflater, ViewGroup, Bundle) under the condition that you must return a non-null view (an IllegalStateException will be thrown if you access the view lifecycle but don't return a non-null view).

The view lifecycle remains valid through the call to #onDestroyView(), after which #getView() will return null, the view lifecycle will be destroyed, and this method will throw an IllegalStateException. Consider using #getViewLifecycleOwnerLiveData() or FragmentTransaction#runOnCommit(Runnable) to receive a callback for when the Fragment's view lifecycle is available.

This should only be called on the main thread.

Return
LifecycleOwner: A LifecycleOwner that represents the Fragment's View lifecycle.
Exceptions
IllegalStateException if the Fragment's View is null.

onOptionsItemSelected

open fun onOptionsItemSelected(item: MenuItem!): Boolean

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.
Return
Boolean: boolean Return false to allow normal menu processing to proceed, true to consume it here.

getFragmentManager

fun getFragmentManager(): FragmentManager?

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().

getExitTransition

open fun getExitTransition(): Any?

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 android.transition.Visibility as exiting is governed by changing visibility from View#VISIBLE to View#INVISIBLE. If transition is null, the views will remain unaffected.

Return
Any?: the Transition to use to move Views out of the Scene when the Fragment is being closed not due to popping the back stack.

isHidden

fun isHidden(): Boolean

Return true if the fragment has been hidden. By default fragments are shown. You can find out about changes to this state with #onHiddenChanged. 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.

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(allow: Boolean): Unit

Sets whether the 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.

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

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean): Unit

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.

getViewModelStore

open fun getViewModelStore(): ViewModelStore

onViewStateRestored

open fun onViewStateRestored(savedInstanceState: Bundle?): Unit

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(Bundle) and before #onStart().

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

isResumed

fun isResumed(): Boolean

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

isInLayout

fun isInLayout(): Boolean

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.

onDestroy

open fun onDestroy(): Unit

Called when the fragment is no longer in use. This is called after #onStop() and before #onDetach().

instantiate

open static fun instantiate(context: Context!, fname: String!): Fragment!

Like #instantiate(Context, String, Bundle) but with a null argument Bundle.

instantiate

open static fun instantiate(context: Context!, fname: String!, args: Bundle?): Fragment!

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 Context!: The class name of the fragment to instantiate.
args Context!: Bundle of arguments to supply to the fragment, which it can retrieve with #getArguments(). May be null.
Return
Fragment!: Returns a new fragment instance.
Exceptions
InstantiationException If there is a failure in instantiating the given fragment class. This is a runtime exception; it is not normally expected to happen.