public
class
Action
extends Object
| java.lang.Object | |
| ↳ | android.support.v17.leanback.widget.Action |
 Known Direct Subclasses
|
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.
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()
Returns a string representation of the object. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
long NO_ID
Indicates that an id has not been set.
Constant Value: -1 (0xffffffffffffffff)
Action (long id)
Constructor for an Action.
| Parameters | |
|---|---|
id |
long:
The id of the Action.
|
Developers
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 (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 (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.
|
void addKeyCode (int keyCode)
Adds a keycode used to invoke this Action.
| Parameters | |
|---|---|
keyCode |
int
|
long getId ()
Returns the id for this Action.
| Returns | |
|---|---|
long |
|
CharSequence getLabel1 ()
Returns the first line label for this Action.
| Returns | |
|---|---|
CharSequence |
|
CharSequence getLabel2 ()
Returns the second line label for this Action.
| Returns | |
|---|---|
CharSequence |
|
void removeKeyCode (int keyCode)
Removes a keycode used to invoke this Action.
| Parameters | |
|---|---|
keyCode |
int
|
boolean respondsToKeyCode (int keyCode)
Returns true if the Action should respond to the given keycode.
| Parameters | |
|---|---|
keyCode |
int
|
| Returns | |
|---|---|
boolean |
|
void setIcon (Drawable icon)
Sets the icon drawable for this Action.
| Parameters | |
|---|---|
icon |
Drawable
|
void setId (long id)
Sets the id for this Action.
| Parameters | |
|---|---|
id |
long
|
void setLabel1 (CharSequence label)
Sets the first line label for this Action.
| Parameters | |
|---|---|
label |
CharSequence
|
void setLabel2 (CharSequence label)
Sets the second line label for this Action.
| Parameters | |
|---|---|
label |
CharSequence
|
String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |