DetailsFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

class DetailsFragment : BaseFragment

kotlin.Any
↳	android.app.Fragment
	↳	androidx.leanback.app.BrandedFragment
		↳	androidx.leanback.app.BaseFragment
			↳	androidx.leanback.app.DetailsFragment

A fragment for creating Leanback details screens.

A DetailsFragment 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, DetailsFragment 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 DetailsFragment 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.

DetailsFragment can use DetailsFragmentBackgroundController to add a parallax drawable background and embedded video playing fragment.

Summary

Public constructors
`DetailsFragment()`

Public functions
`ObjectAdapter!`	`getAdapter()` Returns the list of rows.
`BaseOnItemViewClickedListener!`	`getOnItemViewClickedListener()` Returns the item clicked listener.
`DetailsParallax!`	`getParallax()` Returns the `DetailsParallax` instance used by `DetailsFragmentBackgroundController` to configure parallax effect of background and control embedded video playback.
`RowsFragment!`	`getRowsFragment()` Gets embedded RowsFragment showing multiple rows for DetailsFragment.
`Unit`	`onCreate(savedInstanceState: Bundle!)` This function is deprecated.
`View?`	`onCreateView( inflater: LayoutInflater!, container: ViewGroup?, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`View`	`onInflateTitleView( inflater: LayoutInflater, parent: ViewGroup?, savedInstanceState: Bundle? )` Called by `installTitleView` to inflate title view.
`Unit`	`onStart()` This function is deprecated.
`Unit`	`onStop()` This function is deprecated.
`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 DetailsFragment.

Inherited Constants

From android.content.ComponentCallbacks2

`const Int`	`TRIM_MEMORY_BACKGROUND = 40`
`const Int`	`TRIM_MEMORY_COMPLETE = 80` This property is deprecated.
`const Int`	`TRIM_MEMORY_MODERATE = 60` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_LOW = 10` This property is deprecated.
`const Int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This property is deprecated.
`const Int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited functions

From androidx.leanback.app.BaseFragment

`ProgressBarManager!`	`getProgressBarManager()` Returns the `ProgressBarManager`.
`Unit`	`onViewCreated(view: View, savedInstanceState: Bundle?)` This function is deprecated.
`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.BrandedFragment

