belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
GuidedAction
public
class
GuidedAction
extends Action
java.lang.Object | ||
↳ | android.support.v17.leanback.widget.Action | |
↳ | android.support.v17.leanback.widget.GuidedAction |
![]() |
A data class which represents an action within a GuidedStepFragment
. GuidedActions contain at minimum a title
and a description, and typically also an icon.
A GuidedAction typically represents a single action a user may take, but may also represent a possible choice out of a group of mutually exclusive choices (similar to radio buttons), or an information-only label (in which case the item cannot be clicked).
GuidedActions may optionally be checked. They may also indicate that they will request further user input on selection, in which case they will be displayed with a chevron indicator.
GuidedAction recommends to use GuidedAction.Builder
. When application subclass GuidedAction, it
can subclass GuidedAction.BuilderBase
, implement its own builder() method where it should
call applyValues(GuidedAction)
.
Summary
Nested classes | |
---|---|
class |
GuidedAction.Builder
Builds a |
class |
GuidedAction.BuilderBase<B extends BuilderBase>
Base builder class to build a |
Constants | |
---|---|
long |
ACTION_ID_CANCEL
Id of standard Cancel action. |
long |
ACTION_ID_CONTINUE
Id of standard Finish action. |
long |
ACTION_ID_CURRENT
When finishing editing, stay on current action. |
long |
ACTION_ID_FINISH
Id of standard Finish action. |
long |
ACTION_ID_NEXT
When finishing editing, goes to next action. |
long |
ACTION_ID_NO
Id of standard No action. |
long |
ACTION_ID_OK
Id of standard OK action. |
long |
ACTION_ID_YES
Id of standard Yes action. |
int |
CHECKBOX_CHECK_SET_ID
Checkset Id for checkbox. |
int |
DEFAULT_CHECK_SET_ID
Default checkset Id for radio. |
int |
NO_CHECK_SET
Special check set Id that is neither checkbox nor radio. |
Inherited constants |
---|
![]()
android.support.v17.leanback.widget.Action
|
Protected constructors | |
---|---|
GuidedAction()
|
Public methods | |
---|---|
int
|
getCheckSetId()
Returns the check set id this action is a part of. |
CharSequence
|
getDescription()
Returns the description of this action. |
int
|
getDescriptionEditInputType()
Returns InputType of action description in editing; only valid when
|
int
|
getDescriptionInputType()
Returns InputType of action description not in editing. |
CharSequence
|
getEditDescription()
Returns the optional description text to edit. |
int
|
getEditInputType()
Returns InputType of action title in editing; only valid when |
CharSequence
|
getEditTitle()
Returns the optional title text to edit. |
int
|
getInputType()
Returns InputType of action title not in editing. |
Intent
|
getIntent()
Returns the intent associated with this action. |
List<GuidedAction>
|
getSubActions()
|
CharSequence
|
getTitle()
Returns the title of this action. |
boolean
|
hasEditableActivatorView()
Returns whether this action can be activated to edit, e.g. |
boolean
|
hasMultilineDescription()
Returns whether this action is has a multiline description. |
boolean
|
hasNext()
Returns whether this action will request further user input when selected, such as showing another GuidedStepFragment or launching a new activity. |
boolean
|
hasSubActions()
|
boolean
|
hasTextEditable()
Returns if this action has editable title or editable description. |
boolean
|
infoOnly()
Returns whether the action will only display information and is thus not clickable. |
final
boolean
|
isAutoSaveRestoreEnabled()
Returns true if Action will be saved to instanceState and restored later, false otherwise. |
boolean
|
isChecked()
Returns whether this action is checked. |
boolean
|
isDescriptionEditable()
Returns whether this action description is editable. |
boolean
|
isEditTitleUsed()
Returns true if |
boolean
|
isEditable()
Returns whether this action title is editable. |
boolean
|
isEnabled()
Returns whether this action is enabled. |
boolean
|
isFocusable()
Returns whether this action is focusable. |
void
|
onRestoreInstanceState(Bundle bundle, String key)
Restore action from a bundle using a given key. |
void
|
onSaveInstanceState(Bundle bundle, String key)
Save action into a bundle using a given key. |
void
|
setChecked(boolean checked)
Sets whether this action is checked. |
void
|
setDescription(CharSequence description)
Sets the description of this action. |
void
|
setEditDescription(CharSequence editDescription)
Sets the optional description text to edit instead of |
void
|
setEditTitle(CharSequence editTitle)
Sets the optional title text to edit instead of |
void
|
setEnabled(boolean enabled)
Sets whether this action is enabled. |
void
|
setFocusable(boolean focusable)
Sets whether this action is focusable. |
void
|
setIntent(Intent intent)
Sets the intent of this action. |
void
|
setSubActions(List<GuidedAction> actions)
Change sub actions list. |
void
|
setTitle(CharSequence title)
Sets the title of this action. |
Inherited methods | |
---|---|
![]()
android.support.v17.leanback.widget.Action
| |
![]()
java.lang.Object
|
Constants
ACTION_ID_CANCEL
long ACTION_ID_CANCEL
Id of standard Cancel action.
Constant Value: -5 (0xfffffffffffffffb)
ACTION_ID_CONTINUE
long ACTION_ID_CONTINUE
Id of standard Finish action.
Constant Value: -7 (0xfffffffffffffff9)
ACTION_ID_CURRENT
long ACTION_ID_CURRENT
When finishing editing, stay on current action.
Constant Value: -3 (0xfffffffffffffffd)
ACTION_ID_FINISH
long ACTION_ID_FINISH
Id of standard Finish action.
Constant Value: -6 (0xfffffffffffffffa)
ACTION_ID_NEXT
long ACTION_ID_NEXT
When finishing editing, goes to next action.
Constant Value: -2 (0xfffffffffffffffe)
ACTION_ID_NO
long ACTION_ID_NO
Id of standard No action.
Constant Value: -9 (0xfffffffffffffff7)
ACTION_ID_OK
long ACTION_ID_OK
Id of standard OK action.
Constant Value: -4 (0xfffffffffffffffc)
ACTION_ID_YES
long ACTION_ID_YES
Id of standard Yes action.
Constant Value: -8 (0xfffffffffff