added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0-beta01

VerticalGridSupportFragment

public class VerticalGridSupportFragment
extends BaseSupportFragment

java.lang.Object
   ↳ androidx.fragment.app.Fragment
     ↳ androidx.leanback.app.BrandedSupportFragment
       ↳ androidx.leanback.app.BaseSupportFragment
         ↳ androidx.leanback.app.VerticalGridSupportFragment


A fragment for creating leanback vertical grids.

Renders a vertical grid of objects given a VerticalGridPresenter and an ObjectAdapter.

Summary

Public constructors

VerticalGridSupportFragment()

Public methods

ObjectAdapter getAdapter()

Returns the object adapter.

VerticalGridPresenter getGridPresenter()

Returns the grid presenter.

OnItemViewClickedListener getOnItemViewClickedListener()

Returns the item clicked listener.

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 onStart()

Called when the Fragment is visible to the user.

void setAdapter(ObjectAdapter adapter)

Sets the object adapter for the fragment.

void setGridPresenter(VerticalGridPresenter gridPresenter)

Sets the grid presenter.

void setOnItemViewClickedListener(OnItemViewClickedListener listener)

Sets an item clicked listener.

void setOnItemViewSelectedListener(OnItemViewSelectedListener listener)

Sets an item selection listener.

void setSelectedPosition(int position)

Sets the selected item position.

Protected methods

Object createEntranceTransition()

Create entrance transition.

void runEntranceTransition(Object entranceTransition)

Run entrance transition.

Inherited methods

Public constructors

VerticalGridSupportFragment

added in version 1.0.0
public VerticalGridSupportFragment ()

Public methods

getAdapter

added in version 1.0.0
public ObjectAdapter getAdapter ()

Returns the object adapter.

Returns
ObjectAdapter

getGridPresenter

added in version 1.0.0
public VerticalGridPresenter getGridPresenter ()

Returns the grid presenter.

Returns
VerticalGridPresenter

getOnItemViewClickedListener

added in version 1.0.0
public OnItemViewClickedListener getOnItemViewClickedListener ()

Returns the item clicked listener.

Returns
OnItemViewClickedListener

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 (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

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.

onStart

public void onStart ()

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

setAdapter

added in version 1.0.0
public void setAdapter (ObjectAdapter adapter)

Sets the object adapter for the fragment.

Parameters
adapter ObjectAdapter

setGridPresenter

added in version 1.0.0
public void setGridPresenter (VerticalGridPresenter gridPresenter)

Sets the grid presenter.

Parameters
gridPresenter VerticalGridPresenter

setOnItemViewClickedListener

added in version 1.0.0
public void setOnItemViewClickedListener (OnItemViewClickedListener listener)

Sets an item clicked listener.

Parameters
listener OnItemViewClickedListener

setOnItemViewSelectedListener

added in version 1.0.0
public void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)

Sets an item selection listener.

Parameters
listener OnItemViewSelectedListener

setSelectedPosition

added in version 1.0.0
public void setSelectedPosition (int position)

Sets the selected item position.

Parameters
position int

Protected methods

createEntranceTransition

added in version 1.0.0
protected Object createEntranceTransition ()

Create entrance transition. Subclass can override to load transition from resource or construct manually. Typically app does not need to override the default transition that browse and details provides.

Returns
Object

runEntranceTransition

added in version 1.0.0
protected void runEntranceTransition (Object entranceTransition)

Run entrance transition. Subclass may use TransitionManager to perform go(Scene) or beginDelayedTransition(). App should not override the default implementation of browse and details fragment.

Parameters
entranceTransition Object