PlaybackControlsRow.ThumbsAction

abstract class PlaybackControlsRow.ThumbsAction : PlaybackControlsRow.MultiAction

Known direct subclasses
PlaybackControlsRow.ThumbsDownAction

An action displaying an icon for thumbs down.

PlaybackControlsRow.ThumbsUpAction

An action displaying an icon for thumbs up.


A base class for displaying a thumbs action.

Summary

Constants

const Int

Action index for the outline thumb icon.

const Int

Action index for the solid thumb icon.

const Int

This property is deprecated.

Use INDEX_OUTLINE

const Int
SOLID = 0

This property is deprecated.

Use INDEX_SOLID

Public constructors

ThumbsAction(
    id: Int,
    context: Context!,
    solidIconIndex: Int,
    outlineIconIndex: Int
)

Constructor

Inherited Constants

From androidx.leanback.widget.Action
const Long
NO_ID = -1

Indicates that an id has not been set.

Inherited functions

From androidx.leanback.widget.Action
Unit
addKeyCode(keyCode: Int)

Adds a keycode used to invoke this Action.

Drawable?

Returns the icon drawable for this Action.

Long

Returns the id for this Action.

CharSequence?

Returns the first line label for this Action.

CharSequence?

Returns the second line label for this Action.

Unit
removeKeyCode(keyCode: Int)

Removes a keycode used to invoke this Action.

Boolean

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

Sets the first line label for this Action.

Unit

Sets the second line label for this Action.

String
From androidx.leanback.widget.PlaybackControlsRow.MultiAction
Int

Returns the number of actions.

Drawable!
getDrawable(index: Int)

Returns the drawable at the given index.

Int

Returns the current index.

String!
getLabel(index: Int)

Returns the label at the given index.

String!

Returns the secondary label at the given index.

Unit

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

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

Sets the array of drawables.

Unit
setIndex(index: Int)

Sets the current index.

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

Sets the array of strings used as labels.

Unit

Sets the array of strings used as secondary labels.

Constants

INDEX_OUTLINE

Added in 1.1.0
const val INDEX_OUTLINE = 1: Int

Action index for the outline thumb icon.

INDEX_SOLID

Added in 1.1.0
const val INDEX_SOLID = 0: Int

Action index for the solid thumb icon.

OUTLINE

Added in 1.1.0
Deprecated in 1.1.0
const val OUTLINE = 1: Int

Action index for the outline thumb icon.

SOLID

Added in 1.1.0
Deprecated in 1.1.0
const val SOLID = 0: Int

Action index for the solid thumb icon.

Public constructors

ThumbsAction

Added in 1.1.0
ThumbsAction(
    id: Int,
    context: Context!,
    solidIconIndex: Int,
    outlineIconIndex: Int
)

Constructor

Parameters
context: Context!

Context used for loading resources.