`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()` This function is deprecated.
`Unit`	`onResume()` This function is deprecated.
`Unit`	`onSaveInstanceState(outState: Bundle!)` This function is deprecated.
`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.app.Fragment

`Unit`	`dump( prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>! )` This function is deprecated.
`Boolean`	`equals(o: Any!)` This function is deprecated.
`Activity!`	`getActivity()` This function is deprecated.
`Boolean`	`getAllowEnterTransitionOverlap()` This function is deprecated.
`Boolean`	`getAllowReturnTransitionOverlap()` This function is deprecated.
`Bundle!`	`getArguments()` This function is deprecated.
`FragmentManager!`	`getChildFragmentManager()` This function is deprecated.
`Context!`	`getContext()` This function is deprecated.
`Transition!`	`getEnterTransition()` This function is deprecated.
`Transition!`	`getExitTransition()` This function is deprecated.
`FragmentManager!`	`getFragmentManager()` This function is deprecated.
`Any!`	`getHost()` This function is deprecated.
`Int`	`getId()` This function is deprecated.
`LayoutInflater!`	`getLayoutInflater()` This function is deprecated.
`LoaderManager!`	`getLoaderManager()` This function is deprecated.
`Fragment!`	`getParentFragment()` This function is deprecated.
`Transition!`	`getReenterTransition()` This function is deprecated.
`Resources!`	`getResources()` This function is deprecated.
`Boolean`	`getRetainInstance()` This function is deprecated.
`Transition!`	`getReturnTransition()` This function is deprecated.
`Transition!`	`getSharedElementEnterTransition()` This function is deprecated.
`Transition!`	`getSharedElementReturnTransition()` This function is deprecated.
`String!`	`getString(resId: Int)` This function is deprecated.
`String!`	`getTag()` This function is deprecated.
`Fragment!`	`getTargetFragment()` This function is deprecated.
`Int`	`getTargetRequestCode()` This function is deprecated.
`CharSequence!`	`getText(resId: Int)` This function is deprecated.
`Boolean`	`getUserVisibleHint()` This function is deprecated.
`View!`	`getView()` This function is deprecated.
`Int`	`hashCode()` This function is deprecated.
`java-static Fragment!`	`instantiate(context: Context!, fname: String!)` This function is deprecated.
`Boolean`	`isAdded()` This function is deprecated.
`Boolean`	`isDetached()` This function is deprecated.
`Boolean`	`isHidden()` This function is deprecated.
`Boolean`	`isInLayout()` This function is deprecated.
`Boolean`	`isRemoving()` This function is deprecated.
`Boolean`	`isResumed()` This function is deprecated.
`Boolean`	`isStateSaved()` This function is deprecated.
`Boolean`	`isVisible()` This function is deprecated.
`Unit`	`onActivityCreated(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)` This function is deprecated.
`Unit`	`onAttach(activity: Activity!)` This function is deprecated.
`Unit`	`onAttachFragment(childFragment: Fragment!)` This function is deprecated.
`Unit`	`onConfigurationChanged(newConfig: Configuration!)` This function is deprecated.
`Boolean`	`onContextItemSelected(item: MenuItem!)` This function is deprecated.
`Unit`	`onCreate(savedInstanceState: Bundle!)` This function is deprecated.
`Animator!`	`onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` This function is deprecated.
`Unit`	`onCreateContextMenu( menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo! )` This function is deprecated.
`Unit`	`onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!)` This function is deprecated.
`Unit`	`onDestroy()` This function is deprecated.
`Unit`	`onDestroyOptionsMenu()` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`Unit`	`onDetach()` This function is deprecated.
`LayoutInflater!`	`onGetLayoutInflater(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onHiddenChanged(hidden: Boolean)` This function is deprecated.
`Unit`	`onInflate( activity: Activity!, attrs: AttributeSet!, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onLowMemory()` This function is deprecated.
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` This function is deprecated.
`Boolean`	`onOptionsItemSelected(item: MenuItem!)` This function is deprecated.
`Unit`	`onOptionsMenuClosed(menu: Menu!)` This function is deprecated.
`Unit`	`onPause()` This function is deprecated.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` This function is deprecated.
`Unit`	`onPrepareOptionsMenu(menu: Menu!)` This function is deprecated.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>!, grantResults: IntArray! )` This function is deprecated.
`Unit`	`onResume()` This function is deprecated.
`Unit`	`onSaveInstanceState(outState: Bundle!)` This function is deprecated.
`Unit`	`onStart()` This function is deprecated.
`Unit`	`onTrimMemory(level: Int)` This function is deprecated.
`Unit`	`onViewCreated(view: View!, savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onViewStateRestored(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`postponeEnterTransition()` This function is deprecated.
`Unit`	`registerForContextMenu(view: View!)` This function is deprecated.
`Unit`	`requestPermissions(permissions: Array<String!>!, requestCode: Int)` This function is deprecated.
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setArguments(args: Bundle!)` This function is deprecated.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setExitTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function is deprecated.
`Unit`	`setInitialSavedState(state: Fragment.SavedState!)` This function is deprecated.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` This function is deprecated.
`Unit`	`setReenterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated.
`Unit`	`setReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setTargetFragment(fragment: Fragment!, requestCode: Int)` This function is deprecated.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String!)` This function is deprecated.
`Unit`	`startActivity(intent: Intent!)` This function is deprecated.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int)` This function is deprecated.
`Unit`	`startIntentSenderForResult( intent: IntentSender!, requestCode: Int, fillInIntent: Intent!, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle! )` This function is deprecated.
`Unit`	`startPostponedEnterTransition()` This function is deprecated.
`String!`	`toString()` This function is deprecated.
`Unit`	`unregisterForContextMenu(view: View!)` This function is deprecated.

Public constructors

DetailsFragment

Added in 1.1.0

Deprecated in 1.1.0

DetailsFragment()

Public functions

getAdapter

Added in 1.1.0

Deprecated in 1.1.0

fun getAdapter(): ObjectAdapter!

Returns the list of rows.

getOnItemViewClickedListener

Added in 1.1.0

Deprecated in 1.1.0

fun getOnItemViewClickedListener(): BaseOnItemViewClickedListener!

Returns the item clicked listener.

getParallax

Added in 1.1.0

Deprecated in 1.1.0

fun getParallax(): DetailsParallax!

Returns the DetailsParallax instance used by DetailsFragmentBackgroundController 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 DetailsFragment.

getRowsFragment

Added in 1.1.0

Deprecated in 1.1.0

fun getRowsFragment(): RowsFragment!

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

Returns
`RowsFragment!`	Embedded RowsFragment showing multiple rows for DetailsFragment.

onCreate

fun onCreate(savedInstanceState: Bundle!): Unit

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

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

onDestroyView

fun onDestroyView(): Unit

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

onStop

Added in 1.1.0

Deprecated in 1.1.0

fun onStop(): Unit

Added in 1.1.0

Deprecated in 1.1.0

fun setAdapter(adapter: ObjectAdapter!): Unit

Sets the list of rows for the fragment.

Added in 1.1.0

Deprecated in 1.1.0

fun setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener!): Unit

Sets an item clicked listener.

Added in 1.1.0

Deprecated in 1.1.0

fun setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener!): Unit

Sets an item selection listener.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

fun setSelectedPosition(position: Int): Unit

Sets the selected row position with smooth animation.

setSelectedPosition

Added in 1.1.0

Deprecated 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

Deprecated 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

Deprecated 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

Deprecated 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

Deprecated 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 DetailsFragment. For example how a row is aligned in details Fragment. The default implementation invokes setupDetailsOverviewRowPresenter