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

RowPresenter.ViewHolder

public static class RowPresenter.ViewHolder
extends Presenter.ViewHolder

java.lang.Object
   ↳ androidx.leanback.widget.Presenter.ViewHolder
     ↳ androidx.leanback.widget.RowPresenter.ViewHolder


A ViewHolder for a Row.

Summary

Fields

protected final ColorOverlayDimmer mColorDimmer

Inherited fields

Public constructors

RowPresenter.ViewHolder(View view)

Constructor for ViewHolder.

Public methods

final RowHeaderPresenter.ViewHolder getHeaderViewHolder()

Returns the view holder for the Row header for this Row.

final BaseOnItemViewClickedListener getOnItemViewClickedListener()

Returns the listener for item click event.

final BaseOnItemViewSelectedListener getOnItemViewSelectedListener()

Returns the listener for item or row selection.

View.OnKeyListener getOnKeyListener()

Returns the key listener.

final Row getRow()

Returns the row bound to this ViewHolder.

final Object getRowObject()

Returns the Row object bound to this ViewHolder.

final float getSelectLevel()

Returns the current selection level of the Row.

Object getSelectedItem()

Return currently selected item inside a row ViewHolder.

Presenter.ViewHolder getSelectedItemViewHolder()

Return RowPresenter.ViewHolder of currently selected item inside a row ViewHolder.

final boolean isExpanded()

Returns whether the Row is in its expanded state.

final boolean isSelected()

Returns whether the Row is selected.

final void setActivated(boolean activated)

Sets the row view's activated status.

final void setOnItemViewClickedListener(BaseOnItemViewClickedListener listener)

Sets the listener for item click event.

final void setOnItemViewSelectedListener(BaseOnItemViewSelectedListener listener)

Sets the listener for item or row selection.

void setOnKeyListener(View.OnKeyListener keyListener)

Sets a key listener.

final void syncActivatedStatus(View view)

Synchronizes the activated status of view to the last value passed through setActivated(boolean).

Inherited methods

Fields

mColorDimmer

added in version 1.0.0
protected final ColorOverlayDimmer mColorDimmer

Public constructors

RowPresenter.ViewHolder

added in version 1.0.0
public RowPresenter.ViewHolder (View view)

Constructor for ViewHolder.

Parameters
view View: The View bound to the Row.

Public methods

getHeaderViewHolder

added in version 1.0.0
public final RowHeaderPresenter.ViewHolder getHeaderViewHolder ()

Returns the view holder for the Row header for this Row.

Returns
RowHeaderPresenter.ViewHolder

getOnItemViewClickedListener

added in version 1.0.0
public final BaseOnItemViewClickedListener getOnItemViewClickedListener ()

Returns the listener for item click event.

Returns
BaseOnItemViewClickedListener

getOnItemViewSelectedListener

added in version 1.0.0
public final BaseOnItemViewSelectedListener getOnItemViewSelectedListener ()

Returns the listener for item or row selection.

Returns
BaseOnItemViewSelectedListener

getOnKeyListener

added in version 1.0.0
public View.OnKeyListener getOnKeyListener ()

Returns the key listener.

Returns
View.OnKeyListener

getRow

added in version 1.0.0
public final Row getRow ()

Returns the row bound to this ViewHolder. Returns null if the row is not an instance of Row.

Returns
Row The row bound to this ViewHolder. Returns null if the row is not an instance of Row.

getRowObject

added in version 1.0.0
public final Object getRowObject ()

Returns the Row object bound to this ViewHolder.

Returns
Object The row object bound to this ViewHolder.

getSelectLevel

added in version 1.0.0
public final float getSelectLevel ()

Returns the current selection level of the Row.

Returns
float

getSelectedItem

added in version 1.0.0
public Object getSelectedItem ()

Return currently selected item inside a row ViewHolder.

Returns
Object The selected item.

getSelectedItemViewHolder

added in version 1.0.0
public Presenter.ViewHolder getSelectedItemViewHolder ()

Return RowPresenter.ViewHolder of currently selected item inside a row ViewHolder.

Returns
Presenter.ViewHolder The selected item's ViewHolder.

isExpanded

added in version 1.0.0
public final boolean isExpanded ()

Returns whether the Row is in its expanded state.

Returns
boolean true if the Row is expanded, false otherwise.

isSelected

added in version 1.0.0
public final boolean isSelected ()

Returns whether the Row is selected.

Returns
boolean true if the Row is selected, false otherwise.

setActivated

added in version 1.0.0
public final void setActivated (boolean activated)

Sets the row view's activated status. The status will be applied to children through syncActivatedStatus(View). Application should only call this function when RowPresenter.getSyncActivatePolicy() is RowPresenter.SYNC_ACTIVATED_CUSTOM; otherwise the value will be overwritten when expanded or selected status changes.

Parameters
activated boolean

setOnItemViewClickedListener

added in version 1.0.0
public final void setOnItemViewClickedListener (BaseOnItemViewClickedListener listener)

Sets the listener for item click event. RowPresenter does nothing but subclass of RowPresenter may fire item click event if it has the concept of item. OnItemViewClickedListener will override View.OnClickListener that item presenter sets during Presenter.onCreateViewHolder(ViewGroup).

Parameters
listener BaseOnItemViewClickedListener

setOnItemViewSelectedListener

added in version 1.0.0
public final void setOnItemViewSelectedListener (BaseOnItemViewSelectedListener listener)

Sets the listener for item or row selection. RowPresenter fires row selection event with null item. A subclass of RowPresenter e.g. ListRowPresenter may fire a selection event with selected item.

Parameters
listener BaseOnItemViewSelectedListener

setOnKeyListener

added in version 1.0.0
public void setOnKeyListener (View.OnKeyListener keyListener)

Sets a key listener.

Parameters
keyListener View.OnKeyListener

syncActivatedStatus

added in version 1.0.0
public final void syncActivatedStatus (View view)

Synchronizes the activated status of view to the last value passed through setActivated(boolean). No operation if setActivated(boolean) is never called. Normally application does not need to call this method, ListRowPresenter automatically calls this method when a child is attached to list row. However if application writes its own custom RowPresenter, it should call this method when attaches a child to the row view.

Parameters
view View