fragment/androidx.fragment.app/FragmentHostCallback

FragmentHostCallback

abstract class FragmentHostCallback<H> : FragmentContainer(source)

Integration points with the Fragment host.

Fragments may be hosted by any object; such as an Activity. In order to host fragments, implement FragmentHostCallback, overriding the methods applicable to the host.

FragmentManager changes its behavior based on what optional interfaces your FragmentHostCallback implements. This includes the following:

androidx.activity.result.ActivityResultRegistryOwner: Removes the need to override .onStartIntentSenderFromFragment or .onRequestPermissionsFromFragment.
FragmentOnAttachListener: Removes the need to manually call FragmentManager.addFragmentOnAttachListener from your host in order to receive FragmentOnAttachListener.onAttachFragment callbacks for the FragmentController.getSupportFragmentManager.
androidx.activity.OnBackPressedDispatcherOwner: Removes the need to manually call FragmentManager.popBackStackImmediate when handling the system back button.
androidx.lifecycle.ViewModelStoreOwner: Removes the need for your FragmentController to call FragmentController.retainNestedNonConfig or FragmentController.restoreAllState.

Parameters

the type of object that's currently hosting the fragments. An instance of this class must be returned by onGetHost.

Constructors

FragmentHostCallback

constructor(context: Context, handler: Handler, windowAnimations: Int)

Properties

activity

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY])

val activity: Activity?

context

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY])

val context: Context

fragmentManager

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY])

val fragmentManager: FragmentManager

handler

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY])

val handler: Handler

Functions

onDump

open fun onDump(prefix: String, fd: FileDescriptor?, writer: PrintWriter, args: Array<String>?)

Print internal state into the given stream.

onFindViewById

open override fun onFindViewById(id: Int): View?

Return the view with the given resource ID. May return null if the view is not a child of this container.

onGetHost

abstract fun onGetHost(): H

Return the object that's currently hosting the fragment. If a Fragment is hosted by a FragmentActivity, the object returned here should be the same object returned from Fragment.getActivity.

onGetLayoutInflater

open fun onGetLayoutInflater(): LayoutInflater

Return a LayoutInflater. See Activity.getLayoutInflater.

onGetWindowAnimations

open fun onGetWindowAnimations(): Int

Return the window animations.

onHasView

open override fun onHasView(): Boolean

Return true if the container holds any view.

onHasWindowAnimations

open fun onHasWindowAnimations(): Boolean

Return true if there are window animations.

onRequestPermissionsFromFragment

open fun ~~onRequestPermissionsFromFragment~~(fragment: Fragment, permissions: Array<String>, requestCode: Int)

Requests permissions from the given fragment. See FragmentActivity.requestPermissions

onShouldSaveFragmentState

open fun onShouldSaveFragmentState(fragment: Fragment): Boolean

Return true if the fragment's state needs to be saved.

onShouldShowRequestPermissionRationale

open fun onShouldShowRequestPermissionRationale(permission: String): Boolean

Checks whether to show permission rationale UI from a fragment. See FragmentActivity.shouldShowRequestPermissionRationale

onStartActivityFromFragment

open fun onStartActivityFromFragment(fragment: Fragment, intent: Intent, requestCode: Int)

open fun onStartActivityFromFragment(fragment: Fragment, intent: Intent, requestCode: Int, options: Bundle?)

Starts a new Activity from the given fragment. See FragmentActivity.startActivityForResult.

onStartIntentSenderFromFragment

open fun ~~onStartIntentSenderFromFragment~~(fragment: Fragment, intent: IntentSender, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)

Starts a new IntentSender from the given fragment. See Activity.startIntentSender.

onSupportInvalidateOptionsMenu

open fun onSupportInvalidateOptionsMenu()

Invalidates the activity's options menu. See FragmentActivity.supportInvalidateOptionsMenu