ShuffleAction

Kotlin |Java

open class ShuffleAction : PlaybackControlsRow.MultiAction

kotlin.Any
↳	androidx.leanback.widget.Action
	↳	androidx.leanback.widget.PlaybackControlsRow.MultiAction
		↳	androidx.leanback.widget.PlaybackControlsRow.ShuffleAction

An action for displaying a shuffle icon.

Summary

Constants
static Int	`INDEX_OFF` Action index for shuffle is off
static Int	`INDEX_ON` Action index for shuffle is on.
static Int	`OFF` Action index for shuffle is off.
static Int	`ON` Action index for shuffle is on.

Inherited constants

From class Action

Long

NO_ID

Indicates that an id has not been set.

Public constructors
`<init>(context: Context!)` Constructor
`<init>(context: Context!, highlightColor: Int)` Constructor

Inherited functions

From class Action

`Unit`	`addKeyCode(keyCode: Int)` Adds a keycode used to invoke this Action.
`Drawable!`	`getIcon()` Returns the icon drawable for this Action.
`Long`	`getId()` Returns the id for this Action.
`CharSequence!`	`getLabel1()` Returns the first line label for this Action.
`CharSequence!`	`getLabel2()` Returns the second line label for this Action.
`Unit`	`removeKeyCode(keyCode: Int)` Removes a keycode used to invoke this Action.
`Boolean`	`respondsToKeyCode(keyCode: Int)` Returns true if the Action should respond to the given keycode.
`Unit`	`setIcon(icon: Drawable!)` Sets the icon drawable for this Action.
`Unit`	`setId(id: Long)` Sets the id for this Action.
`Unit`	`setLabel1(label: CharSequence!)` Sets the first line label for this Action.
`Unit`	`setLabel2(label: CharSequence!)` Sets the second line label for this Action.
`String`	`toString()`

From class MultiAction

`Int`	`getActionCount()` Returns the number of actions.
`Drawable!`	`getDrawable(index: Int)` Returns the drawable at the given index.
`Int`	`getIndex()` Returns the current index.
`String!`	`getLabel(index: Int)` Returns the label at the given index.
`String!`	`getSecondaryLabel(index: Int)` Returns the secondary label at the given index.
`Unit`	`nextIndex()` Increments the index, wrapping to zero once the end is reached.
`Unit`	`setDrawables(drawables: Array<Drawable!>!)` Sets the array of drawables. The size of the array defines the range of valid indices for this action.
`Unit`	`setIndex(index: Int)` Sets the current index.
`Unit`	`setLabels(labels: Array<String!>!)` 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.
`Unit`	`setSecondaryLabels(labels: Array<String!>!)` Sets the array of strings used as secondary labels. These labels are used in place of the primary labels for accessibility content description only.

static val INDEX_OFF: Int

Action index for shuffle is off

Value: 0

static val INDEX_ON: Int

Action index for shuffle is on.

Value: 1

static val OFF: Int

Deprecated: Use INDEX_OFF

Action index for shuffle is off.

Value: 0

static val ON: Int

Deprecated: Use INDEX_ON

Action index for shuffle is on.

Value: 1

ShuffleAction(context: Context!)

Constructor

Parameters
`context`	Context!: Context used for loading resources.

ShuffleAction(
    context: Context!, 
    highlightColor: Int)

Constructor

Parameters
`context`	Context!: Context used for loading resources.
`highlightColor`	Int: Color for the highlighted icon state.