BrowseFragment
open classBrowseFragment: BaseFragment
kotlin.Any | ||||
↳ | android.app.Fragment | |||
↳ | androidx.leanback.app.BrandedFragment | |||
↳ | androidx.leanback.app.BaseFragment | |||
↳ | androidx.leanback.app.BrowseFragment |
A fragment for creating Leanback browse screens. It is composed of a RowsFragment and a HeadersFragment.
A BrowseFragment 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 HeadersFragment can be set to be either shown or hidden by default, or may be disabled entirely. See setHeadersState
for details.
By default the BrowseFragment includes support for returning to the headers when the user presses Back. For Activities that customize
, you must disable this default Back key support by calling setHeadersTransitionOnBackEnabled(boolean)
with false and use BrowseFragment.BrowseTransitionListener
and startHeadersTransition(boolean)
.
The recommended theme to use with a BrowseFragment is androidx.leanback.R.style#Theme_Leanback_Browse.
Summary
Nested classes |
|
---|---|
open |
Listener for transitions between browse headers and rows. |
abstract |
Factory class responsible for creating fragment given the current item. |
abstract |
Possible set of actions that |
open |
FragmentFactory implementation for |
open |
Interface that defines the interaction between |
abstract |
Interface to be implemented by all fragments for providing an instance of |
Registry class maintaining the mapping of |
|
open |
This is used to pass information to |
abstract |
Interface to be implemented by |
Constants |
|
---|---|
static Int |
The headers fragment is disabled and will never be shown. |
static Int |
The headers fragment is enabled and shown by default. |
static Int |
The headers fragment is enabled and hidden by default. |
Public constructors |
|
---|---|
<init>() A fragment for creating Leanback browse screens. |
Public methods |
|
---|---|
open static Bundle! |
createArgs(args: Bundle!, title: String!, headersState: Int) Creates arguments for a browse fragment. |
open Unit |
enableMainFragmentScaling(enable: Boolean) Enables scaling of main fragment when headers are present. |
open Unit |
enableRowScaling(enable: Boolean) |
open ObjectAdapter! |
Returns the adapter containing the rows for the fragment. |
open Int |
Returns the brand color for the browse fragment. |
open HeadersFragment! |
Get currently bound HeadersFragment or null if HeadersFragment has not been created yet. |
open Int |
Returns the state of the headers column in the browse fragment. |
open Fragment! | |
BrowseFragment.MainFragmentAdapterRegistry! | |
open OnItemViewClickedListener! |
Returns the item Clicked listener. |
open OnItemViewSelectedListener! |
Returns an item selection listener. |
open RowsFragment! |
Get RowsFragment if it's bound to BrowseFragment or null if either BrowseFragment has not been created yet or a different fragment is bound to it. |
open Int |
Gets position of currently selected row. |
open RowPresenter.ViewHolder! | |
Boolean |
Returns true if headers transition on back key support is enabled. |
open Boolean |
Returns true if the headers transition is currently running. |
open Boolean |
Returns true if headers are shown. |
open Unit | |
open HeadersFragment! |
Creates a new |
open View! |
onCreateView(inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle!) |
open Unit | |
open Unit | |
open Unit |
onSaveInstanceState(outState: Bundle!) |
open Unit |
onStart() |
open Unit |
onStop() |
open Unit |
setAdapter(adapter: ObjectAdapter!) Sets the adapter containing the rows for the fragment. |
open Unit |
setBrandColor(color: Int) Sets the brand color for the browse fragment. |
open Unit |
Sets a listener for browse fragment transitions. |
open Unit |
setHeaderPresenterSelector(headerPresenterSelector: PresenterSelector!) Sets the |
open Unit |
setHeadersState(headersState: Int) Sets the state for the headers column in the browse fragment. |
Unit |
setHeadersTransitionOnBackEnabled(headersBackStackEnabled: Boolean) Enables/disables headers transition on back key support. |
open Unit |
Sets an item clicked listener on the fragment. |
open Unit |
Sets an item selection listener. |
open Unit |
setSelectedPosition(position: Int) Sets the selected row position with smooth animation. |
open Unit |
setSelectedPosition(position: Int, smooth: Boolean) Sets the selected row position. |
open Unit |
setSelectedPosition(rowPosition: Int, smooth: Boolean, rowHolderTask: Presenter.ViewHolderTask!) Selects a Row and perform an optional task on the Row. |
open Unit |
startHeadersTransition(withHeaders: Boolean) Starts a headers transition. |
Protected methods |
|
---|---|
open Any! | |
open Unit | |
open Unit | |
open Unit | |
open Unit |
runEntranceTransition(entranceTransition: Any!) |
Inherited functions |
|
---|---|
Constants
HEADERS_DISABLED
static val HEADERS_DISABLED: Int
The headers fragment is disabled and will never be shown.
Value: 3
HEADERS_ENABLED
static val HEADERS_ENABLED: Int
The headers fragment is enabled and shown by default.
Value: 1
HEADERS_HIDDEN
static val HEADERS_HIDDEN: Int
The headers fragment is enabled and hidden by default.
Value: 2
Public constructors
<init>
BrowseFragment()
Deprecated: use BrowseSupportFragment
A fragment for creating Leanback browse screens. It is composed of a RowsFragment and a HeadersFragment.
A BrowseFragment 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 HeadersFragment can be set to be either shown or hidden by default, or may be disabled entirely. See setHeadersState
for details.
By default the BrowseFragment includes support for returning to the headers when the user presses Back. For Activities that customize
, you must disable this default Back key support by calling setHeadersTransitionOnBackEnabled(boolean)
with false and use BrowseFragment.BrowseTransitionListener
and startHeadersTransition(boolean)
.
The recommended theme to use with a BrowseFragment is androidx.leanback.R.style#Theme_Leanback_Browse.
Public methods
createArgs
open static fun createArgs(args: Bundle!, title: String!, headersState: Int): Bundle!
Creates arguments for a browse fragment.
Parameters | |
---|---|
args |
Bundle!: The Bundle to place arguments into, or null if the method should return a new Bundle. |
title |
Bundle!: The title of the BrowseFragment. |
headersState |
Bundle!: The initial state of the headers of the BrowseFragment. Must be one of HEADERS_ENABLED , , or HEADERS_DISABLED . |
Return | |
---|---|
Bundle!: A Bundle with the given arguments for creating a BrowseFragment. |
enableMainFragmentScaling
open fun enableMainFragmentScaling(enable: Boolean): Unit
Enables scaling of main fragment when headers are present. For the page/row fragment, scaling is enabled only when both this method and MainFragmentAdapter#isScalingEnabled()
are enabled.
Parameters | |
---|---|
enable |
Boolean: true to enable row scaling |
enableRowScaling
open funenableRowScaling(enable: Boolean): Unit
Deprecated: use BrowseFragment#enableMainFragmentScaling(boolean)
instead.
Parameters | |
---|---|
enable |
Boolean: true to enable row scaling |
getAdapter
open fun getAdapter(): ObjectAdapter!
Returns the adapter containing the rows for the fragment.
getBrandColor
open fun getBrandColor(): Int
Returns the brand color for the browse fragment. The default is transparent.
getHeadersFragment
open fun getHeadersFragment(): HeadersFragment!
Get currently bound HeadersFragment or null if HeadersFragment has not been created yet.
Return | |
---|---|
HeadersFragment!: Currently bound HeadersFragment or null if HeadersFragment has not been created yet. |
getHeadersState
open fun getHeadersState(): Int
Returns the state of the headers column in the browse fragment.
getMainFragment
open fun getMainFragment(): Fragment!
Return | |
---|---|
Fragment!: Current main fragment or null if not created. |
getMainFragmentRegistry
fun getMainFragmentRegistry(): BrowseFragment.MainFragmentAdapterRegistry!
getOnItemViewClickedListener
open fun getOnItemViewClickedListener(): OnItemViewClickedListener!
Returns the item Clicked listener.
getOnItemViewSelectedListener
open fun getOnItemViewSelectedListener(): OnItemViewSelectedListener!
Returns an item selection listener.
getRowsFragment
open fun getRowsFragment(): RowsFragment!
Get RowsFragment if it's bound to BrowseFragment or null if either BrowseFragment has not been created yet or a different fragment is bound to it.
Return | |
---|---|
RowsFragment!: RowsFragment if it's bound to BrowseFragment or null otherwise. |
getSelectedPosition
open fun getSelectedPosition(): Int
Gets position of currently selected row.
Return | |
---|---|
Int: Position of currently selected row. |
getSelectedRowViewHolder
open fun getSelectedRowViewHolder(): RowPresenter.ViewHolder!
Return | |
---|---|
RowPresenter.ViewHolder!: selected row ViewHolder inside fragment created by MainFragmentRowsAdapter . |
isHeadersTransitionOnBackEnabled
fun isHeadersTransitionOnBackEnabled(): Boolean
Returns true if headers transition on back key support is enabled.
isInHeadersTransition
open fun isInHeadersTransition(): Boolean
Returns true if the headers transition is currently running.
onCreateHeadersFragment
open fun onCreateHeadersFragment(): HeadersFragment!
Creates a new HeadersFragment
instance. Subclass of BrowseFragment may override and return an instance of subclass of HeadersFragment, e.g. when app wants to replace presenter to render HeaderItem.
Return | |
---|---|
HeadersFragment!: A new instance of HeadersFragment or its subclass. |
onCreateView
open fun onCreateView(inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle!): View!
onDestroy
open fun onDestroy(): Unit
onDestroyView
open fun onDestroyView(): Unit
onStart
open fun onStart(): Unit
onStop
open fun onStop(): Unit
setAdapter
open fun setAdapter(adapter: ObjectAdapter!): Unit
Sets the adapter containing the rows for the fragment.
The items referenced by the adapter must be be derived from Row
. These rows will be used by the rows fragment and the headers fragment (if not disabled) to render the browse rows.
Parameters | |
---|---|
adapter |
ObjectAdapter!: An ObjectAdapter for the browse rows. All items must derive from Row . |
setBrandColor
open fun setBrandColor(color: Int): Unit
Sets the brand color for the browse fragment. The brand color is used as the primary color for UI elements in the browse fragment. For example, the background color of the headers fragment uses the brand color.
Parameters | |
---|---|
color |
Int: The color to use as the brand color of the fragment. |
setBrowseTransitionListener
open fun setBrowseTransitionListener(listener: BrowseFragment.BrowseTransitionListener!): Unit
Sets a listener for browse fragment transitions.
Parameters | |
---|---|
listener |
BrowseFragment.BrowseTransitionListener!: The listener to call when a browse headers transition begins or ends. |
setHeaderPresenterSelector
open fun setHeaderPresenterSelector(headerPresenterSelector: PresenterSelector!): Unit
Sets the PresenterSelector
used to render the row headers.
Parameters | |
---|---|
headerPresenterSelector |
PresenterSelector!: The PresenterSelector that will determine the Presenter for each row header. |
setHeadersState
open fun setHeadersState(headersState: Int): Unit
Sets the state for the headers column in the browse fragment. Must be one of HEADERS_ENABLED
, HEADERS_HIDDEN
, or HEADERS_DISABLED
.
Parameters | |
---|---|
headersState |
Int: The state of the headers for the browse fragment. |
setHeadersTransitionOnBackEnabled
fun setHeadersTransitionOnBackEnabled(headersBackStackEnabled: Boolean): Unit
Enables/disables headers transition on back key support. This is enabled by default. The BrowseFragment will add a back stack entry when headers are showing. Running a headers transition when the back key is pressed only works when the headers state is HEADERS_ENABLED
or HEADERS_HIDDEN
.
NOTE: If an Activity has its own onBackPressed() handling, you must disable this feature. You may use startHeadersTransition(boolean)
and BrowseTransitionListener
in your own back stack handling.
setOnItemViewClickedListener
open fun setOnItemViewClickedListener(listener: OnItemViewClickedListener!): Unit
Sets an item clicked listener on the fragment. OnItemViewClickedListener will override View.OnClickListener
that item presenter sets during Presenter#onCreateViewHolder(ViewGroup)
. So in general, developer should choose one of the listeners but not both.
setOnItemViewSelectedListener
open fun setOnItemViewSelectedListener(listener: OnItemViewSelectedListener!): Unit
Sets an item selection listener.
setSelectedPosition
open fun setSelectedPosition(position: Int): Unit
Sets the selected row position with smooth animation.
setSelectedPosition
open fun setSelectedPosition(position: Int, smooth: Boolean): Unit
Sets the selected row position.
setSelectedPosition
open fun setSelectedPosition(rowPosition: Int, smooth: Boolean, rowHolderTask: Presenter.ViewHolderTask!): Unit
Selects a Row and perform an optional task on the Row. For example setSelectedPosition(10, true, new ListRowPresenterSelectItemViewHolderTask(5))
scrolls to 11th row and selects 6th item on that row. The method will be ignored if RowsFragment has not been created (i.e. before onCreateView(LayoutInflater, * ViewGroup, Bundle)
).
Parameters | |
---|---|
rowPosition |
Int: Which row to select. |
smooth |
Int: True to scroll to the row, false for no animation. |
rowHolderTask |
Int: Optional task to perform on the Row. When the task is not null, headers fragment will be collapsed. |
startHeadersTransition
open fun startHeadersTransition(withHeaders: Boolean): Unit
Starts a headers transition.
This method will begin a transition to either show or hide the headers, depending on the value of withHeaders. If headers are disabled for this browse fragment, this method will throw an exception.
Parameters | |
---|---|
withHeaders |
Boolean: True if the headers should transition to being shown, false if the transition should result in headers being hidden. |
Protected methods
createEntranceTransition
protected open fun createEntranceTransition(): Any!
onEntranceTransitionEnd
protected open fun onEntranceTransitionEnd(): Unit
onEntranceTransitionPrepare
protected open fun onEntranceTransitionPrepare(): Unit
onEntranceTransitionStart
protected open fun onEntranceTransitionStart(): Unit