belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
BrowseSupportFragment
public
class
BrowseSupportFragment
extends BaseSupportFragment
java.lang.Object | ||||
↳ | android.support.v4.app.Fragment | |||
↳ | android.support.v17.leanback.app.BrandedSupportFragment | |||
↳ | android.support.v17.leanback.app.BaseSupportFragment | |||
↳ | android.support.v17.leanback.app.BrowseSupportFragment |
A fragment for creating Leanback browse screens. It is composed of a RowsSupportFragment and a HeadersSupportFragment.
A BrowseSupportFragment renders the elements of its ObjectAdapter
as a set
of rows in a vertical list. The elements in this adapter must be subclasses
of Row
.
The HeadersSupportFragment can be set to be either shown or hidden by default, or
may be disabled entirely. See setHeadersState(int)
for details.
By default the BrowseSupportFragment includes support for returning to the headers
when the user presses Back. For Activities that customize onBackPressed()
, you must disable this default Back key support by
calling setHeadersTransitionOnBackEnabled(boolean)
with false and
use BrowseSupportFragment.BrowseTransitionListener
and
startHeadersTransition(boolean)
.
The recommended theme to use with a BrowseSupportFragment is
Theme_Leanback_Browse
.
Summary
Nested classes | |
---|---|
class |
BrowseSupportFragment.BrowseTransitionListener
Listener for transitions between browse headers and rows. |
class |
BrowseSupportFragment.FragmentFactory<T extends Fragment>
Factory class responsible for creating fragment given the current item. |
interface |
BrowseSupportFragment.FragmentHost
Possible set of actions that |
class |
BrowseSupportFragment.ListRowFragmentFactory
FragmentFactory implementation for |
class |
BrowseSupportFragment.MainFragmentAdapter<T extends Fragment>
Interface that defines the interaction between |
interface |
BrowseSupportFragment.MainFragmentAdapterProvider
Interface to be implemented by all fragments for providing an instance of
|
class |
BrowseSupportFragment.MainFragmentAdapterRegistry
Registry class maintaining the mapping of |
class |
BrowseSupportFragment.MainFragmentRowsAdapter<T extends Fragment>
This is used to pass information to |
interface |
BrowseSupportFragment.MainFragmentRowsAdapterProvider
Interface to be implemented by |
Constants | |
---|---|
int |
HEADERS_DISABLED
The headers fragment is disabled and will never be shown. |
int |
HEADERS_ENABLED
The headers fragment is enabled and shown by default. |
int |
HEADERS_HIDDEN
The headers fragment is enabled and hidden by default. |
Public constructors | |
---|---|
BrowseSupportFragment()
|
Public methods | |
---|---|
static
Bundle
|
createArgs(Bundle args, String title, int headersState)
Creates arguments for a browse fragment. |
void
|
enableMainFragmentScaling(boolean enable)
Enables scaling of main fragment when headers are present. |
void
|
enableRowScaling(boolean enable)
This method was deprecated
in API level 24.1.0.
use |
ObjectAdapter
|
getAdapter()
Returns the adapter containing the rows for the fragment. |
int
|
getBrandColor()
Returns the brand color for the browse fragment. |
int
|
getHeadersState()
Returns the state of the headers column in the browse fragment. |
HeadersSupportFragment
|
getHeadersSupportFragment()
Get currently bound HeadersSupportFragment or null if HeadersSupportFragment has not been created yet. |
Fragment
|
getMainFragment()
|
final
BrowseSupportFragment.MainFragmentAdapterRegistry
|
getMainFragmentRegistry()
|
OnItemViewClickedListener
|
getOnItemViewClickedListener()
Returns the item Clicked listener. |
OnItemViewSelectedListener
|
getOnItemViewSelectedListener()
Returns an item selection listener. |
RowsSupportFragment
|
getRowsSupportFragment()
Get RowsSupportFragment if it's bound to BrowseSupportFragment or null if either BrowseSupportFragment has not been created yet or a different fragment is bound to it. |
int
|
getSelectedPosition()
Gets position of currently selected row. |
RowPresenter.ViewHolder
|
getSelectedRowViewHolder()
|
final
boolean
|
isHeadersTransitionOnBackEnabled()
Returns true if headers transition on back key support is enabled. |
boolean
|
isInHeadersTransition()
Returns true if the headers transition is currently running. |
boolean
|
isShowingHeaders()
Returns true if headers are shown. |
void
|
onCreate(Bundle savedInstanceState)
Called to do initial creation of a fragment. |
HeadersSupportFragment
|
onCreateHeadersSupportFragment()
Creates a new |
View
|
onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
Called to have the fragment instantiate its user interface view. |
void
|
onDestroy()
Called when the fragment is no longer in use. |
void
|
onDestroyView()
Called when the view previously created by |
void
|
onSaveInstanceState(Bundle outState)
Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. |
void
|
onStart()
Called when the Fragment is visible to the user. |
void
|
setAdapter(ObjectAdapter adapter)
Sets the adapter containing the rows for the fragment. |
void
|
setBrandColor(int color)
Sets the brand color for the browse fragment. |
void
|
setBrowseTransitionListener(BrowseSupportFragment.BrowseTransitionListener listener)
Sets a listener for browse fragment transitions. |
void
|
setHeaderPresenterSelector(PresenterSelector headerPresenterSelector)
Sets the |
void
|
setHeadersState(int headersState)
Sets the state for the headers column in the browse fragment. |
final
void
|
setHeadersTransitionOnBackEnabled(boolean headersBackStackEnabled)
Enables/disables headers transition on back key support. |
void
|
setOnItemViewClickedListener(OnItemViewClickedListener listener)
Sets an item clicked listener on the fragment. |
void
|
setOnItemViewSelectedListener(OnItemViewSelectedListener listener)
Sets an item selection listener. |
void
|
setSelectedPosition(int position)
Sets the selected row position with smooth animation. |
void
|
setSelectedPosition(int rowPosition, boolean smooth, Presenter.ViewHolderTask rowHolderTask)
Selects a Row and perform an optional task on the Row. |
void
|
setSelectedPosition(int position, boolean smooth)
Sets the selected row position. |
void
|
startHeadersTransition(boolean withHeaders)
Starts a headers transition. |
Protected methods | |
---|---|
Object
|
createEntranceTransition()
Create entrance transition. |
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
|
runEntranceTransition(Object entranceTransition)
Run entrance transition. |
Inherited methods | |
---|---|
![]()
android.support.v17.leanback.app.BaseSupportFragment
|