Skip to content

Most visited

Recently visited

navigation

RowsFragment

public class RowsFragment
extends Fragment implements BrowseFragment.MainFragmentRowsAdapterProvider, BrowseFragment.MainFragmentAdapterProvider

java.lang.Object
   ↳ android.app.Fragment
     ↳ android.support.v17.leanback.app.RowsFragment


An ordered set of rows of leanback widgets.

A RowsFragment 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 RowsFragment.MainFragmentAdapter

 

class RowsFragment.MainFragmentRowsAdapter

 

Inherited XML attributes

From class android.app.Fragment

Inherited constants

From interface android.content.ComponentCallbacks2

Public constructors

RowsFragment()

Public methods

void enableRowScaling(boolean enable)

This method was deprecated in API level 24.0.0. use enableRowScaling(boolean) instead.

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 getAdapter().

MainFragmentAdapter getMainFragmentAdapter()

Returns an instance of BrowseFragment.MainFragmentAdapter that BrowseFragment would use to communicate with the target fragment.

MainFragmentRowsAdapter getMainFragmentRowsAdapter()

Returns an instance of BrowseFragment.MainFragmentRowsAdapter that BrowseFragment would use to communicate with the target fragment.

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()
void onCreate(Bundle savedInstanceState)

Called to do initial creation of a fragment.

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 onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from the fragment.

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 onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view.

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

From class android.app.Fragment
From class java.lang.Object
From interface android.content.ComponentCallbacks2
From interface android.view.View.OnCreateContextMenuListener
From interface android.support.v17.leanback.app.BrowseFragment.MainFragmentRowsAdapterProvider
From interface android.support.v17.leanback.app.BrowseFragment.MainFragmentAdapterProvider
From interface android.content.ComponentCallbacks

Public constructors

RowsFragment

added in version 22.0.0
RowsFragment ()

Public methods

enableRowScaling

added in version 22.0.0
void enableRowScaling (boolean enable)

This method was deprecated in API level 24.0.0.
use enableRowScaling(boolean) instead.

Parameters
enable boolean: true to enable row scaling

findRowViewHolderByPosition

added in version 25.1.0
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

added in version 22.0.0
ObjectAdapter getAdapter ()

Returns the Adapter that represents list of rows.

Returns
ObjectAdapter Adapter that represents list of rows.

getBridgeAdapter

added in version 26.0.0
ItemBridgeAdapter getBridgeAdapter ()

Returns the RecyclerView.Adapter that wraps getAdapter().

Returns
ItemBridgeAdapter The RecyclerView.Adapter that wraps getAdapter().

getMainFragmentAdapter

added in version 24.0.0
MainFragmentAdapter getMainFragmentAdapter ()

Returns an instance of BrowseFragment.MainFragmentAdapter that BrowseFragment would use to communicate with the target fragment.

Returns
MainFragmentAdapter

getMainFragmentRowsAdapter

added in version 24.0.0
MainFragmentRowsAdapter getMainFragmentRowsAdapter ()

Returns an instance of BrowseFragment.MainFragmentRowsAdapter that BrowseFragment would use to communicate with the target fragment.

Returns
MainFragmentRowsAdapter

getOnItemViewClickedListener

added in version 22.0.0
BaseOnItemViewClickedListener getOnItemViewClickedListener ()

Returns the item clicked listener.

Returns
BaseOnItemViewClickedListener

getOnItemViewSelectedListener

added in version 22.0.0
BaseOnItemViewSelectedListener getOnItemViewSelectedListener ()

Returns an item selection listener.

Returns
BaseOnItemViewSelectedListener

getPresenterSelector

added in version 22.0.0
PresenterSelector getPresenterSelector ()

Get the presenter selector used to create and bind views.

Returns
PresenterSelector

getRowViewHolder

added in version 23.2.0
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

added in version 23.2.0
int getSelectedPosition ()

Gets position of currently selected row.

Returns
int Position of currently selected row.

getVerticalGridView

added in version 25.1.0
VerticalGridView getVerticalGridView ()

Returns
VerticalGridView

isScrolling

added in version 24.0.0
boolean isScrolling ()

Returns
boolean

onCreate

void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle), but is not called if the fragment instance is retained across Activity re-creation (see setRetainInstance(boolean)).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see onActivityCreated(Bundle).

If your app's targetSdkVersion is M or lower, child fragments being restored from the savedInstanceState are restored after onCreate returns. When targeting N or above and running on an N or newer platform version they are restored by Fragment.onCreate.

Parameters
savedInstanceState Bundle: If the fragment is being re-created from a previous saved state, this is the state.

onCreateView

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 (which is the default implementation). This will be called between onCreate(Bundle) and onActivityCreated(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

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

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

added in version 24.0.0
void onTransitionEnd ()

onTransitionPrepare

added in version 24.0.0
boolean onTransitionPrepare ()

Returns
boolean

onTransitionStart

added in version 24.0.0
void onTransitionStart ()

onViewCreated

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

added in version 22.0.0
void setAdapter (ObjectAdapter rowsAdapter)

Sets the adapter that represents a list of rows.

Parameters
rowsAdapter ObjectAdapter: Adapter that represents list of rows.

setAlignment

added in version 24.0.0
void setAlignment (int windowAlignOffsetFromTop)

Parameters
windowAlignOffsetFromTop int

setEntranceTransitionState

added in version 24.0.0
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

added in version 22.0.0
void setExpand (boolean expand)

Set the visibility of titles/hovercard of browse rows.

Parameters
expand boolean

setOnItemViewClickedListener

added in version 24.0.0
void setOnItemViewClickedListener (BaseOnItemViewClickedListener listener)

Sets an item clicked listener on the fragment. OnItemViewClickedListener will override View.OnClickListener that item presenter sets during onCreateViewHolder(ViewGroup). So in general, developer should choose one of the listeners but not both.

Parameters
listener BaseOnItemViewClickedListener

setOnItemViewSelectedListener

added in version 24.0.0
void setOnItemViewSelectedListener (BaseOnItemViewSelectedListener listener)

Sets an item selection listener.

Parameters
listener BaseOnItemViewSelectedListener

setPresenterSelector

added in version 22.0.0
void setPresenterSelector (PresenterSelector presenterSelector)

Set the presenter selector used to create and bind views.

Parameters
presenterSelector PresenterSelector

setSelectedPosition

added in version 22.0.0
void setSelectedPosition (int position)

Sets the selected row position with smooth animation.

Parameters
position int

setSelectedPosition

added in version 23.2.0
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 RowsFragment 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

added in version 22.0.0
void setSelectedPosition (int position, 
                boolean smooth)

Sets the selected row position.

Parameters
position int

smooth boolean

Protected methods

findGridViewFromRoot

added in version 22.0.0
VerticalGridView findGridViewFromRoot (View view)

Parameters
view View

Returns
VerticalGridView

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

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 short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)