added in version 1.0.0

androidx.leanback.app

Support classes providing high level Leanback user interface building blocks.

Leanback fragments are available both as support fragments (subclassed from androidx.fragment.app.Fragment) and as platform fragments (subclassed from android.app.Fragment). A few of the most commonly used leanback fragments are described here.

A BrowseSupportFragment by default operates in the "row" mode. It includes an optional “fastlane” navigation side panel and a list of rows, with one-to-one correspondance between each header in the fastlane and a row. The application supplies the ObjectAdapter containing the list of rows and a PresenterSelector of row presenters.

A BrowseSupportFragment also works in a "page" mode when each row of fastlane is mapped to a fragment that the app registers in getMainFragmentRegistry().

A DetailsSupportFragment will typically consist of a large overview of an item at the top, some actions that a user can perform, and possibly rows of additional or related items. The content for this fragment is specified in the same way as for the BrowseSupportFragment, with the convention that the first element in the ObjectAdapter corresponds to the overview row. The DetailsOverviewRow and FullWidthDetailsOverviewRowPresenter provide a default template for this row.

A PlaybackSupportFragment or its subclass VideoSupportFragment hosts PlaybackTransportControlGlue or PlaybackBannerControlGlue with a Leanback look and feel. It is recommended to use an instance of PlaybackTransportControlGlue. This helper implements a standard behavior for user interaction with the most commonly used controls as well as video scrubbing.

A SearchSupportFragment allows the developer to accept a query from a user and display the results using the familiar list rows.

A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions.

Interfaces

BrowseFragment.FragmentHost This interface was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.MainFragmentAdapterProvider This interface was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.MainFragmentRowsAdapterProvider This interface was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseSupportFragment.FragmentHost Possible set of actions that BrowseSupportFragment exposes to clients. 
BrowseSupportFragment.MainFragmentAdapterProvider Interface to be implemented by all fragments for providing an instance of BrowseSupportFragment.MainFragmentAdapter
BrowseSupportFragment.MainFragmentRowsAdapterProvider Interface to be implemented by RowsSupportFragment and its subclasses for providing an instance of BrowseSupportFragment.MainFragmentRowsAdapter
HeadersFragment.OnHeaderClickedListener This interface was deprecated in API level 1.0.0. use HeadersSupportFragment  
HeadersFragment.OnHeaderViewSelectedListener This interface was deprecated in API level 1.0.0. use HeadersSupportFragment  
HeadersSupportFragment.OnHeaderClickedListener Interface definition for a callback to be invoked when a header item is clicked. 
HeadersSupportFragment.OnHeaderViewSelectedListener Interface definition for a callback to be invoked when a header item is selected. 
SearchFragment.SearchResultProvider Search API to be provided by the application. 
SearchSupportFragment.SearchResultProvider Search API to be provided by the application. 

Classes

BackgroundManager Supports background image continuity between multiple Activities. 
BaseFragment This class was deprecated in API level 1.0.0. use BaseSupportFragment  
BaseSupportFragment Base class for leanback Fragments. 
BrandedFragment This class was deprecated in API level 1.0.0. use BrandedSupportFragment  
BrandedSupportFragment Fragment class for managing search and branding using a view that implements TitleViewAdapter.Provider
BrowseFragment This class was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.BrowseTransitionListener This class was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.FragmentFactory<T extends Fragment> This class was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.ListRowFragmentFactory This class was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.MainFragmentAdapter<T extends Fragment> This class was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.MainFragmentAdapterRegistry This class was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseFragment.MainFragmentRowsAdapter<T extends Fragment> This class was deprecated in API level 1.0.0. use BrowseSupportFragment  
BrowseSupportFragment A fragment for creating Leanback browse screens. 
BrowseSupportFragment.BrowseTransitionListener Listener for transitions between browse headers and rows. 
BrowseSupportFragment.FragmentFactory<T extends Fragment> Factory class responsible for creating fragment given the current item. 
BrowseSupportFragment.ListRowFragmentFactory FragmentFactory implementation for ListRow
BrowseSupportFragment.MainFragmentAdapter<T extends Fragment> Interface that defines the interaction between BrowseSupportFragment and its main content fragment. 
BrowseSupportFragment.MainFragmentAdapterRegistry Registry class maintaining the mapping of Row subclasses to BrowseSupportFragment.FragmentFactory
BrowseSupportFragment.MainFragmentRowsAdapter<T extends Fragment> This is used to pass information to RowsSupportFragment or its subclasses. 
DetailsFragment This class was deprecated in API level 1.0.0. use DetailsSupportFragment  
DetailsFragmentBackgroundController This class was deprecated in API level 1.0.0. use DetailsSupportFragmentBackgroundController  
DetailsSupportFragment A fragment for creating Leanback details screens. 
DetailsSupportFragmentBackgroundController Controller for DetailsSupportFragment parallax background and embedded video play. 
ErrorFragment This class was deprecated in API level 1.0.0. use ErrorSupportFragment  
ErrorSupportFragment A fragment for displaying an error indication. 
GuidedStepFragment This class was deprecated in API level 1.0.0. use GuidedStepSupportFragment  
GuidedStepSupportFragment A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions. 
HeadersFragment This class was deprecated in API level 1.0.0. use HeadersSupportFragment  
HeadersSupportFragment An fragment containing a list of row headers. 
OnboardingFragment This class was deprecated in API level 1.0.0. use OnboardingSupportFragment  
OnboardingSupportFragment An OnboardingSupportFragment provides a common and simple way to build onboarding screen for applications. 
PlaybackFragment This class was deprecated in API level 1.0.0. use PlaybackSupportFragment  
PlaybackFragmentGlueHost This class was deprecated in API level 1.0.0. use PlaybackSupportFragmentGlueHost  
PlaybackSupportFragment A fragment for displaying playback controls and related content. 
PlaybackSupportFragmentGlueHost PlaybackGlueHost implementation the interaction between this class and PlaybackSupportFragment
ProgressBarManager Manager for showing/hiding progress bar widget. 
RowsFragment This class was deprecated in API level 1.0.0. use RowsSupportFragment  
RowsFragment.MainFragmentAdapter  
RowsFragment.MainFragmentRowsAdapter This class was deprecated in API level 1.0.0. use RowsSupportFragment  
RowsSupportFragment An ordered set of rows of leanback widgets. 
RowsSupportFragment.MainFragmentAdapter  
RowsSupportFragment.MainFragmentRowsAdapter The adapter that RowsSupportFragment implements BrowseSupportFragment.MainFragmentRowsAdapter. 
SearchFragment This class was deprecated in API level 1.0.0. use SearchSupportFragment  
SearchSupportFragment A fragment to handle searches. 
VerticalGridFragment This class was deprecated in API level 1.0.0. use VerticalGridSupportFragment  
VerticalGridSupportFragment A fragment for creating leanback vertical grids. 
VideoFragment This class was deprecated in API level 1.0.0. use VideoSupportFragment  
VideoFragmentGlueHost This class was deprecated in API level 1.0.0. use VideoSupportFragmentGlueHost  
VideoSupportFragment Subclass of PlaybackSupportFragment that is responsible for providing a SurfaceView and rendering video. 
VideoSupportFragmentGlueHost PlaybackGlueHost implementation the interaction between PlaybackGlue and VideoSupportFragment