added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

Summary: Nested Classes | Constants | Inherited Constants | Protected Ctors | Methods | Inherited Methods | [Expand All]

GuidedAction

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class GuidedAction
extends Action

java.lang.Object
↳	android.support.v17.leanback.widget.Action
	↳	android.support.v17.leanback.widget.GuidedAction

Known Direct Subclasses GuidedDatePickerAction GuidedDatePickerAction Subclass of GuidedAction that can choose a date.

---

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 GuidedAction object.
class	GuidedAction.BuilderBase<B extends BuilderBase> Base builder class to build a GuidedAction object.

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
From class android.support.v17.leanback.widget.Action long NO_ID Indicates that an id has not been set.

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 isDescriptionEditable() is true.
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 isEditable() is true.
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 getEditTitle() is not null.
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 setDescription(CharSequence).
void	setEditTitle(CharSequence editTitle) Sets the optional title text to edit instead of setTitle(CharSequence).
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
From class android.support.v17.leanback.widget.Action 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()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Constants

ACTION_ID_CANCEL

added in version 24.1.0

long ACTION_ID_CANCEL

Id of standard Cancel action.

Constant Value: -5 (0xfffffffffffffffb)

ACTION_ID_CONTINUE

added in version 24.1.0

long ACTION_ID_CONTINUE

Id of standard Finish action.

Constant Value: -7 (0xfffffffffffffff9)

ACTION_ID_CURRENT

added in version 24.1.0

long ACTION_ID_CURRENT

When finishing editing, stay on current action.

Constant Value: -3 (0xfffffffffffffffd)

ACTION_ID_FINISH

added in version 24.1.0

long ACTION_ID_FINISH

Id of standard Finish action.

Constant Value: -6 (0xfffffffffffffffa)

ACTION_ID_NEXT

added in version 24.1.0

long ACTION_ID_NEXT

When finishing editing, goes to next action.

Constant Value: -2 (0xfffffffffffffffe)

ACTION_ID_NO

added in version 24.1.0

long ACTION_ID_NO

Id of standard No action.

Constant Value: -9 (0xfffffffffffffff7)

ACTION_ID_OK

added in version 24.1.0

long ACTION_ID_OK

Id of standard OK action.

Constant Value: -4 (0xfffffffffffffffc)

ACTION_ID_YES

added in version 24.1.0

long ACTION_ID_YES

Id of standard Yes action.

Constant Value: -8 (0xfffffffffff