Builder

Kotlin |Java

open class Builder : GuidedAction.BuilderBase<GuidedAction.Builder!>

kotlin.Any
↳	androidx.leanback.widget.GuidedAction.BuilderBase<androidx.leanback.widget.GuidedAction.Builder>
	↳	androidx.leanback.widget.GuidedAction.Builder

Builds a GuidedAction object.

Summary

Public constructors
`<init>()`
`<init>(context: Context!)` Creates a Builder for GuidedAction.

Public methods
open GuidedAction!	`build()` Builds the GuidedAction corresponding to this Builder.

Inherited functions

From class BuilderBase

`Unit`	`applyValues(action: GuidedAction!)` Subclass of BuilderBase should call this function to apply values.
`B`	`autoSaveRestoreEnabled(autoSaveRestoreEnabled: Boolean)` Explicitly sets auto restore feature on the GuidedAction. It's by default true.
`B`	`autofillHints(vararg hints: String!)` Sets autofill hints. See `android.view.View#setAutofillHints`
`B`	`checkSetId(checkSetId: Int)` Indicates whether this action is part of a single-select group similar to radio buttons or this action is a checkbox. When one item in a check set is checked, all others with the same check set ID will be checked automatically.
`B`	`checked(checked: Boolean)` Indicates whether this action is initially checked.
`B`	`clickAction(id: Long)` Construct a clickable action with associated id and auto assign pre-defined title for the action. If the id is not supported, the method simply does nothing.
`B`	`description(description: CharSequence!)` Sets the description for this action. The description is typically a longer string providing extra information on what the action will do.
`B`	`description(@StringRes descriptionResourceId: Int)` Sets the description for this action. The description is typically a longer string providing extra information on what the action will do.
`B`	`descriptionEditInputType(inputType: Int)` Sets `InputType` of this action description in editing.
`B`	`descriptionEditable(editable: Boolean)` Indicates whether this action's description is editable
`B`	`descriptionInputType(inputType: Int)` Sets `InputType` of this action description not in editing.
`B`	`editDescription(description: CharSequence!)` Sets the optional description text to edit. When TextView is activated, the edit description replaces the string of description.
`B`	`editDescription(@StringRes descriptionResourceId: Int)` Sets the optional description text to edit. When TextView is activated, the edit description replaces the string of description.
`B`	`editInputType(inputType: Int)` Sets `InputType` of this action title in editing.
`B`	`editTitle(editTitle: CharSequence!)` Sets the optional title text to edit. When TextView is activated, the edit title replaces the string of title.
`B`	`editTitle(@StringRes editTitleResourceId: Int)` Sets the optional title text to edit. When TextView is activated, the edit title replaces the string of title.
`B`	`editable(editable: Boolean)` Indicates whether this action title is editable. Note: Editable actions cannot also be checked, or belong to a check set.
`B`	`enabled(enabled: Boolean)` Indicates whether this action is enabled. If not enabled, an action cannot be clicked.
`B`	`focusable(focusable: Boolean)` Indicates whether this action can take focus.
`Context!`	`getContext()` Returns Context of this Builder.
`B`	`hasEditableActivatorView(editable: Boolean)` Indicates whether this action has a view can be activated to edit, e.g. a DatePicker.
`B`	`hasNext(hasNext: Boolean)` Indicates whether this action has a next state and should display a chevron.
`B`	`icon(icon: Drawable!)` Sets the action's icon drawable.
`B`	`icon(@DrawableRes iconResourceId: Int)` Sets the action's icon drawable by retrieving it by resource ID from Builder's context. This is a convenience function that simply looks up the drawable and calls `icon(Drawable)`.
`B`	`iconResourceId(@DrawableRes iconResourceId: Int, context: Context!)` Sets the action's icon drawable by retrieving it by resource ID from the specified context. This is a convenience function that simply looks up the drawable and calls `icon(Drawable)`.
`B`	`id(id: Long)` Sets the ID associated with this action. The ID can be any value the client wishes; it is typically used to determine what to do when an action is clicked.
`B`	`infoOnly(infoOnly: Boolean)` Indicates whether this action is for information purposes only and cannot be clicked.
`B`	`inputType(inputType: Int)` Sets `InputType` of this action title not in editing.
`B`	`intent(intent: Intent!)` Sets the intent associated with this action. Clients would typically fire this intent directly when the action is clicked.
`B`	`multilineDescription(multilineDescription: Boolean)` Indicates whether the title and description are long, and should be displayed appropriately.
`B`	`subActions(subActions: MutableList<GuidedAction!>!)` Sets sub actions list.
`B`	`title(title: CharSequence!)` Sets the title for this action. The title is typically a short string indicating the action to be taken on click, e.g. "Continue" or "Cancel".
`B`	`title(@StringRes titleResourceId: Int)` Sets the title for this action. The title is typically a short string indicating the action to be taken on click, e.g. "Continue" or "Cancel".

Public constructors

<init>

Builder()

Deprecated: Use GuidedAction.Builder#Builder(Context).

<init>

Builder(context: Context!)

Creates a Builder for GuidedAction.

Parameters
`context`	Context!: Context to build GuidedAction.

Public methods

build

open fun build(): GuidedAction!

Builds the GuidedAction corresponding to this Builder.

Return
`GuidedAction!`	The GuidedAction as configured through this Builder.