Summary: Nested Classes | Ctors | Methods | Protected Methods | Inherited Methods

VerticalGridPresenter

Kotlin |Java

public class VerticalGridPresenter
extends Presenter

java.lang.Object
↳	androidx.leanback.widget.Presenter
	↳	androidx.leanback.widget.VerticalGridPresenter

---

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.
final boolean	getKeepChildForeground() Returns true if keeps foreground of child of this grid, the foreground will not be used for overlay color.
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() Default implementation returns true if SDK version >= 21, shadow (either static or z-order based) will be 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	setEntranceTransitionState(VerticalGridPresenter.ViewHolder holder, boolean afterEntrance) Changes the visibility of views.
final void	setKeepChildForeground(boolean keep) Set if keeps foreground of child of this grid, the foreground will not be used for overlay color.
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.
ShadowOverlayHelper.Options	createShadowOverlayOptions() Create ShadowOverlayHelper Options.
void	initializeGridViewHolder(VerticalGridPresenter.ViewHolder vh) Called after a VerticalGridPresenter.ViewHolder is created.

Inherited methods
From class androidx.leanback.widget.Presenter static void cancelAnimationsRecursive(View view) Utility method for removing all running animations on a view. final Object getFacet(Class<?> facetClass) Queries optional implemented facet. abstract void onBindViewHolder(Presenter.ViewHolder viewHolder, Object item) Binds a View to an item. void onBindViewHolder(Presenter.ViewHolder viewHolder, Object item, List<Object> payloads) Binds a View to an item with a list of payloads. abstract Presenter.ViewHolder onCreateViewHolder(ViewGroup parent) Creates a new View. abstract void onUnbindViewHolder(Presenter.ViewHolder viewHolder) Unbinds a View from an item. void onViewAttachedToWindow(Presenter.ViewHolder holder) Called when a view created by this presenter has been attached to a window. void onViewDetachedFromWindow(Presenter.ViewHolder holder) Called when a view created by this presenter has been detached from its window. final void setFacet(Class<?> facetClass, Object facetImpl) Sets dynamic implemented facet in addition to basic Presenter functions. void setOnClickListener(Presenter.ViewHolder holder, View.OnClickListener listener) Called to set a click listener for the given view holder.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface androidx.leanback.widget.FacetProvider abstract Object getFacet(Class<?> facetClass) Queries optional implemented facet.

Public constructors

VerticalGridPresenter

public VerticalGridPresenter ()

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

VerticalGridPresenter

public VerticalGridPresenter (int focusZoomFactor)

Constructs a VerticalGridPresenter with the given parameters.

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

VerticalGridPresenter

public VerticalGridPresenter (int focusZoomFactor, 
                boolean useFocusDimmer)

Constructs a VerticalGridPresenter with the given parameters.

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

Public methods

areChildRoundedCornersEnabled

public final boolean areChildRoundedCornersEnabled ()

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

Returns
boolean

enableChildRoundedCorners

public final void enableChildRoundedCorners (boolean enable)

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

Parameters
enable	boolean

getFocusZoomFactor

public final int getFocusZoomFactor ()

Returns the zoom factor used for focus highlighting.

Returns
int

getKeepChildForeground

public final boolean getKeepChildForeground ()

Returns true if keeps foreground of child of this grid, the foreground will not be used for overlay color. Default value is true.

Returns
boolean	True if keeps foreground of child of this grid.

getNumberOfColumns

public int getNumberOfColumns ()

Returns the number of columns in the vertical grid.

Returns
int

getOnItemViewClickedListener

public final OnItemViewClickedListener getOnItemViewClickedListener ()

Returns the item clicked listener.

Returns
OnItemViewClickedListener

getOnItemViewSelectedListener

public final OnItemViewSelectedListener getOnItemViewSelectedListener ()

Returns the item selected listener.

Returns
OnItemViewSelectedListener

getShadowEnabled

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.

Returns
boolean

isFocusDimmerUsed

public final boolean isFocusDimmerUsed ()

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

Returns
boolean

isUsingDefaultShadow

public boolean isUsingDefaultShadow ()

Default implementation returns true if SDK version >= 21, shadow (either static or z-order based) will be applied to each individual child of VerticalGridView. Subclass may return false to disable default implementation of shadow and provide its own.

Returns
boolean

isUsingZOrder

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.

Parameters
context	Context

Returns
boolean

onBindViewHolder

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

Binds a View to an item.

Parameters
viewHolder	Presenter.ViewHolder
item	Object

onCreateViewHolder

public final VerticalGridPresenter.ViewHolder onCreateViewHolder (ViewGroup parent)

Creates a new View.

Parameters
parent	ViewGroup

Returns
VerticalGridPresenter.ViewHolder

onUnbindViewHolder

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.

Parameters
viewHolder	Presenter.ViewHolder

setEntranceTransitionState

public void setEntranceTransitionState (VerticalGridPresenter.ViewHolder holder, 
                boolean afterEntrance)

Changes the visibility of views. The entrance transition will be run against the views that change visibilities. This method is called by the fragment, it should not be called directly by the application.

Parameters
holder	VerticalGridPresenter.ViewHolder: The ViewHolder for the vertical grid.
afterEntrance	boolean: true if children of vertical grid participating in entrance transition should be set to visible, false otherwise.

setKeepChildForeground

public final void setKeepChildForeground (boolean keep)

Set if keeps foreground of child of this grid, the foreground will not be used for overlay color. Default value is true.

Parameters
keep	boolean: True if keep foreground of child of this grid.

setNumberOfColumns

public void setNumberOfColumns (int numColumns)

Sets the number of columns in the vertical grid.

Parameters
numColumns	int

setOnItemViewClickedListener

public final void setOnItemViewClickedListener (OnItemViewClickedListener listener)

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

setOnItemViewSelectedListener

public final void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)

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

Parameters
listener	OnItemViewSelectedListener

setShadowEnabled

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.

Parameters
enabled	boolean

Protected methods

createGridViewHolder

protected VerticalGridPresenter.ViewHolder createGridViewHolder (ViewGroup parent)

Subclass may override this to inflate a different layout.

Parameters
parent	ViewGroup

Returns
VerticalGridPresenter.ViewHolder

createShadowOverlayOptions

protected ShadowOverlayHelper.Options createShadowOverlayOptions ()

Create ShadowOverlayHelper Options. Subclass may override. e.g. return new ShadowOverlayHelper.Options().roundedCornerRadius(10);

Returns
ShadowOverlayHelper.Options	The options to be used for shadow, overlay and rounded corner.

initializeGridViewHolder

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	VerticalGridPresenter.ViewHolder: The ViewHolder to initialize for the vertical grid.