PlaybackControlsRow.MultiAction
public
static
abstract
class
PlaybackControlsRow.MultiAction
extends Action
java.lang.Object | ||
↳ | androidx.leanback.widget.Action | |
↳ | androidx.leanback.widget.PlaybackControlsRow.MultiAction |
Base class for an action comprised of a series of icons.
Summary
Inherited constants |
---|
Public constructors | |
---|---|
MultiAction(int id)
Constructor |
Public methods | |
---|---|
int
|
getActionCount()
Returns the number of actions. |
Drawable
|
getDrawable(int index)
Returns the drawable at the given index. |
int
|
getIndex()
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
|
nextIndex()
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 methods | |
---|---|
Public constructors
MultiAction
public MultiAction (int id)
Constructor
Parameters | |
---|---|
id |
int : The id of the Action.
|
Public methods
getActionCount
public int getActionCount ()
Returns the number of actions.
Returns | |
---|---|
int |
getDrawable
public Drawable getDrawable (int index)
Returns the drawable at the given index.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
Drawable |
getIndex
public int getIndex ()
Returns the current index.
Returns | |
---|---|
int |
getLabel
public String getLabel (int index)
Returns the label at the given index.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
String |
getSecondaryLabel
public String getSecondaryLabel (int index)
Returns the secondary label at the given index.
Parameters | |
---|---|
index |
int |
Returns | |
---|---|
String |
nextIndex
public void nextIndex ()
Increments the index, wrapping to zero once the end is reached.
setDrawables
public void setDrawables (Drawable[] drawables)
Sets the array of drawables. The size of the array defines the range of valid indices for this action.
Parameters | |
---|---|
drawables |
Drawable |
setIndex
public void setIndex (int index)
Sets the current index.
Parameters | |
---|---|
index |
int |
setLabels
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.
Parameters | |
---|---|
labels |
String |
setSecondaryLabels
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.
Parameters | |
---|---|
labels |
String |