DetailsFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

public class DetailsFragment extends BaseFragment

java.lang.Object
↳	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 methods
`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.
`void`	`onCreate(Bundle savedInstanceState)` This method is deprecated.
`@Nullable View`	`onCreateView( LayoutInflater inflater, @Nullable ViewGroup container, Bundle savedInstanceState )` This method is deprecated.
`void`	`onDestroyView()` This method is deprecated.
`@NonNull View`	`onInflateTitleView( @NonNull LayoutInflater inflater, @Nullable ViewGroup parent, @Nullable Bundle savedInstanceState )` Called by `installTitleView` to inflate title view.
`void`	`onStart()` This method is deprecated.
`void`	`onStop()` This method is deprecated.
`void`	`setAdapter(ObjectAdapter adapter)` Sets the list of rows for the fragment.
`void`	`setOnItemViewClickedListener(BaseOnItemViewClickedListener listener)` Sets an item clicked listener.
`void`	`setOnItemViewSelectedListener(BaseOnItemViewSelectedListener listener)` Sets an item selection listener.
`void`	`setSelectedPosition(int position)` Sets the selected row position with smooth animation.
`void`	`setSelectedPosition(int position, boolean smooth)` Sets the selected row position.

Protected methods
`Object`	`createEntranceTransition()` Create entrance transition.
`View`	`inflateTitle( LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState )` This method is deprecated. override `onInflateTitleView` instead.
`void`	`onEntranceTransitionEnd()` Callback when entrance transition is ended.
`void`	`onEntranceTransitionPrepare()` Callback when entrance transition is prepared.
`void`	`onEntranceTransitionStart()` Callback when entrance transition is started.
`void`	`onSetDetailsOverviewRowStatus( FullWidthDetailsOverviewRowPresenter presenter, FullWidthDetailsOverviewRowPresenter.ViewHolder viewHolder, int adapterPosition, int selectedPosition, int selectedSubPosition )` Called to change DetailsOverviewRow view status when current selected row position or selected sub position changed.
`void`	`onSetRowStatus( RowPresenter presenter, RowPresenter.ViewHolder viewHolder, int adapterPosition, int selectedPosition, int selectedSubPosition )` Called on every visible row to change view status when current selected row position or selected sub position changed.
`void`	`runEntranceTransition(Object entranceTransition)` Run entrance transition.
`void`	`setupDetailsOverviewRowPresenter( FullWidthDetailsOverviewRowPresenter presenter )` Called to setup `FullWidthDetailsOverviewRowPresenter`.
`void`	`setupPresenter(Presenter rowPresenter)` 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

`static final int`	`TRIM_MEMORY_BACKGROUND = 40`
`static final int`	`TRIM_MEMORY_COMPLETE = 80` This field is deprecated.
`static final int`	`TRIM_MEMORY_MODERATE = 60` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_LOW = 10` This field is deprecated.
`static final int`	`TRIM_MEMORY_RUNNING_MODERATE = 5` This field is deprecated.
`static final int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited methods

From androidx.leanback.app.BaseFragment

`final ProgressBarManager`	`getProgressBarManager()` Returns the `ProgressBarManager`.
`void`	`onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState)` This method is deprecated.
`void`	`prepareEntranceTransition()` Enables entrance transition.
`void`	`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

`@Nullable Drawable`	`getBadgeDrawable()` Returns the badge drawable used in the fragment title.
`int`	`getSearchAffordanceColor()` Returns the color used to draw the search affordance.
`@Nullable SearchOrbView.Colors`	`getSearchAffordanceColors()` Returns the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`@Nullable CharSequence`	`getTitle()` Returns the title text for the fragment.
`@Nullable View`	`getTitleView()` Returns the view that implements `TitleViewAdapter.Provider`.
`@Nullable TitleViewAdapter`	`getTitleViewAdapter()` Returns the `TitleViewAdapter` implemented by title view.
`void`	`installTitleView( @NonNull LayoutInflater inflater, @NonNull ViewGroup parent, @Nullable Bundle savedInstanceState )` Inflate title view and add to parent.
`final boolean`	`isShowingTitle()` Returns true/false to indicate the visibility of TitleView.
`void`	`onPause()` This method is deprecated.
`void`	`onResume()` This method is deprecated.
`void`	`onSaveInstanceState(Bundle outState)` This method is deprecated.
`void`	`setBadgeDrawable(@Nullable Drawable drawable)` Sets the drawable displayed in the fragment title.
`void`	`setOnSearchClickedListener(@Nullable View.OnClickListener listener)` Sets a click listener for the search affordance.
`void`	`setSearchAffordanceColor(int color)` Sets the color used to draw the search affordance.
`void`	`setSearchAffordanceColors(@NonNull SearchOrbView.Colors colors)` Sets the `androidx.leanback.widget.SearchOrbView.Colors` used to draw the search affordance.
`void`	`setTitle(@Nullable CharSequence title)` Sets title text for the fragment.
`void`	`setTitleView(@Nullable View titleView)` Sets the view that implemented `TitleViewAdapter`.
`void`	`showTitle(int flags)` Changes title view's components visibility and shows title.
`void`	`showTitle(boolean show)` Shows or hides the title view.

