added in version 22.1.0
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
Known Direct Subclasses


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

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