GuidedActionsStylist

public static final int VIEW_TYPE_DATE_PICKER = 1

ViewType for DatePicker.

public static final int VIEW_TYPE_DEFAULT = 0

Default viewType that associated with default layout Id for the action item.

public void collapseAction(boolean withTransition)

Collapse expanded action. Do nothing if it is in animation or there is no action expanded.

public void expandAction(@NonNull GuidedAction action, boolean withTransition)

Expand an action. Do nothing if it is in animation or there is action expanded.

public @Nullable VerticalGridView getActionsGridView()

Returns the VerticalGridView that displays the list of GuidedActions.

public int getItemViewType(@NonNull GuidedAction action)

Return view type of action, each different type can have differently associated layout Id. Default implementation returns VIEW_TYPE_DEFAULT.

public @Nullable VerticalGridView getSubActionsGridView()

Returns the VerticalGridView that displays the sub actions list of an expanded action.

public boolean isButtonActions()

Returns true if it is button actions list, false for normal actions list.

public boolean isExpandTransitionSupported()

Returns if expand/collapse animation is supported. When this method returns true, startExpandedTransition will be used. When this method returns false, onUpdateExpandedViewHolder will be called.

public boolean isInExpandTransition()

Returns true if it is running an expanding or collapsing transition, false otherwise.

public void onAnimateItemChecked(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    boolean checked
)

Animates the view holder's view (or subviews thereof) when the action has had its check state changed. Default implementation calls setChecked() if getCheckmarkView is instance of Checkable.

public void onAnimateItemFocused(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    boolean focused
)

Animates the view holder's view (or subviews thereof) when the action has had its focus state changed.

public void onAnimateItemPressed(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    boolean pressed
)

Animates the view holder's view (or subviews thereof) when the action has had its press state changed.

public void onAnimateItemPressedCancelled(
    @NonNull GuidedActionsStylist.ViewHolder vh
)

Resets the view holder's view to unpressed state.

public void onBindActivatorView(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    @NonNull GuidedAction action
)

Performs binding activator view value to action. Default implementation supports GuidedDatePickerAction, subclass may override to add support of other views.

public void onBindCheckMarkView(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    @NonNull GuidedAction action
)

Sets states of check mark view, called by onBindViewHolder when action's checkset Id is other than NO_CHECK_SET. Default implementation assigns drawable loaded from theme attribute listChoiceIndicatorMultiple for checkbox or listChoiceIndicatorSingle for radio button. Subclass rarely needs override the method, instead app can provide its own drawable that supports transition animations, change theme attributes listChoiceIndicatorMultiple and listChoiceIndicatorSingle in {androidx.leanback.R. styleable#LeanbackGuidedStepTheme}.

public void onBindChevronView(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    @NonNull GuidedAction action
)

Sets states of chevron view, called by onBindViewHolder. Subclass may override.

public void onBindViewHolder(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    @NonNull GuidedAction action
)

Binds a ViewHolder to a particular GuidedAction.

public @NonNull View onCreateView(
    @NonNull LayoutInflater inflater,
    @NonNull ViewGroup container
)

Creates a view appropriate for displaying a list of GuidedActions, using the provided inflater and container.

Note: Does not actually add the created view to the container; the caller should do this.

public @NonNull GuidedActionsStylist.ViewHolder onCreateViewHolder(@NonNull ViewGroup parent)

Constructs a ViewHolder capable of representing GuidedActions. Subclasses may choose to return a subclass of ViewHolder. To support different view types, override onCreateViewHolder

Note: Should not actually add the created view to the parent; the caller will do this.

public @NonNull GuidedActionsStylist.ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType)

Constructs a ViewHolder capable of representing GuidedActions. Subclasses may choose to return a subclass of ViewHolder.

Note: Should not actually add the created view to the parent; the caller will do this.

public void onDestroyView()

Called when destroy the View created by GuidedActionsStylist.

public void onImeAppearing(@NonNull List<Animator> animators)

Animates the fragment in response to the IME appearing.

public void onImeDisappearing(@NonNull List<Animator> animators)

Animates the fragment in response to the IME disappearing.

public int onProvideItemLayoutId()

Provides the resource ID of the layout defining the view for an individual guided actions. Subclasses may override to provide their own customized layouts. The base implementation returns lb_guidedactions_item. If overridden, the substituted layout should contain matching IDs for any views that should be managed by the base class; this can be achieved by starting with a copy of the base layout file. Note that in order for the item to support editing, the title view should both subclass and implement ImeKeyMonitor, GuidedActionAutofillSupport; see . To support different types of Layouts, override onProvideItemLayoutId.

public int onProvideItemLayoutId(int viewType)

Provides the resource ID of the layout defining the view for an individual guided actions. Subclasses may override to provide their own customized layouts. The base implementation supports:

• lb_guidedactions_item
• {lb_guidedactions_datepicker_item.

public int onProvideLayoutId()

Provides the resource ID of the layout defining the host view for the list of guided actions. Subclasses may override to provide their own customized layouts. The base implementation returns lb_guidedactions or lb_guidedbuttonactions if isButtonActions is true. If overridden, the substituted layout should contain matching IDs for any views that should be managed by the base class; this can be achieved by starting with a copy of the base layout file.

public boolean onUpdateActivatorView(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    @NonNull GuidedAction action
)

Performs updating GuidedAction from activator view. Default implementation supports GuidedDatePickerAction, subclass may override to add support of other views.

public void onUpdateExpandedViewHolder(
    @Nullable GuidedActionsStylist.ViewHolder avh
)

Expand or collapse GuidedActionStylist.

public void openInEditMode(@NonNull GuidedAction action)

Switches action to edit mode and pops up the keyboard.

public void setAsButtonActions()

Choose the layout resource for button actions in onProvideLayoutId.

public final void setBackKeyToCollapseActivatorView(boolean backToCollapse)

Enable or disable using BACK key to collapse GuidedAction with editable activator view. Default is enabled.

public final void setBackKeyToCollapseSubActions(boolean backToCollapse)

Enable or disable using BACK key to collapse sub actions list. Default is enabled.

public void setExpandedViewHolder(GuidedActionsStylist.ViewHolder avh)

Expands or collapse the sub actions list view with transition animation

public void startExpandedTransition(GuidedActionsStylist.ViewHolder avh)

Start transition to expand or collapse GuidedActionStylist.

@CallSuper
protected void onEditingModeChange(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    boolean editing,
    boolean withTransition
)

Called when editing mode of an ViewHolder is changed. Subclass must call super.onEditingModeChange(vh,editing,withTransition).

protected void setupImeOptions(
    @NonNull GuidedActionsStylist.ViewHolder vh,
    @NonNull GuidedAction action
)

Called by onBindViewHolder to setup IME options. Default implementation assigns IME_ACTION_DONE. Subclass may override.