DetailsSupportFragment

Added in 1.1.0

Kotlin |Java

class DetailsSupportFragment : BaseSupportFragment

kotlin.Any
↳	androidx.fragment.app.Fragment
	↳	androidx.leanback.app.BrandedSupportFragment
		↳	androidx.leanback.app.BaseSupportFragment
			↳	androidx.leanback.app.DetailsSupportFragment

A fragment for creating Leanback details screens.

A DetailsSupportFragment renders the elements of its ObjectAdapter as a set of rows in a vertical list.The Adapter's PresenterSelector must maintain subclasses of RowPresenter.

When FullWidthDetailsOverviewRowPresenter is found in adapter, DetailsSupportFragment will setup default behavior of the DetailsOverviewRow:

The alignment of FullWidthDetailsOverviewRowPresenter is setup in setupDetailsOverviewRowPresenter.
The view status switching of FullWidthDetailsOverviewRowPresenter is done in onSetDetailsOverviewRowStatus.

The recommended activity themes to use with a DetailsSupportFragment are

Theme_Leanback_Details with activity shared element transition for FullWidthDetailsOverviewRowPresenter.
Theme_Leanback_Details_NoSharedElementTransition if shared element transition is not needed, for example if first row is not rendered by FullWidthDetailsOverviewRowPresenter.

DetailsSupportFragment can use DetailsSupportFragmentBackgroundController to add a parallax drawable background and embedded video playing fragment.

Summary

Public constructors
`DetailsSupportFragment()`

Public functions
`ObjectAdapter!`	`getAdapter()` Returns the list of rows.
`BaseOnItemViewClickedListener!`	`getOnItemViewClickedListener()` Returns the item clicked listener.
`DetailsParallax!`	`getParallax()` Returns the `DetailsParallax` instance used by `DetailsSupportFragmentBackgroundController` to configure parallax effect of background and control embedded video playback.
`RowsSupportFragment!`	`getRowsSupportFragment()` Gets embedded RowsSupportFragment showing multiple rows for DetailsSupportFragment.
`Unit`	`onCreate(savedInstanceState: Bundle!)` Called to do initial creation of a fragment.
`View?`	`onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? )` Called to have the fragment instantiate its user interface view.
`Unit`	`onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
`View`	`onInflateTitleView( inflater: LayoutInflater, parent: ViewGroup?, savedInstanceState: Bundle? )` Called by `installTitleView` to inflate title view.
`Unit`	`onStart()` Called when the Fragment is visible to the user.
`Unit`	`onStop()` Called when the Fragment is no longer started.
`Unit`	`setAdapter(adapter: ObjectAdapter!)` Sets the list of rows for the fragment.
`Unit`	`setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener!)` Sets an item clicked listener.
`Unit`	`setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener!)` Sets an item selection listener.
`Unit`	`setSelectedPosition(position: Int)` Sets the selected row position with smooth animation.
`Unit`	`setSelectedPosition(position: Int, smooth: Boolean)` Sets the selected row position.

Protected functions
`Any!`	`createEntranceTransition()` Create entrance transition.
`View!`	`inflateTitle( inflater: LayoutInflater!, parent: ViewGroup!, savedInstanceState: Bundle! )` This function is deprecated. override `onInflateTitleView` instead.
`Unit`	`onEntranceTransitionEnd()` Callback when entrance transition is ended.
`Unit`	`onEntranceTransitionPrepare()` Callback when entrance transition is prepared.
`Unit`	`onEntranceTransitionStart()` Callback when entrance transition is started.
`Unit`	`onSetDetailsOverviewRowStatus( presenter: FullWidthDetailsOverviewRowPresenter!, viewHolder: FullWidthDetailsOverviewRowPresenter.ViewHolder!, adapterPosition: Int, selectedPosition: Int, selectedSubPosition: Int )` Called to change DetailsOverviewRow view status when current selected row position or selected sub position changed.
`Unit`	`onSetRowStatus( presenter: RowPresenter!, viewHolder: RowPresenter.ViewHolder!, adapterPosition: Int, selectedPosition: Int, selectedSubPosition: Int )` Called on every visible row to change view status when current selected row position or selected sub position changed.
`Unit`	`runEntranceTransition(entranceTransition: Any!)` Run entrance transition.
`Unit`	`setupDetailsOverviewRowPresenter( presenter: FullWidthDetailsOverviewRowPresenter! )` Called to setup `FullWidthDetailsOverviewRowPresenter`.
`Unit`	`setupPresenter(rowPresenter: Presenter!)` Called to setup each Presenter of Adapter passed in `setAdapter`.Note that setup should only change the Presenter behavior that is meaningful in DetailsSupportFragment.

Inherited functions

From androidx.activity.result.ActivityResultCaller

abstract ActivityResultLauncher<I!>!

<I, O> registerForActivityResult(
    contract: ActivityResultContract<I!, O!>!,
    callback: ActivityResultCallback<O!>!
)

From androidx.leanback.app.BaseSupportFragment

`ProgressBarManager!`	`getProgressBarManager()` Returns the `ProgressBarManager`.
`Unit`	`onViewCreated(view: View, savedInstanceState: Bundle?)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`Unit`	`prepareEntranceTransition()` Enables entrance transition.
`Unit`	`startEntranceTransition()` When fragment finishes loading data, it should call startEntranceTransition() to execute the entrance transition. startEntranceTransition() will start transition only if both two conditions are satisfied:

