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

MultiActionsProvider.MultiAction

public static class MultiActionsProvider.MultiAction
extends Object

java.lang.Object
   ↳ androidx.leanback.widget.MultiActionsProvider.MultiAction


MultiAction represents an action that can have multiple states. getIndex() returns the current index within the drawables. Both list of drawables and index can be updated dynamically in the program, and the UI could be updated by notifying the listeners provided in AbstractMediaItemPresenter.ViewHolder.

Summary

Public constructors

MultiActionsProvider.MultiAction(long id)

Public methods

Drawable getCurrentDrawable()
Drawable[] getDrawables()

Returns the drawables used for displaying different states within this MultiActionsProvider.MultiAction.

long getId()
int getIndex()

Returns the currently selected index in this MultiAction.

void incrementIndex()

Increments the index which this MultiAction currently represents.

void setDrawables(Drawable[] drawables)

Sets the drawables used for displaying different states within this MultiActionsProvider.MultiAction.

void setIndex(int index)

Sets the index which this MultiAction currently represents.

Inherited methods

Public constructors

MultiActionsProvider.MultiAction

added in version 1.0.0
public MultiActionsProvider.MultiAction (long id)

Parameters
id long

Public methods

getCurrentDrawable

added in version 1.0.0
public Drawable getCurrentDrawable ()

Returns
Drawable The icon drawable for the current state of this MultiAction.

getDrawables

added in version 1.0.0
public Drawable[] getDrawables ()

Returns the drawables used for displaying different states within this MultiActionsProvider.MultiAction.

Returns
Drawable[] The drawables used for displaying different states within this MultiActionsProvider.MultiAction.

getId

added in version 1.0.0
public long getId ()

Returns
long The id for this MultiAction.

getIndex

added in version 1.0.0
public int getIndex ()

Returns the currently selected index in this MultiAction.

Returns
int The currently selected index in this MultiAction.

incrementIndex

added in version 1.0.0
public void incrementIndex ()

Increments the index which this MultiAction currently represents. The index is wrapped around to zero when the end is reached.

setDrawables

added in version 1.0.0
public void setDrawables (Drawable[] drawables)

Sets the drawables used for displaying different states within this MultiActionsProvider.MultiAction. The size of drawables determines the set of states this action represents.

Parameters
drawables Drawable: Array of drawables for different MultiAction states.

setIndex

added in version 1.0.0
public void setIndex (int index)

Sets the index which this MultiAction currently represents.

Parameters
index int: The current action index.