GuidedAction.BuilderBase

BuilderBase(context: Context)

Creates a BuilderBase for GuidedAction or its subclass.

fun autoSaveRestoreEnabled(autoSaveRestoreEnabled: Boolean): B!

Explicitly sets auto restore feature on the GuidedAction. It's by default true.

fun autofillHints(hints: Array<String!>?): B!

Sets autofill hints. See setAutofillHints

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.

fun checked(checked: Boolean): B!

Indicates whether this action is initially checked.

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.

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.

fun description(descriptionResourceId: @StringRes Int): B!

Sets the description for this action. The description is typically a longer string providing extra information on what the action will do.

fun descriptionEditInputType(inputType: Int): B!

Sets InputType of this action description in editing.

fun descriptionEditable(editable: Boolean): B!

Indicates whether this action's description is editable

fun descriptionInputType(inputType: Int): B!

Sets InputType of this action description not in editing.

fun editDescription(description: CharSequence?): B!

Sets the optional description text to edit. When TextView is activated, the edit description replaces the string of description.

fun editDescription(descriptionResourceId: @StringRes Int): B!

Sets the optional description text to edit. When TextView is activated, the edit description replaces the string of description.

fun editInputType(inputType: Int): B!

Sets InputType of this action title in editing.

fun editTitle(editTitle: CharSequence?): B!

Sets the optional title text to edit. When TextView is activated, the edit title replaces the string of title.

fun editTitle(editTitleResourceId: @StringRes Int): B!

Sets the optional title text to edit. When TextView is activated, the edit title replaces the string of title.

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.

fun enabled(enabled: Boolean): B!

Indicates whether this action is enabled. If not enabled, an action cannot be clicked.

fun focusable(focusable: Boolean): B!

Indicates whether this action can take focus.

fun getContext(): Context

Returns Context of this Builder.

fun hasEditableActivatorView(editable: Boolean): B!

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

fun hasNext(hasNext: Boolean): B!

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

fun icon(icon: Drawable?): B!

Sets the action's icon drawable.

fun icon(iconResourceId: @DrawableRes 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.

fun iconResourceId(iconResourceId: @DrawableRes Int, context: Context!): B!

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.

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.

fun infoOnly(infoOnly: Boolean): B!

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

fun inputType(inputType: Int): B!

Sets InputType of this action title not in editing.

fun intent(intent: Intent?): B!

Sets the intent associated with this action. Clients would typically fire this intent directly when the action is clicked.

fun multilineDescription(multilineDescription: Boolean): B!

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

fun subActions(subActions: (Mutable)List<GuidedAction!>?): B!

Sets sub actions list.

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".

fun title(titleResourceId: @StringRes 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".

protected fun applyValues(action: GuidedAction): Unit

Subclass of BuilderBase should call this function to apply values.