From androidx.leanback.app.BrandedSupportFragment

`Drawable?`	`getBadgeDrawable()` Returns the badge drawable used in the fragment title.
`Int`	`getSearchAffordanceColor()` Returns the color used to draw the search affordance.
`SearchOrbView.Colors?`	`getSearchAffordanceColors()` Returns the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`CharSequence?`	`getTitle()` Returns the title text for the fragment.
`View?`	`getTitleView()` Returns the view that implements `TitleViewAdapter.Provider`.
`TitleViewAdapter?`	`getTitleViewAdapter()` Returns the `TitleViewAdapter` implemented by title view.
`Unit`	`installTitleView( inflater: LayoutInflater, parent: ViewGroup, savedInstanceState: Bundle? )` Inflate title view and add to parent.
`Boolean`	`isShowingTitle()` Returns true/false to indicate the visibility of TitleView.
`Unit`	`onPause()` Called when the Fragment is no longer resumed.
`Unit`	`onResume()` Called when the fragment is visible to the user and actively running.
`Unit`	`onSaveInstanceState(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.
`Unit`	`setBadgeDrawable(drawable: Drawable?)` Sets the drawable displayed in the fragment title.
`Unit`	`setOnSearchClickedListener(listener: View.OnClickListener?)` Sets a click listener for the search affordance.
`Unit`	`setSearchAffordanceColor(color: Int)` Sets the color used to draw the search affordance.
`Unit`	`setSearchAffordanceColors(colors: SearchOrbView.Colors)` Sets the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`Unit`	`setTitle(title: CharSequence?)` Sets title text for the fragment.
`Unit`	`setTitleView(titleView: View?)` Sets the view that implemented `TitleViewAdapter`.
`Unit`	`showTitle(flags: Int)` Changes title view's components visibility and shows title.
`Unit`	`showTitle(show: Boolean)` Shows or hides the title view.

From android.content.ComponentCallbacks

`abstract Unit`	`onConfigurationChanged(p: Configuration!)`
`abstract Unit`	`onLowMemory()` This function is deprecated.

From androidx.activity.contextaware.ContextAware

`abstract Unit`	`addOnContextAvailableListener(listener: OnContextAvailableListener!)` Add a new `OnContextAvailableListener` for receiving a callback for when this class is associated with a `android.content.Context`.
`abstract Context!`	`peekAvailableContext()` Get the `Context` if it is currently available.
`abstract Unit`	`removeOnContextAvailableListener(listener: OnContextAvailableListener!)` Remove a `OnContextAvailableListener` previously added via `addOnContextAvailableListener`.

From androidx.fragment.app.Fragment

`Unit`	`addOnContextAvailableListener(listener: OnContextAvailableListener)` Add a new `OnContextAvailableListener` for receiving a callback for when this class is associated with a `android.content.Context`.
`Unit`	`dump( prefix: String, fd: FileDescriptor?, writer: PrintWriter, args: Array<String!>? )` Print the Fragments's state into the given stream.
`Boolean`	`equals(o: Any?)` Subclasses can not override equals().
`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.
`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.
`Context?`	`getContext()` Return the `Context` this fragment is currently associated with.
`CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()` Returns the default `CreationExtras` that should be passed into `ViewModelProvider.Factory.create` when no overriding `CreationExtras` were passed to the `ViewModelProvider` constructors.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors.
`Any?`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`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()` This function is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null.
`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.
`Lifecycle`	`getLifecycle()` Returns the Lifecycle of the provider.
`LoaderManager`	`getLoaderManager()` This function is deprecated. Use `LoaderManager.getInstance(this)`.
`Fragment?`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`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()` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`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()` The `SavedStateRegistry` owned by this SavedStateRegistryOwner
`Any?`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Any?`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`String`	`getString(resId: @StringRes Int)` Return a localized string from the application's package's default string table.
`String`	`getString(resId: @StringRes Int, formatArgs: Array<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 `format`.
`String?`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment?`	`getTargetFragment()` This function is deprecated. Instead of using a target fragment to pass results, use `setFragmentResult` to deliver results to `FragmentResultListener` instances registered by other fragments via `setFragmentResultListener`.
`Int`	`getTargetRequestCode()` This function is deprecated. When using the target fragment replacement of `setFragmentResultListener` and `setFragmentResult`, consider using `setArguments` to pass a `requestKey` if you need to support dynamic request keys.
`CharSequence`	`getText(resId: @StringRes Int)` Return a localized, styled CharSequence from the application's package's default string table.
`Boolean`	`getUserVisibleHint()` This function is deprecated. Use `setMaxLifecycle` instead.
`View?`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`LifecycleOwner`	`@MainThread 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
`Int`	`hashCode()` Subclasses can not override hashCode().
`java-static Fragment`	`instantiate(context: Context, fname: String)` This function is deprecated. Use `getFragmentFactory` and `instantiate`
`java-static Fragment`	`instantiate(context: Context, fname: String, args: Bundle?)` This function is deprecated. Use `getFragmentFactory` and `instantiate`, manually calling `setArguments` on the returned Fragment.
`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 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.
`Unit`	`@MainThread @CallSuper onActivityCreated(savedInstanceState: Bundle?)` This function is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`@MainThread @CallSuper onAttach(activity: Activity)` This function is deprecated. See `onAttach`.
`Unit`	`@MainThread @CallSuper onAttach(context: Context)` Called when a fragment is first attached to its context.
`Unit`	`@MainThread onAttachFragment(childFragment: Fragment)` This function is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`Unit`	`@CallSuper onConfigurationChanged(newConfig: Configuration)`
`Boolean`	`@MainThread onContextItemSelected(item: MenuItem)` This hook is called whenever an item in a context menu is selected.
`Unit`	`@MainThread @CallSuper onCreate(savedInstanceState: Bundle?)` Called to do initial creation of a fragment.
`Animation?`	`@MainThread onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation.
`Animator?`	`@MainThread onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animator.
`Unit`	`@MainThread onCreateContextMenu( menu: ContextMenu, v: View, menuInfo: ContextMenu.ContextMenuInfo? )` Called when a context menu for the `view` is about to be shown.
`Unit`	`@MainThread onCreateOptionsMenu(menu: Menu, inflater: MenuInflater)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread @CallSuper onDestroy()` Called when the fragment is no longer in use.
`Unit`	`@MainThread onDestroyOptionsMenu()` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread @CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(savedInstanceState: Bundle?)` Returns the LayoutInflater used to inflate Views of this Fragment.
`Unit`	`@MainThread onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`Unit`	`@UiThread @CallSuper onInflate( activity: Activity, attrs: AttributeSet, savedInstanceState: Bundle? )` This function is deprecated. See `onInflate`.
`Unit`	`@UiThread @CallSuper 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.
`Unit`	`@MainThread @CallSuper onLowMemory()` This function is deprecated.
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`Boolean`	`@MainThread onOptionsItemSelected(item: MenuItem)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread onOptionsMenuClosed(menu: Menu)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode.
`Unit`	`@MainThread onPrepareOptionsMenu(menu: Menu)` This function is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling `addMenuProvider` without forcing all components through this single method override.
`Unit`	`@MainThread onPrimaryNavigationFragmentChanged( isPrimaryNavigationFragment: Boolean )` Callback for when the primary navigation state of this Fragment has changed.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>, grantResults: IntArray<Int> )` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`@MainThread @CallSuper onViewStateRestored(savedInstanceState: Bundle?)` Called when all saved state has been restored into the view hierarchy of the fragment.
`Context?`	`peekAvailableContext()` Get the `Context` if it is currently available.
`Unit`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition` or `executePendingTransactions` has been called.
`Unit`	`postponeEnterTransition(duration: Long, timeUnit: TimeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`ActivityResultLauncher<I!>`	`@MainThread <I, O> registerForActivityResult( contract: ActivityResultContract<I!, O!>, registry: ActivityResultRegistry, callback: ActivityResultCallback<O!> )` Register a request to `start an activity for result`, designated by the given `contract`.
`Unit`	`registerForContextMenu(view: View)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`Unit`	`removeOnContextAvailableListener(listener: OnContextAvailableListener)` Remove a `OnContextAvailableListener` previously added via `addOnContextAvailableListener`.
`Unit`	`requestPermissions(permissions: Array<String!>, requestCode: Int)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`FragmentManager`	`requireFragmentManager()` This function 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.
`Any`	`requireHost()` Return the host object of this fragment.
`Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` Sets whether the the exit transition and enter transition overlap or not.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` Sets whether the the return transition and reenter transition overlap or not.
`Unit`	`setArguments(args: Bundle?)` Supply the construction arguments for this fragment.
`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.
`Unit`	`setEnterTransition(transition: Any?)` Sets the Transition that will be used to move Views into the initial scene.
`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.
`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.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function is deprecated. This method is no longer needed when using a `MenuProvider` to provide a `Menu` to your activity, which replaces `onCreateOptionsMenu` as the recommended way to provide a consistent, optionally `Lifecycle`-aware, and modular way to handle menu creation and item selection.
`Unit`	`setInitialSavedState(state: Fragment.SavedState?)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` Set a hint for whether this fragment's menu should be visible.
`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.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`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.
`Unit`	`setSharedElementEnterTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`Unit`	`setSharedElementReturnTransition(transition: Any?)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`Unit`	`setTargetFragment(fragment: Fragment?, requestCode: Int)` This function is deprecated. Instead of using a target fragment to pass results, the fragment requesting a result should use `setFragmentResultListener` to register a `FragmentResultListener` with a `requestKey` using its `parent fragment manager`.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated. If you are manually calling this method, use `setMaxLifecycle` instead.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String)` Gets whether you should show UI with rationale before requesting a permission.
`Unit`	`startActivity(intent: Intent)` Call `startActivity` from the fragment's containing Activity.
`Unit`	`startActivity(intent: Intent, options: Bundle?)` Call `startActivity` from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startActivityForResult(intent: Intent, requestCode: Int, options: Bundle?)` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startIntentSenderForResult( intent: IntentSender, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle? )` This function is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`Unit`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`String`	`toString()`
`Unit`	`unregisterForContextMenu(view: View)` Prevents a context menu to be shown for the given view.

From androidx.lifecycle.HasDefaultViewModelProviderFactory

`CreationExtras!`	`getDefaultViewModelCreationExtras()` Returns the default `CreationExtras` that should be passed into `ViewModelProvider.Factory.create` when no overriding `CreationExtras` were passed to the `ViewModelProvider` constructors.
`ViewModelProvider.Factory!`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors.

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle!

getLifecycle()

Returns the Lifecycle of the provider.

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry!

getSavedStateRegistry()

The SavedStateRegistry owned by this SavedStateRegistryOwner

From android.view.View.OnCreateContextMenuListener

abstract Unit

onCreateContextMenu(
    p: ContextMenu!,
    p1: View!,
    p2: ContextMenu.ContextMenuInfo!
)

From androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore!

getViewModelStore()

The owned ViewModelStore

Public constructors

DetailsSupportFragment

Added in 1.1.0

DetailsSupportFragment()

Public functions

getAdapter

Added in 1.1.0

fun getAdapter(): ObjectAdapter!

Returns the list of rows.

getOnItemViewClickedListener

Added in 1.1.0

fun getOnItemViewClickedListener(): BaseOnItemViewClickedListener!

Returns the item clicked listener.

getParallax

Added in 1.1.0

fun getParallax(): DetailsParallax!

Returns the DetailsParallax instance used by DetailsSupportFragmentBackgroundController to configure parallax effect of background and control embedded video playback. App usually does not use this method directly. App may use this method for other custom parallax tasks.

Returns
`DetailsParallax!`	The DetailsParallax instance attached to the DetailsSupportFragment.

getRowsSupportFragment

Added in 1.1.0

fun getRowsSupportFragment(): RowsSupportFragment!

Gets embedded RowsSupportFragment showing multiple rows for DetailsSupportFragment. If view of DetailsSupportFragment is not created, the method returns null.

Returns
`RowsSupportFragment!`	Embedded RowsSupportFragment showing multiple rows for DetailsSupportFragment.

onCreate

fun onCreate(savedInstanceState: Bundle!): Unit

Called to do initial creation of a fragment. This is called after onAttach and before onCreateView.

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, add a androidx.lifecycle.LifecycleObserver on the activity's Lifecycle, removing it when it receives the CREATED callback.

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.

onCreateView

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. This will be called between onCreate and onViewCreated.

A default View can be returned by calling Fragment in your constructor. Otherwise, this method returns null.

It is recommended to only inflate the layout in this method and move logic that operates on the returned View to onViewCreated.

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: ViewGroup?`	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: Bundle?`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`View?`	Return the View for the fragment's UI, or null.

onDestroyView

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.

onInflateTitleView

fun onInflateTitleView(
    inflater: LayoutInflater,
    parent: ViewGroup?,
    savedInstanceState: Bundle?
): View

Called by installTitleView to inflate title view. Default implementation uses layout file lb_browse_title. Subclass may override and use its own layout, the layout must have a descendant with id browse_title_group that implements TitleViewAdapter.Provider. Subclass may return null if no title is needed.

Parameters
`inflater: LayoutInflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`parent: ViewGroup?`	Parent of title view.
`savedInstanceState: Bundle?`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`View`	Title view which must have a descendant with id browse_title_group that implements `TitleViewAdapter.Provider`, or null for no title view.

onStart

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.

onStop

fun onStop(): Unit

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

Added in 1.1.0

fun setAdapter(adapter: ObjectAdapter!): Unit

Sets the list of rows for the fragment.

Added in 1.1.0

fun setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener!): Unit

