GuidedActionsStylist

const val VIEW_TYPE_DATE_PICKER = 1: Int

ViewType for DatePicker.

const val VIEW_TYPE_DEFAULT = 0: Int

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

fun collapseAction(withTransition: Boolean): Unit

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

fun expandAction(action: GuidedAction, withTransition: Boolean): Unit

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

fun getActionsGridView(): VerticalGridView?

Returns the VerticalGridView that displays the list of GuidedActions.

fun getItemViewType(action: GuidedAction): Int

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

fun getSubActionsGridView(): VerticalGridView?

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

fun isButtonActions(): Boolean

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

fun isExpandTransitionSupported(): Boolean

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.

fun isInExpandTransition(): Boolean

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

fun onAnimateItemChecked(
    vh: GuidedActionsStylist.ViewHolder,
    checked: Boolean
): Unit

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.

fun onAnimateItemFocused(
    vh: GuidedActionsStylist.ViewHolder,
    focused: Boolean
): Unit

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

fun onAnimateItemPressed(
    vh: GuidedActionsStylist.ViewHolder,
    pressed: Boolean
): Unit

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

fun onAnimateItemPressedCancelled(vh: GuidedActionsStylist.ViewHolder): Unit

Resets the view holder's view to unpressed state.

fun onBindActivatorView(
    vh: GuidedActionsStylist.ViewHolder,
    action: GuidedAction
): Unit

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

fun onBindCheckMarkView(
    vh: GuidedActionsStylist.ViewHolder,
    action: GuidedAction
): Unit

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

fun onBindChevronView(
    vh: GuidedActionsStylist.ViewHolder,
    action: GuidedAction
): Unit

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

fun onBindViewHolder(
    vh: GuidedActionsStylist.ViewHolder,
    action: GuidedAction
): Unit

Binds a ViewHolder to a particular GuidedAction.

fun onCreateView(inflater: LayoutInflater, container: ViewGroup): View

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.

fun onCreateViewHolder(parent: ViewGroup): GuidedActionsStylist.ViewHolder

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.

fun onCreateViewHolder(parent: ViewGroup, viewType: Int): GuidedActionsStylist.ViewHolder

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.

fun onDestroyView(): Unit

Called when destroy the View created by GuidedActionsStylist.

fun onImeAppearing(animators: (Mutable)List<Animator!>): Unit

Animates the fragment in response to the IME appearing.

fun onImeDisappearing(animators: (Mutable)List<Animator!>): Unit

Animates the fragment in response to the IME disappearing.

fun onProvideItemLayoutId(): Int

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 android.widget.EditText and implement ImeKeyMonitor, GuidedActionAutofillSupport; see GuidedActionEditText. To support different types of Layouts, override onProvideItemLayoutId.

fun onProvideItemLayoutId(viewType: Int): Int

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.

fun onProvideLayoutId(): Int

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.

fun onUpdateActivatorView(
    vh: GuidedActionsStylist.ViewHolder,
    action: GuidedAction
): Boolean

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

fun onUpdateExpandedViewHolder(avh: GuidedActionsStylist.ViewHolder?): Unit

Expand or collapse GuidedActionStylist.

fun openInEditMode(action: GuidedAction): Unit

Switches action to edit mode and pops up the keyboard.

fun setAsButtonActions(): Unit

Choose the layout resource for button actions in onProvideLayoutId.

fun setBackKeyToCollapseActivatorView(backToCollapse: Boolean): Unit

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

fun setBackKeyToCollapseSubActions(backToCollapse: Boolean): Unit

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

fun setExpandedViewHolder(avh: GuidedActionsStylist.ViewHolder!): Unit

Expands or collapse the sub actions list view with transition animation

fun startExpandedTransition(avh: GuidedActionsStylist.ViewHolder!): Unit

Start transition to expand or collapse GuidedActionStylist.

@CallSuper
protected fun onEditingModeChange(
    vh: GuidedActionsStylist.ViewHolder,
    editing: Boolean,
    withTransition: Boolean
): Unit

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

protected fun setupImeOptions(
    vh: GuidedActionsStylist.ViewHolder,
    action: GuidedAction
): Unit

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