Skip to content

Most visited

Recently visited

navigation
added in version 22.0.0

android.support.v17.leanback.app

Support classes providing high level Leanback user interface building blocks: fragments and helpers.

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

A BrowseFragment 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 DetailsFragment 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 BrowseFragment, with the convention that the first element in the ObjectAdapter corresponds to the overview row. The DetailsOverviewRow and DetailsOverviewRowPresenter provide a default template for this row.

A PlaybackOverlayFragment implements standard playback transport controls with a Leanback look and feel. It is recommended to use an instance of the PlaybackControlGlue with the PlaybackOverlayFragment. This helper implements a standard behavior for user interaction with the most commonly used controls such as fast forward and rewind.

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

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

Interfaces

BrowseFragment.FragmentHost Possible set of actions that BrowseFragment exposes to clients. 
BrowseFragment.MainFragmentAdapterProvider Interface to be implemented by all fragments for providing an instance of BrowseFragment.MainFragmentAdapter
BrowseFragment.MainFragmentRowsAdapterProvider Interface to be implemented by RowsFragment and its subclasses for providing an instance of BrowseFragment.MainFragmentRowsAdapter
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 Interface definition for a callback to be invoked when a header item is clicked. 
HeadersFragment.OnHeaderViewSelectedListener Interface definition for a callback to be invoked when a header item is selected. 
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. 
PlaybackControlGlue.InputEventHandler This interface was deprecated in API level 25.1.0. Use setOnKeyInterceptListener(View.OnKeyListener).  
PlaybackOverlayFragment.InputEventHandler  
PlaybackOverlaySupportFragment.InputEventHandler  
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. 
BrandedFragment Fragment class for managing search and branding using a view that implements TitleViewAdapter.Provider
BrandedSupportFragment Fragment class for managing search and branding using a view that implements TitleViewAdapter.Provider
BrowseFragment A fragment for creating Leanback browse screens. 
BrowseFragment.BrowseTransitionListener Listener for transitions between browse headers and rows. 
BrowseFragment.FragmentFactory<T extends Fragment> Factory class responsible for creating fragment given the current item. 
BrowseFragment.ListRowFragmentFactory FragmentFactory implementation for ListRow
BrowseFragment.MainFragmentAdapter<T extends Fragment> Interface that defines the interaction between BrowseFragment and its main content fragment. 
BrowseFragment.MainFragmentAdapterRegistry Registry class maintaining the mapping of Row subclasses to BrowseFragment.FragmentFactory
BrowseFragment.MainFragmentRowsAdapter<T extends Fragment> This is used to pass information to RowsFragment or its subclasses. 
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 A fragment for creating Leanback details screens. 
DetailsFragmentBackgroundController Controller for DetailsFragment parallax background and embedded video play. 
DetailsSupportFragment A fragment for creating Leanback details screens. 
DetailsSupportFragmentBackgroundController Controller for DetailsSupportFragment parallax background and embedded video play. 
ErrorFragment A fragment for displaying an error indication. 
ErrorSupportFragment A fragment for displaying an error indication. 
GuidedStepFragment A GuidedStepFragment is used to guide the user through a decision or series of decisions. 
GuidedStepSupportFragment A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions. 
HeadersFragment An fragment containing a list of row headers. 
HeadersSupportFragment An fragment containing a list of row headers. 
MediaControllerGlue This class was deprecated in API level 25.1.0. Use MediaControllerGlue.  
OnboardingFragment An OnboardingFragment provides a common and simple way to build onboarding screen for applications. 
OnboardingSupportFragment An OnboardingSupportFragment provides a common and simple way to build onboarding screen for applications. 
PlaybackControlGlue This class was deprecated in API level 25.1.0. Use PlaybackControlGlue  
PlaybackControlSupportGlue This class was deprecated in API level 25.1.0. Use PlaybackControlGlue and PlaybackSupportFragmentGlueHost for PlaybackSupportFragment.  
PlaybackFragment A fragment for displaying playback controls and related content. 
PlaybackFragmentGlueHost PlaybackGlueHost implementation the interaction between this class and PlaybackFragment
PlaybackOverlayFragment This class was deprecated in API level 25.1.0. Use PlaybackFragment.  
PlaybackOverlayFragment.OnFadeCompleteListener Listener allowing the application to receive notification of fade in and/or fade out completion events. 
PlaybackOverlaySupportFragment This class was deprecated in API level 25.1.0. Use PlaybackSupportFragment.  
PlaybackOverlaySupportFragment.OnFadeCompleteListener Listener allowing the application to receive notification of fade in and/or fade out completion events. 
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 An ordered set of rows of leanback widgets. 
RowsFragment.MainFragmentAdapter  
RowsFragment.MainFragmentRowsAdapter  
RowsSupportFragment An ordered set of rows of leanback widgets. 
RowsSupportFragment.MainFragmentAdapter  
RowsSupportFragment.MainFragmentRowsAdapter  
SearchFragment A fragment to handle searches. 
SearchSupportFragment A fragment to handle searches. 
VerticalGridFragment A fragment for creating leanback vertical grids. 
VerticalGridSupportFragment A fragment for creating leanback vertical grids. 
VideoFragment Subclass of PlaybackFragment that is responsible for providing a SurfaceView and rendering video. 
VideoFragmentGlueHost PlaybackGlueHost implementation the interaction between PlaybackGlue and VideoFragment
VideoSupportFragment Subclass of PlaybackSupportFragment that is responsible for providing a SurfaceView and rendering video. 
VideoSupportFragmentGlueHost PlaybackGlueHost implementation the interaction between PlaybackGlue and VideoSupportFragment
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.