Sets an item clicked listener.

Added in 1.1.0

fun setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener!): Unit

Sets an item selection listener.

setSelectedPosition

Added in 1.1.0

fun setSelectedPosition(position: Int): Unit

Sets the selected row position with smooth animation.

setSelectedPosition

Added in 1.1.0

fun setSelectedPosition(position: Int, smooth: Boolean): Unit

Sets the selected row position.

Protected functions

createEntranceTransition

protected fun createEntranceTransition(): Any!

Create entrance transition. Subclass can override to load transition from resource or construct manually. Typically app does not need to override the default transition that browse and details provides.

inflateTitle

Added in 1.1.0

Deprecated in 1.1.0

protected fun inflateTitle(
    inflater: LayoutInflater!,
    parent: ViewGroup!,
    savedInstanceState: Bundle!
): View!

onEntranceTransitionEnd

protected fun onEntranceTransitionEnd(): Unit

Callback when entrance transition is ended.

onEntranceTransitionPrepare

protected fun onEntranceTransitionPrepare(): Unit

Callback when entrance transition is prepared. This is when fragment should stop user input and animations.

onEntranceTransitionStart

protected fun onEntranceTransitionStart(): Unit

Callback when entrance transition is started. This is when fragment should stop processing layout.

Added in 1.1.0