From android.app.Fragment

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

Public constructors

DetailsFragment

Added in 1.1.0

Deprecated in 1.1.0

public DetailsFragment()

Public methods

getAdapter

Added in 1.1.0

Deprecated in 1.1.0

public ObjectAdapter getAdapter()

Returns the list of rows.

getOnItemViewClickedListener

Added in 1.1.0

Deprecated in 1.1.0

public BaseOnItemViewClickedListener getOnItemViewClickedListener()

Returns the item clicked listener.

getParallax

Added in 1.1.0

Deprecated in 1.1.0

public DetailsParallax getParallax()

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

public RowsFragment getRowsFragment()

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

public void onCreate(Bundle savedInstanceState)

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

public @Nullable View onCreateView(
    LayoutInflater inflater,
    @Nullable ViewGroup container,
    Bundle savedInstanceState
)

onDestroyView

public void onDestroyView()

onInflateTitleView

public @NonNull View onInflateTitleView(
    @NonNull LayoutInflater inflater,
    @Nullable ViewGroup parent,
    @Nullable Bundle savedInstanceState
)

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
`@NonNull LayoutInflater inflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`@Nullable ViewGroup parent`	Parent of title view.
`@Nullable Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

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

onStart

public void onStart()

onStop

Added in 1.1.0

Deprecated in 1.1.0

public void onStop()

Added in 1.1.0

Deprecated in 1.1.0

public void setAdapter(ObjectAdapter adapter)

Sets the list of rows for the fragment.

Added in 1.1.0

Deprecated in 1.1.0

public void setOnItemViewClickedListener(BaseOnItemViewClickedListener listener)

Sets an item clicked listener.

Added in 1.1.0

Deprecated in 1.1.0

public void setOnItemViewSelectedListener(BaseOnItemViewSelectedListener listener)

Sets an item selection listener.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

public void setSelectedPosition(int position)

Sets the selected row position with smooth animation.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

public void setSelectedPosition(int position, boolean smooth)

Sets the selected row position.

Protected methods

createEntranceTransition

protected Object createEntranceTransition()

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 View inflateTitle(
    LayoutInflater inflater,
    ViewGroup parent,
    Bundle savedInstanceState
)

onEntranceTransitionEnd

protected void onEntranceTransitionEnd()

Callback when entrance transition is ended.

onEntranceTransitionPrepare

protected void onEntranceTransitionPrepare()

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

onEntranceTransitionStart

protected void onEntranceTransitionStart()

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 void onSetDetailsOverviewRowStatus(
    FullWidthDetailsOverviewRowPresenter presenter,
    FullWidthDetailsOverviewRowPresenter.ViewHolder viewHolder,
    int adapterPosition,
    int selectedPosition,
    int selectedSubPosition
)

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
`FullWidthDetailsOverviewRowPresenter presenter`	The presenter used to create row ViewHolder.
`FullWidthDetailsOverviewRowPresenter.ViewHolder viewHolder`	The visible (attached) row ViewHolder, note that it may or may not be selected.
`int adapterPosition`	The adapter position of viewHolder inside adapter.
`int selectedPosition`	The adapter position of currently selected row.
`int selectedSubPosition`	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 void onSetRowStatus(
    RowPresenter presenter,
    RowPresenter.ViewHolder viewHolder,
    int adapterPosition,
    int selectedPosition,
    int selectedSubPosition
)

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
`RowPresenter presenter`	The presenter used to create row ViewHolder.
`RowPresenter.ViewHolder viewHolder`	The visible (attached) row ViewHolder, note that it may or may not be selected.
`int adapterPosition`	The adapter position of viewHolder inside adapter.
`int selectedPosition`	The adapter position of currently selected row.
`int selectedSubPosition`	The sub position within currently selected row. This is used When a row has multiple alignment positions.

runEntranceTransition

protected void runEntranceTransition(Object entranceTransition)

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 void setupDetailsOverviewRowPresenter(
    FullWidthDetailsOverviewRowPresenter presenter
)

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 void setupPresenter(Presenter rowPresenter)

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