GuidedAction

Kotlin |Java

open class GuidedAction : Action

kotlin.Any
↳	androidx.leanback.widget.Action
	↳	androidx.leanback.widget.GuidedAction

Known Direct Subclasses

GuidedDatePickerAction

Subclass of GuidedAction that can choose a date.

A data class which represents an action within a . 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 Builder. When application subclass GuidedAction, it can subclass BuilderBase, implement its own builder() method where it should call BuilderBase#applyValues(GuidedAction).

Summary

Nested classes
open	`Builder` Builds a `GuidedAction` object.
abstract	`BuilderBase` Base builder class to build a `GuidedAction` object.

Constants
static Long	`ACTION_ID_CANCEL` Id of standard Cancel action.
static Long	`ACTION_ID_CONTINUE` Id of standard Finish action.
static Long	`ACTION_ID_CURRENT` When finishing editing, stay on current action.
static Long	`ACTION_ID_FINISH` Id of standard Finish action.
static Long	`ACTION_ID_NEXT` When finishing editing, goes to next action.
static Long	`ACTION_ID_NO` Id of standard No action.
static Long	`ACTION_ID_OK` Id of standard OK action.
static Long	`ACTION_ID_YES` Id of standard Yes action.
static Int	`CHECKBOX_CHECK_SET_ID` Checkset Id for checkbox.
static Int	`DEFAULT_CHECK_SET_ID` Default checkset Id for radio.
static Int	`NO_CHECK_SET` Special check set Id that is neither checkbox nor radio.

Inherited constants

From class Action

Long

NO_ID

Indicates that an id has not been set.

Protected constructors
`<init>()`

Public methods
open Array<String!>!	`getAutofillHints()` Returns autofill hints, see `android.view.View#setAutofillHints(String...)`.
open Int	`getCheckSetId()` Returns the check set id this action is a part of.
open CharSequence!	`getDescription()` Returns the description of this action.
open Int	`getDescriptionEditInputType()` Returns InputType of action description in editing; only valid when `isDescriptionEditable()` is true.
open Int	`getDescriptionInputType()` Returns InputType of action description not in editing.
open CharSequence!	`getEditDescription()` Returns the optional description text to edit.
open Int	`getEditInputType()` Returns InputType of action title in editing; only valid when `isEditable()` is true.
open CharSequence!	`getEditTitle()` Returns the optional title text to edit.
open Int	`getInputType()` Returns InputType of action title not in editing.
open Intent!	`getIntent()` Returns the intent associated with this action.
open MutableList<GuidedAction!>!	`getSubActions()`
open CharSequence!	`getTitle()` Returns the title of this action.
open Boolean	`hasEditableActivatorView()` Returns whether this action can be activated to edit, e.
open Boolean	`hasMultilineDescription()` Returns whether this action is has a multiline description.
open Boolean	`hasNext()` Returns whether this action will request further user input when selected, such as showing another GuidedStepFragment or launching a new activity.
open Boolean	`hasSubActions()`
open Boolean	`hasTextEditable()` Returns if this action has editable title or editable description.
open Boolean	`infoOnly()` Returns whether the action will only display information and is thus not clickable.
Boolean	`isAutoSaveRestoreEnabled()` Returns true if Action will be saved to instanceState and restored later, false otherwise.
open Boolean	`isChecked()` Returns whether this action is checked.
open Boolean	`isDescriptionEditable()` Returns whether this action description is editable.
open Boolean	`isEditTitleUsed()` Returns true if `getEditTitle()` is not null.
open Boolean	`isEditable()` Returns whether this action title is editable.
open Boolean	`isEnabled()` Returns whether this action is enabled.
open Boolean	`isFocusable()` Returns whether this action is focusable.
open Unit	`onRestoreInstanceState(bundle: Bundle!, key: String!)` Restore action from a bundle using a given key.