protected fun onSetDetailsOverviewRowStatus(
    presenter: FullWidthDetailsOverviewRowPresenter!,
    viewHolder: FullWidthDetailsOverviewRowPresenter.ViewHolder!,
    adapterPosition: Int,
    selectedPosition: Int,
    selectedSubPosition: Int
): Unit

Called to change DetailsOverviewRow view status when current selected row position or selected sub position changed. Subclass may override. The default implementation switches between three states based on the positions: STATE_HALF, STATE_FULL and STATE_SMALL.

Parameters
`presenter: FullWidthDetailsOverviewRowPresenter!`	The presenter used to create row ViewHolder.
`viewHolder: FullWidthDetailsOverviewRowPresenter.ViewHolder!`	The visible (attached) row ViewHolder, note that it may or may not be selected.
`adapterPosition: Int`	The adapter position of viewHolder inside adapter.
`selectedPosition: Int`	The adapter position of currently selected row.
`selectedSubPosition: Int`	The sub position within currently selected row. This is used When a row has multiple alignment positions.

Added in 1.1.0

protected fun onSetRowStatus(
    presenter: RowPresenter!,
    viewHolder: RowPresenter.ViewHolder!,
    adapterPosition: Int,
    selectedPosition: Int,
    selectedSubPosition: Int
): Unit

