RowsSupportFragment
public
class
RowsSupportFragment
extends Fragment
implements
BrowseSupportFragment.MainFragmentRowsAdapterProvider,
BrowseSupportFragment.MainFragmentAdapterProvider
java.lang.Object | ||
↳ | androidx.fragment.app.Fragment | |
↳ | androidx.leanback.app.RowsSupportFragment |
An ordered set of rows of leanback widgets.
A RowsSupportFragment renders the elements of its
ObjectAdapter
as a set
of rows in a vertical list. The Adapter's PresenterSelector
must maintain subclasses
of RowPresenter
.
Summary
Nested classes | |
---|---|
class |
RowsSupportFragment.MainFragmentAdapter
|
class |
RowsSupportFragment.MainFragmentRowsAdapter
The adapter that RowsSupportFragment implements BrowseSupportFragment.MainFragmentRowsAdapter. |
Public constructors | |
---|---|
RowsSupportFragment()
|
Public methods | |
---|---|
void
|
enableRowScaling(boolean enable)
This method is deprecated.
use |
RowPresenter.ViewHolder
|
findRowViewHolderByPosition(int position)
Find row ViewHolder by position in adapter. |
final
ObjectAdapter
|
getAdapter()
Returns the Adapter that represents list of rows. |
final
ItemBridgeAdapter
|
getBridgeAdapter()
Returns the RecyclerView.Adapter that wraps |
MainFragmentAdapter
|
getMainFragmentAdapter()
Returns an instance of |
MainFragmentRowsAdapter
|
getMainFragmentRowsAdapter()
Returns an instance of |
BaseOnItemViewClickedListener
|
getOnItemViewClickedListener()
Returns the item clicked listener. |
BaseOnItemViewSelectedListener
|
getOnItemViewSelectedListener()
Returns an item selection listener. |
final
PresenterSelector
|
getPresenterSelector()
Get the presenter selector used to create and bind views. |
RowPresenter.ViewHolder
|
getRowViewHolder(int position)
Get row ViewHolder at adapter position. |
int
|
getSelectedPosition()
Gets position of currently selected row. |
final
VerticalGridView
|
getVerticalGridView()
|
boolean
|
isScrolling()
|
View
|
onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
Called to have the fragment instantiate its user interface view. |
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
|
onTransitionEnd()
|
boolean
|
onTransitionPrepare()
|
void
|
onTransitionStart()
|
void
|
onViewCreated(View view, Bundle savedInstanceState)
Called immediately after |
final
void
|
setAdapter(ObjectAdapter rowsAdapter)
Sets the adapter that represents a list of rows. |
void
|
setAlignment(int windowAlignOffsetFromTop)
|
void
|
setEntranceTransitionState(boolean afterTransition)
For rows that willing to participate entrance transition, this function hide views if afterTransition is true, show views if afterTransition is false. |
void
|
setExpand(boolean expand)
Set the visibility of titles/hovercard of browse rows. |
void
|
setOnItemViewClickedListener(BaseOnItemViewClickedListener listener)
Sets an item clicked listener on the fragment. |
void
|
setOnItemViewSelectedListener(BaseOnItemViewSelectedListener listener)
Sets an item selection listener. |
final
void
|
setPresenterSelector(PresenterSelector presenterSelector)
Set the presenter selector used to create and bind views. |
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. |
Protected methods | |
---|---|
VerticalGridView
|
findGridViewFromRoot(View view)
|
Inherited methods | |
---|---|
Public constructors
RowsSupportFragment
public RowsSupportFragment ()
Public methods
enableRowScaling
public void enableRowScaling (boolean enable)
This method is deprecated.
use BrowseSupportFragment.enableRowScaling(boolean)
instead.
Parameters | |
---|---|
enable |
boolean : true to enable row scaling
|
findRowViewHolderByPosition
public RowPresenter.ViewHolder findRowViewHolderByPosition (int position)
Find row ViewHolder by position in adapter.
Parameters | |
---|---|
position |
int : Position of row. |
Returns | |
---|---|
RowPresenter.ViewHolder |
ViewHolder of Row. |
getAdapter
public final ObjectAdapter getAdapter ()
Returns the Adapter that represents list of rows.
Returns | |
---|---|
ObjectAdapter |
Adapter that represents list of rows. |
getBridgeAdapter
public final ItemBridgeAdapter getBridgeAdapter ()
Returns the RecyclerView.Adapter that wraps getAdapter()
.
Returns | |
---|---|
ItemBridgeAdapter |
The RecyclerView.Adapter that wraps getAdapter() .
|
getMainFragmentAdapter
public MainFragmentAdapter getMainFragmentAdapter ()
Returns an instance of BrowseSupportFragment.MainFragmentAdapter
that BrowseSupportFragment
would use to communicate with the target fragment.
Returns | |
---|---|
MainFragmentAdapter |
getMainFragmentRowsAdapter
public MainFragmentRowsAdapter getMainFragmentRowsAdapter ()
Returns an instance of BrowseSupportFragment.MainFragmentRowsAdapter
that BrowseSupportFragment
would use to communicate with the target fragment.
Returns | |
---|---|
MainFragmentRowsAdapter |
getOnItemViewClickedListener
public BaseOnItemViewClickedListener getOnItemViewClickedListener ()
Returns the item clicked listener.
Returns | |
---|---|
BaseOnItemViewClickedListener |
getOnItemViewSelectedListener
public BaseOnItemViewSelectedListener getOnItemViewSelectedListener ()
Returns an item selection listener.
Returns | |
---|---|
BaseOnItemViewSelectedListener |
getPresenterSelector
public final PresenterSelector getPresenterSelector ()
Get the presenter selector used to create and bind views.
Returns | |
---|---|
PresenterSelector |
getRowViewHolder
public RowPresenter.ViewHolder getRowViewHolder (int position)
Get row ViewHolder at adapter position. Returns null if the row object is not in adapter or the row object has not been bound to a row view.
Parameters | |
---|---|
position |
int : Position of row in adapter. |
Returns | |
---|---|
RowPresenter.ViewHolder |
Row ViewHolder at a given adapter position. |
getSelectedPosition
public int getSelectedPosition ()
Gets position of currently selected row.
Returns | |
---|---|
int |
Position of currently selected row. |
isScrolling
public boolean isScrolling ()
Returns | |
---|---|
boolean |
onCreateView
public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
Called to have the fragment instantiate its user interface view.
This is optional, and non-graphical fragments can return null. This will be called between
onCreate(Bundle)
and onActivityCreated(Bundle)
.
A default View can be returned by calling Fragment(int)
in your
constructor. Otherwise, this method returns null.
It is recommended to only inflate the layout in this method and move
logic that operates on the returned View to onViewCreated(View, Bundle)
.
If you return a View from here, you will later be called in
onDestroyView()
when the view is being released.
Parameters | |
---|---|
inflater |
LayoutInflater : The LayoutInflater object that can be used to inflate
any views in the fragment, |
container |
ViewGroup : If non-null, this is the parent view that the fragment's
UI should be attached to. The fragment should not add the view itself,
but this can be used to generate the LayoutParams of the view. |
savedInstanceState |
Bundle : If non-null, this fragment is being re-constructed
from a previous saved state as given here. |
Returns | |
---|---|
View |
Return the View for the fragment's UI, or null. |
onDestroyView
public void onDestroyView ()
Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle)
has
been detached from the fragment. The next time the fragment needs
to be displayed, a new view will be created. This is called
after onStop()
and before onDestroy()
. It is called
regardless of whether onCreateView(LayoutInflater, ViewGroup, Bundle)
returned a
non-null view. Internally it is called after the view's state has
been saved but before it has been removed from its parent.
onSaveInstanceState
public 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. If a new instance of the fragment later needs to be
created, the data you place in the Bundle here will be available
in the Bundle given to onCreate(Bundle)
,
onCreateView(LayoutInflater, ViewGroup, Bundle)
, and
onActivityCreated(Bundle)
.
This corresponds to Activity.onSaveInstanceState(Bundle)
and most of the discussion there
applies here as well. Note however: this method may be called
at any time before onDestroy()
. There are many situations
where a fragment may be mostly torn down (such as when placed on the
back stack with no UI showing), but its state will not be saved until
its owning activity actually needs to save its state.
Parameters | |
---|---|
outState |
Bundle : Bundle in which to place your saved state.
|
onTransitionEnd
public void onTransitionEnd ()
onTransitionPrepare
public boolean onTransitionPrepare ()
Returns | |
---|---|
boolean |
onTransitionStart
public void onTransitionStart ()
onViewCreated
public void onViewCreated (View view, Bundle savedInstanceState)
Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle)
has returned, but before any saved state has been restored in to the view.
This gives subclasses a chance to initialize themselves once
they know their view hierarchy has been completely created. The fragment's
view hierarchy is not however attached to its parent at this point.
Parameters | |
---|---|
view |
View : The View returned by onCreateView(LayoutInflater, ViewGroup, Bundle) . |
savedInstanceState |
Bundle : If non-null, this fragment is being re-constructed
from a previous saved state as given here.
|
setAdapter
public final void setAdapter (ObjectAdapter rowsAdapter)
Sets the adapter that represents a list of rows.
Parameters | |
---|---|
rowsAdapter |
ObjectAdapter : Adapter that represents list of rows.
|
setAlignment
public void setAlignment (int windowAlignOffsetFromTop)
Parameters | |
---|---|
windowAlignOffsetFromTop |
int |
setEntranceTransitionState
public void setEntranceTransitionState (boolean afterTransition)
For rows that willing to participate entrance transition, this function hide views if afterTransition is true, show views if afterTransition is false.
Parameters | |
---|---|
afterTransition |
boolean |
setExpand
public void setExpand (boolean expand)
Set the visibility of titles/hovercard of browse rows.
Parameters | |
---|---|
expand |
boolean |
setOnItemViewClickedListener
public void setOnItemViewClickedListener (BaseOnItemViewClickedListener listener)
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.
Parameters | |
---|---|
listener |
BaseOnItemViewClickedListener |
setOnItemViewSelectedListener
public void setOnItemViewSelectedListener (BaseOnItemViewSelectedListener listener)
Sets an item selection listener.
Parameters | |
---|---|
listener |
BaseOnItemViewSelectedListener |
setPresenterSelector
public final void setPresenterSelector (PresenterSelector presenterSelector)
Set the presenter selector used to create and bind views.
Parameters | |
---|---|
presenterSelector |
PresenterSelector |
setSelectedPosition
public void setSelectedPosition (int position)
Sets the selected row position with smooth animation.
Parameters | |
---|---|
position |
int |
setSelectedPosition
public void setSelectedPosition (int rowPosition, boolean smooth, Presenter.ViewHolderTask rowHolderTask)
Selects a Row and perform an optional task on the Row. For example
setSelectedPosition(10, true, new ListRowPresenterSelectItemViewHolderTask(5))
Scroll to 11th row and selects 6th item on that row. The method will be ignored if
RowsSupportFragment has not been created (i.e. before onCreateView(LayoutInflater, ViewGroup, Bundle)
).
Parameters | |
---|---|
rowPosition |
int : Which row to select. |
smooth |
boolean : True to scroll to the row, false for no animation. |
rowHolderTask |
Presenter.ViewHolderTask : Task to perform on the Row.
|
setSelectedPosition
public void setSelectedPosition (int position, boolean smooth)
Sets the selected row position.
Parameters | |
---|---|
position |
int |
smooth |
boolean |
Protected methods
findGridViewFromRoot
protected VerticalGridView findGridViewFromRoot (View view)
Parameters | |
---|---|
view |
View |
Returns | |
---|---|
VerticalGridView |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.