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

ListRowPresenter.SelectItemViewHolderTask

public static class ListRowPresenter.SelectItemViewHolderTask
extends Presenter.ViewHolderTask

java.lang.Object
   ↳ androidx.leanback.widget.Presenter.ViewHolderTask
     ↳ androidx.leanback.widget.ListRowPresenter.SelectItemViewHolderTask


A task on the ListRowPresenter.ViewHolder that can select an item by position in the HorizontalGridView and perform an optional item task on it.

Summary

Public constructors

ListRowPresenter.SelectItemViewHolderTask(int itemPosition)

Public methods

int getItemPosition()

Returns the adapter position of item to select.

Presenter.ViewHolderTask getItemTask()

Returns optional task to run when the item is selected, null for no task.

boolean isSmoothScroll()

Returns true if smooth scrolling to the item false otherwise.

void run(Presenter.ViewHolder holder)

Called to perform a task on view holder.

void setItemPosition(int itemPosition)

Sets the adapter position of item to select.

void setItemTask(Presenter.ViewHolderTask itemTask)

Sets task to run when the item is selected, null for no task.

void setSmoothScroll(boolean smoothScroll)

Sets smooth scrolling to the item or jump to the item without scrolling.

Inherited methods

Public constructors

ListRowPresenter.SelectItemViewHolderTask

added in version 1.0.0
public ListRowPresenter.SelectItemViewHolderTask (int itemPosition)

Parameters
itemPosition int

Public methods

getItemPosition

added in version 1.0.0
public int getItemPosition ()

Returns the adapter position of item to select.

Returns
int The adapter position of item to select.

getItemTask

added in version 1.0.0
public Presenter.ViewHolderTask getItemTask ()

Returns optional task to run when the item is selected, null for no task.

Returns
Presenter.ViewHolderTask Optional task to run when the item is selected, null for no task.

isSmoothScroll

added in version 1.0.0
public boolean isSmoothScroll ()

Returns true if smooth scrolling to the item false otherwise. By default it is true.

Returns
boolean True for smooth scrolling to the item, false otherwise.

run

added in version 1.0.0
public void run (Presenter.ViewHolder holder)

Called to perform a task on view holder.

Parameters
holder Presenter.ViewHolder: The view holder to perform task.

setItemPosition

added in version 1.0.0
public void setItemPosition (int itemPosition)

Sets the adapter position of item to select.

Parameters
itemPosition int: Position of the item in adapter.

setItemTask

added in version 1.0.0
public void setItemTask (Presenter.ViewHolderTask itemTask)

Sets task to run when the item is selected, null for no task.

Parameters
itemTask Presenter.ViewHolderTask: Optional task to run when the item is selected, null for no task.

setSmoothScroll

added in version 1.0.0
public void setSmoothScroll (boolean smoothScroll)

Sets smooth scrolling to the item or jump to the item without scrolling. By default it is true.

Parameters
smoothScroll boolean: True for smooth scrolling to the item, false otherwise.