MultiAction

Kotlin |Java

abstract class MultiAction : Action

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

Known Direct Subclasses

PlaybackControlsRow.ClosedCaptioningAction, PlaybackControlsRow.FastForwardAction, PlaybackControlsRow.HighQualityAction, PlaybackControlsRow.PlayPauseAction, PlaybackControlsRow.RepeatAction, PlaybackControlsRow.RewindAction, PlaybackControlsRow.ShuffleAction, PlaybackControlsRow.ThumbsAction

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, PlaybackControlsRow.ThumbsUpAction

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

Inherited constants

From class Action

Long

NO_ID

Indicates that an id has not been set.

Public constructors
`<init>(id: Int)` Constructor

Public methods
open Int	`getActionCount()` Returns the number of actions.
open Drawable!	`getDrawable(index: Int)` Returns the drawable at the given index.
open Int	`getIndex()` Returns the current index.
open String!	`getLabel(index: Int)` Returns the label at the given index.
open String!	`getSecondaryLabel(index: Int)` Returns the secondary label at the given index.
open Unit	`nextIndex()` Increments the index, wrapping to zero once the end is reached.
open Unit	`setDrawables(drawables: Array<Drawable!>!)` Sets the array of drawables.
open Unit	`setIndex(index: Int)` Sets the current index.
open Unit	`setLabels(labels: Array<String!>!)` Sets the array of strings used as labels.
open Unit	`setSecondaryLabels(labels: Array<String!>!)` Sets the array of strings used as secondary labels.

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()`

Public constructors

<init>

MultiAction(id: Int)

Constructor

Parameters
`id`	Int: The id of the Action.

Public methods

getActionCount

open fun getActionCount(): Int

Returns the number of actions.

getDrawable

open fun getDrawable(index: Int): Drawable!

Returns the drawable at the given index.

getIndex

open fun getIndex(): Int

Returns the current index.

getLabel

open fun getLabel(index: Int): String!

Returns the label at the given index.

getSecondaryLabel

open fun getSecondaryLabel(index: Int): String!

Returns the secondary label at the given index.

nextIndex

open fun nextIndex(): Unit

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

setDrawables

open fun setDrawables(drawables: Array<Drawable!>!): Unit

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

setIndex

open fun setIndex(index: Int): Unit

Sets the current index.

setLabels

open fun setLabels(labels: Array<String!>!): Unit

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

open fun setSecondaryLabels(labels: Array<String!>!): Unit

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