GuidedAction.Builder

public class GuidedAction.Builder extends GuidedAction.BuilderBase


Builds a GuidedAction object.

Summary

Public constructors

This method is deprecated.

Use Builder.

Creates a Builder for GuidedAction.

Public methods

@NonNull GuidedAction

Builds the GuidedAction corresponding to this Builder.

Inherited methods

From androidx.leanback.widget.GuidedAction.BuilderBase
final void

Subclass of BuilderBase should call this function to apply values.

B
autoSaveRestoreEnabled(boolean autoSaveRestoreEnabled)

Explicitly sets auto restore feature on the GuidedAction.

B
autofillHints(@Nullable String[] hints)

Sets autofill hints.

B
checkSetId(int checkSetId)

Indicates whether this action is part of a single-select group similar to radio buttons or this action is a checkbox.

B
checked(boolean checked)

Indicates whether this action is initially checked.

B
clickAction(long id)

Construct a clickable action with associated id and auto assign pre-defined title for the action.

B

Sets the description for this action.

B
description(@StringRes int descriptionResourceId)

Sets the description for this action.

B
descriptionEditInputType(int inputType)

Sets InputType of this action description in editing.

B
descriptionEditable(boolean editable)

Indicates whether this action's description is editable

B
descriptionInputType(int inputType)

Sets InputType of this action description not in editing.

B

Sets the optional description text to edit.

B
editDescription(@StringRes int descriptionResourceId)

Sets the optional description text to edit.

B
editInputType(int inputType)

Sets InputType of this action title in editing.

B

Sets the optional title text to edit.

B
editTitle(@StringRes int editTitleResourceId)

Sets the optional title text to edit.

B
editable(boolean editable)

Indicates whether this action title is editable.

B
enabled(boolean enabled)

Indicates whether this action is enabled.

B
focusable(boolean focusable)

Indicates whether this action can take focus.

@NonNull Context

Returns Context of this Builder.

B
hasEditableActivatorView(boolean editable)

Indicates whether this action has a view can be activated to edit, e.g. a DatePicker.

B
hasNext(boolean hasNext)

Indicates whether this action has a next state and should display a chevron.

B

Sets the action's icon drawable.

B
icon(@DrawableRes int iconResourceId)

Sets the action's icon drawable by retrieving it by resource ID from Builder's context.

B
iconResourceId(@DrawableRes int iconResourceId, Context context)

This method is deprecated.

Use icon.

B
id(long id)

Sets the ID associated with this action.

B
infoOnly(boolean infoOnly)

Indicates whether this action is for information purposes only and cannot be clicked.

B
inputType(int inputType)

Sets InputType of this action title not in editing.

B

Sets the intent associated with this action.

B
multilineDescription(boolean multilineDescription)

Indicates whether the title and description are long, and should be displayed appropriately.

B

Sets sub actions list.

B

Sets the title for this action.

B
title(@StringRes int titleResourceId)

Sets the title for this action.

Public constructors

Builder

Added in 1.1.0
Deprecated in 1.1.0
public Builder()

Builder

Added in 1.1.0
public Builder(@Nullable Context context)

Creates a Builder for GuidedAction.

Parameters
@Nullable Context context

Context to build GuidedAction.

Public methods

build

Added in 1.1.0
public @NonNull GuidedAction build()

Builds the GuidedAction corresponding to this Builder.

Returns
@NonNull GuidedAction

The GuidedAction as configured through this Builder.