Android APIs
public class

VerticalGridPresenter

extends Presenter
java.lang.Object
   ↳ android.support.v17.leanback.widget.Presenter
     ↳ android.support.v17.leanback.widget.VerticalGridPresenter

Class Overview

A presenter that renders objects in a VerticalGridView.

Summary

Nested Classes
class VerticalGridPresenter.ViewHolder ViewHolder for the VerticalGridPresenter. 
Public Constructors
VerticalGridPresenter()
Constructs a VerticalGridPresenter with defaults.
VerticalGridPresenter(int focusZoomFactor)
Constructs a VerticalGridPresenter with the given parameters.
VerticalGridPresenter(int focusZoomFactor, boolean useFocusDimmer)
Constructs a VerticalGridPresenter with the given parameters.
Public Methods
final boolean areChildRoundedCornersEnabled()
Returns true if rounded corners are enabled for children of this row.
final void enableChildRoundedCorners(boolean enable)
Enables or disabled rounded corners on children of this row.
final int getFocusZoomFactor()
Returns the zoom factor used for focus highlighting.
int getNumberOfColumns()
Returns the number of columns in the vertical grid.
final OnItemViewClickedListener getOnItemViewClickedListener()
Returns the item clicked listener.
final OnItemViewSelectedListener getOnItemViewSelectedListener()
Returns the item selected listener.
final boolean getShadowEnabled()
Returns true if child shadow is enabled.
final boolean isFocusDimmerUsed()
Returns true if the focus dimmer is used for focus highlighting; false otherwise.
boolean isUsingDefaultShadow()
Returns true if opticalBounds is supported (SDK >= 18) so that default shadow is applied to each individual child of VerticalGridView.
boolean isUsingZOrder(Context context)
Returns true if SDK >= L, where Z shadow is enabled so that Z order is enabled on each child of vertical grid.
void onBindViewHolder(Presenter.ViewHolder viewHolder, Object item)
Binds a View to an item.
final VerticalGridPresenter.ViewHolder onCreateViewHolder(ViewGroup parent)
Creates a new View.
void onUnbindViewHolder(Presenter.ViewHolder viewHolder)
Unbinds a View from an item.
void setNumberOfColumns(int numColumns)
Sets the number of columns in the vertical grid.
final void setOnItemViewClickedListener(OnItemViewClickedListener listener)
Sets the item clicked listener.
final void setOnItemViewSelectedListener(OnItemViewSelectedListener listener)
Sets the item selected listener.
final void setShadowEnabled(boolean enabled)
Enable or disable child shadow.
Protected Methods
VerticalGridPresenter.ViewHolder createGridViewHolder(ViewGroup parent)
Subclass may override this to inflate a different layout.
void initializeGridViewHolder(VerticalGridPresenter.ViewHolder vh)
Called after a VerticalGridPresenter.ViewHolder is created.
[Expand]
Inherited Methods
From class android.support.v17.leanback.widget.Presenter
From class java.lang.Object
From interface android.support.v17.leanback.widget.FacetProvider

Public Constructors

public VerticalGridPresenter ()

Constructs a VerticalGridPresenter with defaults. Uses ZOOM_FACTOR_MEDIUM for focus zooming and enabled dimming on focus.

public VerticalGridPresenter (int focusZoomFactor)

Constructs a VerticalGridPresenter with the given parameters.

Parameters
focusZoomFactor Controls the zoom factor used when an item view is focused. One of ZOOM_FACTOR_NONE, ZOOM_FACTOR_SMALL, ZOOM_FACTOR_XSMALL, ZOOM_FACTOR_MEDIUM, ZOOM_FACTOR_LARGE enabled dimming on focus.

public VerticalGridPresenter (int focusZoomFactor, boolean useFocusDimmer)

Constructs a VerticalGridPresenter with the given parameters.

Parameters
focusZoomFactor Controls the zoom factor used when an item view is focused. One of ZOOM_FACTOR_NONE, ZOOM_FACTOR_SMALL, ZOOM_FACTOR_XSMALL, ZOOM_FACTOR_MEDIUM, ZOOM_FACTOR_LARGE
useFocusDimmer determines if the FocusHighlighter will use the dimmer

Public Methods

public final boolean areChildRoundedCornersEnabled ()

Returns true if rounded corners are enabled for children of this row.

public final void enableChildRoundedCorners (boolean enable)

Enables or disabled rounded corners on children of this row. Supported on Android SDK >= L.

public final int getFocusZoomFactor ()

Returns the zoom factor used for focus highlighting.

public int getNumberOfColumns ()

Returns the number of columns in the vertical grid.

public final OnItemViewClickedListener getOnItemViewClickedListener ()

Returns the item clicked listener.

public final OnItemViewSelectedListener getOnItemViewSelectedListener ()

Returns the item selected listener.

public final boolean getShadowEnabled ()

Returns true if child shadow is enabled. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.

public final boolean isFocusDimmerUsed ()

Returns true if the focus dimmer is used for focus highlighting; false otherwise.

public boolean isUsingDefaultShadow ()

Returns true if opticalBounds is supported (SDK >= 18) so that default shadow is applied to each individual child of VerticalGridView. Subclass may return false to disable.

public boolean isUsingZOrder (Context context)

Returns true if SDK >= L, where Z shadow is enabled so that Z order is enabled on each child of vertical grid. If subclass returns false in isUsingDefaultShadow() and does not use Z-shadow on SDK >= L, it should override isUsingZOrder() return false.

public void onBindViewHolder (Presenter.ViewHolder viewHolder, Object item)

Binds a View to an item.

public final VerticalGridPresenter.ViewHolder onCreateViewHolder (ViewGroup parent)

Creates a new View.

public void onUnbindViewHolder (Presenter.ViewHolder viewHolder)

Unbinds a View from an item. Any expensive references may be released here, and any fields that are not bound for every item should be cleared here.

public void setNumberOfColumns (int numColumns)

Sets the number of columns in the vertical grid.

public final void setOnItemViewClickedListener (OnItemViewClickedListener listener)

Sets the item clicked listener. 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.

public final void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)

Sets the item selected listener. Since this is a grid the row parameter is always null.

public final void setShadowEnabled (boolean enabled)

Enable or disable child shadow. This is not only for enable/disable default shadow implementation but also subclass must respect this flag.

Protected Methods

protected VerticalGridPresenter.ViewHolder createGridViewHolder (ViewGroup parent)

Subclass may override this to inflate a different layout.

protected void initializeGridViewHolder (VerticalGridPresenter.ViewHolder vh)

Called after a VerticalGridPresenter.ViewHolder is created. Subclasses may override this method and start by calling super.initializeGridViewHolder(ViewHolder).

Parameters
vh The ViewHolder to initialize for the vertical grid.