BuilderBase
abstract class BuilderBase<B : GuidedAction.BuilderBase<GuidedAction.BuilderBase<*>>!>
kotlin.Any | |
↳ | androidx.leanback.widget.GuidedAction.BuilderBase |
Base builder class to build a GuidedAction
object. When subclass GuidedAction, you can override this BuilderBase class, implements your build() method which should call applyValues(GuidedAction)
. When using GuidedAction directly, use Builder
.
Summary
Public constructors |
|
---|---|
Creates a BuilderBase for GuidedAction or its subclass. |
Public methods |
|
---|---|
open B |
autoSaveRestoreEnabled(autoSaveRestoreEnabled: Boolean) Explicitly sets auto restore feature on the GuidedAction. |
open B |
autofillHints(vararg hints: String!) Sets autofill hints. |
open 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. |
open B |
Indicates whether this action is initially checked. |
open B |
clickAction(id: Long) Construct a clickable action with associated id and auto assign pre-defined title for the action. |
open B |
description(description: CharSequence!) Sets the description for this action. |
open B |
description(@StringRes descriptionResourceId: Int) Sets the description for this action. |
open B |
descriptionEditInputType(inputType: Int) Sets |
open B |
descriptionEditable(editable: Boolean) Indicates whether this action's description is editable |
open B |
descriptionInputType(inputType: Int) Sets |
open B |
editDescription(description: CharSequence!) Sets the optional description text to edit. |
open B |
editDescription(@StringRes descriptionResourceId: Int) Sets the optional description text to edit. |
open B |
editInputType(inputType: Int) Sets |
open B |
editTitle(editTitle: CharSequence!) Sets the optional title text to edit. |
open B |
Sets the optional title text to edit. |
open B |
Indicates whether this action title is editable. |
open B |
Indicates whether this action is enabled. |
open B |
Indicates whether this action can take focus. |
open Context! |
Returns Context of this Builder. |
open B |
hasEditableActivatorView(editable: Boolean) Indicates whether this action has a view can be activated to edit, e. |
open B |
Indicates whether this action has a next state and should display a chevron. |
open B |
Sets the action's icon drawable. |
open B |
Sets the action's icon drawable by retrieving it by resource ID from Builder's context. |
open B |
iconResourceId(@DrawableRes iconResourceId: Int, context: Context!) Sets the action's icon drawable by retrieving it by resource ID from the specified context. |
open B |
Sets the ID associated with this action. |
open B |
Indicates whether this action is for information purposes only and cannot be clicked. |
open B |
Sets |
open B |
Sets the intent associated with this action. |
open B |
multilineDescription(multilineDescription: Boolean) Indicates whether the title and description are long, and should be displayed appropriately. |
open B |
subActions(subActions: MutableList<GuidedAction!>!) Sets sub actions list. |
open B |
title(title: CharSequence!) Sets the title for this action. |
open B |
Sets the title for this action. |
Protected methods |
|
---|---|
Unit |
applyValues(action: GuidedAction!) Subclass of BuilderBase should call this function to apply values. |
Public constructors
<init>
BuilderBase(context: Context!)
Creates a BuilderBase for GuidedAction or its subclass.
Parameters | |
---|---|
context |
Context!: Context object used to build the GuidedAction. |
Public methods
autoSaveRestoreEnabled
open fun autoSaveRestoreEnabled(autoSaveRestoreEnabled: Boolean): B
Explicitly sets auto restore feature on the GuidedAction. It's by default true.
Parameters | |
---|---|
autoSaveRestoreEnabled |
Boolean: True if turn on auto save/restore of GuidedAction content, false otherwise. |
Return | |
---|---|
B: The same BuilderBase object. |
autofillHints
open fun autofillHints(vararg hints: String!): B
Sets autofill hints. See android.view.View#setAutofillHints
Parameters | |
---|---|
hints |
String!: List of hints for autofill. |
Return | |
---|---|
B: The same BuilderBase object. |
checkSetId
open fun checkSetId(checkSetId: Int): B
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.
Parameters | |
---|---|
checkSetId |
Int: The check set ID, or GuidedAction#NO_CHECK_SET to indicate not radio or checkbox, or GuidedAction#CHECKBOX_CHECK_SET_ID to indicate a checkbox. |
checked
open fun checked(checked: Boolean): B
Indicates whether this action is initially checked.
Parameters | |
---|---|
checked |
Boolean: Whether this action is checked. |
clickAction
open fun clickAction(id: Long): B
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.
Parameters | |
---|---|
id |
Long: One of GuidedAction#ACTION_ID_OK GuidedAction#ACTION_ID_CANCEL GuidedAction#ACTION_ID_FINISH GuidedAction#ACTION_ID_CONTINUE GuidedAction#ACTION_ID_YES GuidedAction#ACTION_ID_NO . |
Return | |
---|---|
B: The same BuilderBase object. |
description
open fun description(description: CharSequence!): B
Sets the description for this action. The description is typically a longer string providing extra information on what the action will do.
Parameters | |
---|---|
description |
CharSequence!: The description for this action. |
description
open fun description(@StringRes descriptionResourceId: Int): B
Sets the description for this action. The description is typically a longer string providing extra information on what the action will do.
Parameters | |
---|---|
descriptionResourceId |
Int: String resource id of the description for this action. |
descriptionEditInputType
open fun descriptionEditInputType(inputType: Int): B
Sets InputType
of this action description in editing.
Parameters | |
---|---|
inputType |
Int: InputType for the action description in editing. |
descriptionEditable
open fun descriptionEditable(editable: Boolean): B
Indicates whether this action's description is editable
Parameters | |
---|---|
editable |
Boolean: Whether this action description is editable. |
descriptionInputType
open fun descriptionInputType(inputType: Int): B
Sets InputType
of this action description not in editing.
Parameters | |
---|---|
inputType |
Int: InputType for the action description not in editing. |
editDescription
open fun editDescription(description: CharSequence!): B
Sets the optional description text to edit. When TextView is activated, the edit description replaces the string of description.
Parameters | |
---|---|
description |
CharSequence!: The description to edit for this action. |
editDescription
open fun editDescription(@StringRes descriptionResourceId: Int): B
Sets the optional description text to edit. When TextView is activated, the edit description replaces the string of description.
Parameters | |
---|---|
descriptionResourceId |
Int: String resource id of the description to edit for this action. |
editInputType
open fun editInputType(inputType: Int): B
Sets InputType
of this action title in editing.
Parameters | |
---|---|
inputType |
Int: InputType for the action title in editing. |
editTitle
open fun editTitle(editTitle: CharSequence!): B
Sets the optional title text to edit. When TextView is activated, the edit title replaces the string of title.
Parameters | |
---|---|
editTitle |
CharSequence!: The optional title text to edit when TextView is activated. |
editTitle
open fun editTitle(@StringRes editTitleResourceId: Int): B
Sets the optional title text to edit. When TextView is activated, the edit title replaces the string of title.
Parameters | |
---|---|
editTitleResourceId |
Int: String resource id of the optional title text to edit when TextView is activated. |
editable
open fun editable(editable: Boolean): B
Indicates whether this action title is editable. Note: Editable actions cannot also be checked, or belong to a check set.
Parameters | |
---|---|
editable |
Boolean: Whether this action is editable. |
enabled
open fun enabled(enabled: Boolean): B
Indicates whether this action is enabled. If not enabled, an action cannot be clicked.
Parameters | |
---|---|
enabled |
Boolean: Whether the action is enabled. |
focusable
open fun focusable(focusable: Boolean): B
Indicates whether this action can take focus.
Parameters | |
---|---|
focusable |
Boolean: |
Return | |
---|---|
B: The same BuilderBase object. |
getContext
open fun getContext(): Context!
Returns Context of this Builder.
Return | |
---|---|
Context!: Context of this Builder. |
hasEditableActivatorView
open fun hasEditableActivatorView(editable: Boolean): B
Indicates whether this action has a view can be activated to edit, e.g. a DatePicker.
Parameters | |
---|---|
editable |
Boolean: Whether this action has view can be activated to edit. |
hasNext
open fun hasNext(hasNext: Boolean): B
Indicates whether this action has a next state and should display a chevron.
Parameters | |
---|---|
hasNext |
Boolean: Whether this action has a next state. |
icon
open fun icon(icon: Drawable!): B
Sets the action's icon drawable.
Parameters | |
---|---|
icon |
Drawable!: The drawable for the icon associated with this action. |
icon
open fun icon(@DrawableRes iconResourceId: Int): B
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)
.
Parameters | |
---|---|
iconResourceId |
Int: The resource ID for the icon associated with this action. |
iconResourceId
open funiconResourceId(@DrawableRes iconResourceId: Int, context: Context!): B
Deprecated: Use icon(int)
.
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)
.
Parameters | |
---|---|
iconResourceId |
Int: The resource ID for the icon associated with this action. |
context |
Int: The context whose resource ID should be retrieved. |
id
open fun id(id: Long): B
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.
Parameters | |
---|---|
id |
Long: The ID to associate with this action. |
infoOnly
open fun infoOnly(infoOnly: Boolean): B
Indicates whether this action is for information purposes only and cannot be clicked.
Parameters | |
---|---|
infoOnly |
Boolean: Whether this action has a next state. |
inputType
open fun inputType(inputType: Int): B
Sets InputType
of this action title not in editing.
Parameters | |
---|---|
inputType |
Int: InputType for the action title not in editing. |
intent
open fun intent(intent: Intent!): B
Sets the intent associated with this action. Clients would typically fire this intent directly when the action is clicked.
Parameters | |
---|---|
intent |
Intent!: The intent associated with this action. |
multilineDescription
open fun multilineDescription(multilineDescription: Boolean): B
Indicates whether the title and description are long, and should be displayed appropriately.
Parameters | |
---|---|
multilineDescription |
Boolean: Whether this action has a multiline description. |
subActions
open fun subActions(subActions: MutableList<GuidedAction!>!): B
Sets sub actions list.
Parameters | |
---|---|
subActions |
MutableList<GuidedAction!>!: |
Return | |
---|---|
B: The same BuilderBase object. |
title
open fun title(title: CharSequence!): B
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".
Parameters | |
---|---|
title |
CharSequence!: The title for this action. |
title
open fun title(@StringRes titleResourceId: Int): B
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".
Parameters | |
---|---|
titleResourceId |
Int: The resource id of title for this action. |
Protected methods
applyValues
protected fun applyValues(action: GuidedAction!): Unit
Subclass of BuilderBase should call this function to apply values.
Parameters | |
---|---|
action |
GuidedAction!: GuidedAction to apply BuilderBase values. |