Action
public
class
Action
extends Object
java.lang.Object | |
↳ | androidx.leanback.widget.Action |
An action contains one or two lines of text, an optional image and an optional id. It may also be invoked by one or more keycodes.
Summary
Constants | |
---|---|
long |
NO_ID
Indicates that an id has not been set. |
Public constructors | |
---|---|
Action(long id)
Constructor for an Action. |
|
Action(long id, CharSequence label)
Constructor for an Action. |
|
Action(long id, CharSequence label1, CharSequence label2)
Constructor for an Action. |
|
Action(long id, CharSequence label1, CharSequence label2, Drawable icon)
Constructor for an Action. |
Public methods | |
---|---|
final
void
|
addKeyCode(int keyCode)
Adds a keycode used to invoke this Action. |
final
Drawable
|
getIcon()
Returns the icon drawable for this Action. |
final
long
|
getId()
Returns the id for this Action. |
final
CharSequence
|
getLabel1()
Returns the first line label for this Action. |
final
CharSequence
|
getLabel2()
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
|
setIcon(Drawable icon)
Sets the icon drawable for this Action. |
final
void
|
setId(long id)
Sets the id for this Action. |
final
void
|
setLabel1(CharSequence label)
Sets the first line label for this Action. |
final
void
|
setLabel2(CharSequence label)
Sets the second line label for this Action. |
String
|
toString()
|
Inherited methods | |
---|---|
Constants
NO_ID
public static final long NO_ID
Indicates that an id has not been set.
Constant Value: -1 (0xffffffffffffffff)
Public constructors
Action
public Action (long id)
Constructor for an Action.
Parameters | |
---|---|
id |
long : The id of the Action.
|
Action
public Action (long id, CharSequence label)
Constructor for an Action.
Parameters | |
---|---|
id |
long : The id of the Action. |
label |
CharSequence : The label to display for the Action.
|
Action
public Action (long id, CharSequence label1, CharSequence label2)
Constructor for an Action.
Parameters | |
---|---|
id |
long : The id of the Action. |
label1 |
CharSequence : The label to display on the first line of the Action. |
label2 |
CharSequence : The label to display on the second line of the Action.
|
Action
public Action (long id, CharSequence label1, CharSequence label2, Drawable icon)
Constructor for an Action.
Parameters | |
---|---|
id |
long : The id of the Action. |
label1 |
CharSequence : The label to display on the first line of the Action. |
label2 |
CharSequence : The label to display on the second line of the Action. |
icon |
Drawable : The icon to display for the Action.
|
Public methods
addKeyCode
public final void addKeyCode (int keyCode)
Adds a keycode used to invoke this Action.
Parameters | |
---|---|
keyCode |
int |
getIcon
public final Drawable getIcon ()
Returns the icon drawable for this Action.
Returns | |
---|---|
Drawable |
getId
public final long getId ()
Returns the id for this Action.
Returns | |
---|---|
long |
getLabel1
public final CharSequence getLabel1 ()
Returns the first line label for this Action.
Returns | |
---|---|
CharSequence |
getLabel2
public final CharSequence getLabel2 ()
Returns the second line label for this Action.
Returns | |
---|---|
CharSequence |
removeKeyCode
public final void removeKeyCode (int keyCode)
Removes a keycode used to invoke this Action.
Parameters | |
---|---|
keyCode |
int |
respondsToKeyCode
public final boolean respondsToKeyCode (int keyCode)
Returns true if the Action should respond to the given keycode.
Parameters | |
---|---|
keyCode |
int |
Returns | |
---|---|
boolean |
setIcon
public final void setIcon (Drawable icon)
Sets the icon drawable for this Action.
Parameters | |
---|---|
icon |
Drawable |
setId
public final void setId (long id)
Sets the id for this Action.
Parameters | |
---|---|
id |
long |
setLabel1
public final void setLabel1 (CharSequence label)
Sets the first line label for this Action.
Parameters | |
---|---|
label |
CharSequence |
setLabel2
public final void setLabel2 (CharSequence label)
Sets the second line label for this Action.
Parameters | |
---|---|
label |
CharSequence |
toString
public String toString ()
Returns | |
---|---|
String |