PlaybackControlsRow.MultiAction

public abstract class PlaybackControlsRow.MultiAction extends Action

Known direct subclasses
PlaybackControlsRow.ClosedCaptioningAction

An action for displaying a CC (Closed Captioning) icon.

PlaybackControlsRow.FastForwardAction

An action displaying an icon for fast forward.

PlaybackControlsRow.HighQualityAction

An action for displaying a HQ (High Quality) icon.

PlaybackControlsRow.PlayPauseAction

An action displaying icons for play and pause.

PlaybackControlsRow.RepeatAction

An action for displaying three repeat states: none, one, or all.

PlaybackControlsRow.RewindAction

An action displaying an icon for rewind.

PlaybackControlsRow.ShuffleAction

An action for displaying a shuffle icon.

PlaybackControlsRow.ThumbsAction

A base class for displaying a thumbs action.

Known indirect subclasses
PlaybackControlsRow.ThumbsDownAction

An action displaying an icon for thumbs down.

PlaybackControlsRow.ThumbsUpAction

An action displaying an icon for thumbs up.


Base class for an action comprised of a series of icons.

Summary

Public constructors

MultiAction(int id)

Constructor

Public methods

int

Returns the number of actions.

Drawable
getDrawable(int index)

Returns the drawable at the given index.

int

Returns the current index.

String
getLabel(int index)

Returns the label at the given index.

String
getSecondaryLabel(int index)

Returns the secondary label at the given index.

void

Increments the index, wrapping to zero once the end is reached.

void
setDrawables(Drawable[] drawables)

Sets the array of drawables.

void
setIndex(int index)

Sets the current index.

void
setLabels(String[] labels)

Sets the array of strings used as labels.

void
setSecondaryLabels(String[] labels)

Sets the array of strings used as secondary labels.

Inherited Constants

From androidx.leanback.widget.Action
static final long
NO_ID = -1

Indicates that an id has not been set.

Inherited methods

From androidx.leanback.widget.Action
final void
addKeyCode(int keyCode)

Adds a keycode used to invoke this Action.

final @Nullable Drawable

Returns the icon drawable for this Action.

final long

Returns the id for this Action.

final @Nullable CharSequence

Returns the first line label for this Action.

final @Nullable CharSequence

Returns the second line label for this Action.

final void
removeKeyCode(int keyCode)

Removes a keycode used to invoke this Action.

final boolean
respondsToKeyCode(int keyCode)

Returns true if the Action should respond to the given keycode.

final void

Sets the icon drawable for this Action.

final void
setId(long id)

Sets the id for this Action.

final void

Sets the first line label for this Action.

final void

Sets the second line label for this Action.

@NonNull String

Public constructors

MultiAction

Added in 1.1.0
public MultiAction(int id)

Constructor

Parameters
int id

The id of the Action.

Public methods

getActionCount

Added in 1.1.0
public int getActionCount()

Returns the number of actions.

getDrawable

Added in 1.1.0
public Drawable getDrawable(int index)

Returns the drawable at the given index.

getIndex

Added in 1.1.0
public int getIndex()

Returns the current index.

getLabel

Added in 1.1.0
public String getLabel(int index)

Returns the label at the given index.

getSecondaryLabel

Added in 1.1.0
public String getSecondaryLabel(int index)

Returns the secondary label at the given index.

nextIndex

Added in 1.1.0
public void nextIndex()

Increments the index, wrapping to zero once the end is reached.

setDrawables

Added in 1.1.0
public void setDrawables(Drawable[] drawables)

Sets the array of drawables. The size of the array defines the range of valid indices for this action.

setIndex

Added in 1.1.0
public void setIndex(int index)

Sets the current index.

setLabels

Added in 1.1.0
public void setLabels(String[] labels)

Sets the array of strings used as labels. The size of the array defines the range of valid indices for this action. The labels are used to define the accessibility content description unless secondary labels are provided.

setSecondaryLabels

Added in 1.1.0
public void setSecondaryLabels(String[] labels)

Sets the array of strings used as secondary labels. These labels are used in place of the primary labels for accessibility content description only.