Called on every visible row to change view status when current selected row position or selected sub position changed. Subclass may override. The default implementation calls onSetDetailsOverviewRowStatus if presenter is instance of FullWidthDetailsOverviewRowPresenter.

Parameters
`presenter: RowPresenter!`	The presenter used to create row ViewHolder.
`viewHolder: RowPresenter.ViewHolder!`	The visible (attached) row ViewHolder, note that it may or may not be selected.
`adapterPosition: Int`	The adapter position of viewHolder inside adapter.
`selectedPosition: Int`	The adapter position of currently selected row.
`selectedSubPosition: Int`	The sub position within currently selected row. This is used When a row has multiple alignment positions.

runEntranceTransition

protected fun runEntranceTransition(entranceTransition: Any!): Unit

Run entrance transition. Subclass may use TransitionManager to perform go(Scene) or beginDelayedTransition(). App should not override the default implementation of browse and details fragment.

Added in 1.1.0

protected fun setupDetailsOverviewRowPresenter(
    presenter: FullWidthDetailsOverviewRowPresenter!
): Unit

Called to setup FullWidthDetailsOverviewRowPresenter. The default implementation adds two alignment positions(ItemAlignmentFacet) for ViewHolder of FullWidthDetailsOverviewRowPresenter to align in fragment.

Added in 1.1.0

protected fun setupPresenter(rowPresenter: Presenter!): Unit

Called to setup each Presenter of Adapter passed in setAdapter.Note that setup should only change the Presenter behavior that is meaningful in DetailsSupportFragment. For example how a row is aligned in details Fragment. The default implementation invokes setupDetailsOverviewRowPresenter