GuidedAction.BuilderBase

public BuilderBase(@NonNull Context context)

Creates a BuilderBase for GuidedAction or its subclass.

public B autoSaveRestoreEnabled(boolean autoSaveRestoreEnabled)

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

public B autofillHints(@Nullable String[] hints)

Sets autofill hints. See setAutofillHints

public 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. When one item in a check set is checked, all others with the same check set ID will be checked automatically.

public B checked(boolean checked)

Indicates whether this action is initially checked.

public B clickAction(long id)

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.

public B description(@Nullable CharSequence description)

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

public B description(@StringRes int descriptionResourceId)

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

public B descriptionEditInputType(int inputType)

Sets InputType of this action description in editing.

public B descriptionEditable(boolean editable)

Indicates whether this action's description is editable

public B descriptionInputType(int inputType)

Sets InputType of this action description not in editing.

public B editDescription(@Nullable CharSequence description)

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

public B editDescription(@StringRes int descriptionResourceId)

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

public B editInputType(int inputType)

Sets InputType of this action title in editing.

public B editTitle(@Nullable CharSequence editTitle)

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

public B editTitle(@StringRes int editTitleResourceId)

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

public B editable(boolean editable)

Indicates whether this action title is editable. Note: Editable actions cannot also be checked, or belong to a check set.

public B enabled(boolean enabled)

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

public B focusable(boolean focusable)

Indicates whether this action can take focus.

public @NonNull Context getContext()

Returns Context of this Builder.

public B hasEditableActivatorView(boolean editable)

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

public B hasNext(boolean hasNext)

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

public B icon(@Nullable Drawable icon)

Sets the action's icon drawable.

public B icon(@DrawableRes int iconResourceId)

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.

public B iconResourceId(@DrawableRes int iconResourceId, 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.

public B id(long id)

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.

public B infoOnly(boolean infoOnly)

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

public B inputType(int inputType)

Sets InputType of this action title not in editing.

public B intent(@Nullable Intent intent)

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

public B multilineDescription(boolean multilineDescription)

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

public B subActions(@Nullable List<GuidedAction> subActions)

Sets sub actions list.

public B title(@Nullable CharSequence title)

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 B title(@StringRes int titleResourceId)

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 final void applyValues(@NonNull GuidedAction action)

Subclass of BuilderBase should call this function to apply values.