GuidedActionsStylist

Kotlin |Java

open class GuidedActionsStylist : FragmentAnimationProvider

kotlin.Any
↳	androidx.leanback.widget.GuidedActionsStylist

GuidedActionsStylist is used within a androidx.leanback.app.GuidedStepFragment to supply the right-side panel where users can take actions. It consists of a container for the list of actions, and a stationary selector view that indicates visually the location of focus. GuidedActionsStylist has two different layouts: default is for normal actions including text, radio, checkbox, DatePicker, etc, the other when setAsButtonActions() is called is recommended for button actions such as "yes", "no".

Many aspects of the base GuidedActionsStylist can be customized through theming; see the theme attributes below. Note that these attributes are not set on individual elements in layout XML, but instead would be set in a custom theme. See Styles and Themes for more information.

If these hooks are insufficient, this class may also be subclassed. Subclasses may wish to override the onProvideLayoutId method to change the layout used to display the list container and selector; override onProvideItemLayoutId(int) and getItemViewType(GuidedAction) method to change the layout used to display each action.

To support a "click to activate" view similar to DatePicker, app needs:

Override onProvideItemLayoutId(int) and getItemViewType(GuidedAction), provides a layout id for the action.

The layout must include a widget with id "guidedactions_activator_item", the widget is toggled edit mode by View#setActivated(boolean).

Override onBindActivatorView(ViewHolder, GuidedAction) to populate values into View.

Override onUpdateActivatorView(ViewHolder, GuidedAction) to update action.

Note: If an alternate list layout is provided, the following view IDs must be supplied:

androidx.leanback.R.id#guidedactions_list

These view IDs must be present in order for the stylist to function. The list ID must correspond to a VerticalGridView or subclass.

If an alternate item layout is provided, the following view IDs should be used to refer to base elements:

These view IDs are allowed to be missing, in which case the corresponding views in will be null.

Summary

Nested classes
open	`ViewHolder` ViewHolder caches information about the action item layouts' subviews.

Constants
static Int	`VIEW_TYPE_DATE_PICKER` ViewType for DatePicker.
static Int	`VIEW_TYPE_DEFAULT` Default viewType that associated with default layout Id for the action item.

Public constructors
`<init>()` GuidedActionsStylist is used within a `androidx.leanback.app.GuidedStepFragment` to supply the right-side panel where users can take actions.

Public methods
open Unit	`collapseAction(withTransition: Boolean)` Collapse expanded action.
open Unit	`expandAction(action: GuidedAction!, withTransition: Boolean)` Expand an action.
open VerticalGridView!	`getActionsGridView()` Returns the VerticalGridView that displays the list of GuidedActions.
open GuidedAction!	`getExpandedAction()`
open Int	`getItemViewType(action: GuidedAction!)` Return view type of action, each different type can have differently associated layout Id.
open VerticalGridView!	`getSubActionsGridView()` Returns the VerticalGridView that displays the sub actions list of an expanded action.
Boolean	`isBackKeyToCollapseActivatorView()`
Boolean	`isBackKeyToCollapseSubActions()`
open Boolean	`isButtonActions()` Returns true if it is button actions list, false for normal actions list.
open Boolean	`isExpandTransitionSupported()` Returns if expand/collapse animation is supported.
open Boolean	`isExpanded()`
open Boolean	`isInExpandTransition()` Returns true if it is running an expanding or collapsing transition, false otherwise.
open Boolean	`isSubActionsExpanded()`
open Unit	`onAnimateItemChecked(vh: GuidedActionsStylist.ViewHolder!, checked: Boolean)` Animates the view holder's view (or subviews thereof) when the action has had its check state changed.
open Unit	`onAnimateItemFocused(vh: GuidedActionsStylist.ViewHolder!, focused: Boolean)` Animates the view holder's view (or subviews thereof) when the action has had its focus state changed.
open Unit	`onAnimateItemPressed(vh: GuidedActionsStylist.ViewHolder!, pressed: Boolean)` Animates the view holder's view (or subviews thereof) when the action has had its press state changed.
open Unit	`onAnimateItemPressedCancelled(vh: GuidedActionsStylist.ViewHolder!)` Resets the view holder's view to unpressed state.
open Unit	`onBindActivatorView(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!)` Performs binding activator view value to action.
open Unit	`onBindCheckMarkView(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!)` Sets states of check mark view, called by `onBindViewHolder(ViewHolder, GuidedAction)` when action's checkset Id is other than `GuidedAction#NO_CHECK_SET`.
open Unit	`onBindChevronView(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!)` Sets states of chevron view, called by `onBindViewHolder(ViewHolder, GuidedAction)`.
open Unit	`onBindViewHolder(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!)` Binds a `ViewHolder` to a particular `GuidedAction`.
open View!	`onCreateView(inflater: LayoutInflater!, container: ViewGroup!)` Creates a view appropriate for displaying a list of GuidedActions, using the provided inflater and container.
open GuidedActionsStylist.ViewHolder!	`onCreateViewHolder(parent: ViewGroup!)` Constructs a `ViewHolder` capable of representing `GuidedAction`s.
open GuidedActionsStylist.ViewHolder!	`onCreateViewHolder(parent: ViewGroup!, viewType: Int)` Constructs a `ViewHolder` capable of representing `GuidedAction`s.
open Unit	`onDestroyView()` Called when destroy the View created by GuidedActionsStylist.
open Unit	`onImeAppearing(@NonNull animators: MutableList<Animator!>)` Animates the fragment in response to the IME appearing.
open Unit	`onImeDisappearing(@NonNull animators: MutableList<Animator!>)` Animates the fragment in response to the IME disappearing.
open Int	`onProvideItemLayoutId()` Provides the resource ID of the layout defining the view for an individual guided actions.
open Int	`onProvideItemLayoutId(viewType: Int)` Provides the resource ID of the layout defining the view for an individual guided actions.
open Int	`onProvideLayoutId()` Provides the resource ID of the layout defining the host view for the list of guided actions.
open Boolean	`onUpdateActivatorView(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!)` Performs updating GuidedAction from activator view.
open Unit	`onUpdateExpandedViewHolder(avh: GuidedActionsStylist.ViewHolder!)` Expand or collapse GuidedActionStylist.
open Unit	`openInEditMode(action: GuidedAction!)` Switches action to edit mode and pops up the keyboard.
open Unit	`setAsButtonActions()` Choose the layout resource for button actions in `onProvideLayoutId()`.
Unit	`setBackKeyToCollapseActivatorView(backToCollapse: Boolean)` Enable or disable using BACK key to collapse `GuidedAction` with editable activator view.
Unit	`setBackKeyToCollapseSubActions(backToCollapse: Boolean)` Enable or disable using BACK key to collapse sub actions list.
open Unit	`setEditingMode(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!, editing: Boolean)`
open Unit	`setExpandedViewHolder(avh: GuidedActionsStylist.ViewHolder!)` Expands or collapse the sub actions list view with transition animation
open Unit	`startExpandedTransition(avh: GuidedActionsStylist.ViewHolder!)` Start transition to expand or collapse GuidedActionStylist.

Protected methods
open Unit	`onEditingModeChange(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!, editing: Boolean)`
open Unit	`onEditingModeChange(vh: GuidedActionsStylist.ViewHolder!, editing: Boolean, withTransition: Boolean)` Called when editing mode of an ViewHolder is changed.
open Unit	`setupImeOptions(vh: GuidedActionsStylist.ViewHolder!, action: GuidedAction!)` Called by `onBindViewHolder(ViewHolder, GuidedAction)` to setup IME options.

Constants

VIEW_TYPE_DATE_PICKER

static val VIEW_TYPE_DATE_PICKER: Int

ViewType for DatePicker.

Value: 1

VIEW_TYPE_DEFAULT

static val VIEW_TYPE_DEFAULT: Int

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

Value: 0

See Also

#getItemViewType(GuidedAction)
#onProvideItemLayoutId(int)
#onCreateViewHolder(ViewGroup, int)

Public constructors

<init>

GuidedActionsStylist()

To support a "click to activate" view similar to DatePicker, app needs:

Override onProvideItemLayoutId(int) and getItemViewType(GuidedAction), provides a layout id for the action.

The layout must include a widget with id "guidedactions_activator_item", the widget is toggled edit mode by View#setActivated(boolean).

Override onBindActivatorView(ViewHolder, GuidedAction) to populate values into View.

Override onUpdateActivatorView(ViewHolder, GuidedAction) to update action.

Note: If an alternate list layout is provided, the following view IDs must be supplied:

androidx.leanback.R.id#guidedactions_list

These view IDs must be present in order for the stylist to function. The list ID must correspond to a VerticalGridView or subclass.

If an alternate item layout is provided, the following view IDs should be used to refer to base elements:

These view IDs are allowed to be missing, in which case the corresponding views in will be null.

See Also

Public methods

collapseAction

open fun collapseAction(withTransition: Boolean): Unit

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

Parameters
`withTransition`	Boolean: True to run transition animation, false otherwsie.

expandAction

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

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

Parameters
`action`	GuidedAction!: Action to expand.
`withTransition`	Boolean: True to run transition animation, false otherwsie.

getActionsGridView

open fun getActionsGridView(): VerticalGridView!

Returns the VerticalGridView that displays the list of GuidedActions.

Return
`VerticalGridView!`	The VerticalGridView for this presenter.

getExpandedAction

open fun getExpandedAction(): GuidedAction!

Return
`GuidedAction!`	Current expanded GuidedAction or null if not expanded.

getItemViewType

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

Parameters
`action`	GuidedAction!: The action object.

Return
`Int`	View type that used in `onProvideItemLayoutId(int)`.

getSubActionsGridView

open fun getSubActionsGridView(): VerticalGridView!

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

Return
`VerticalGridView!`	The VerticalGridView that displays the sub actions list of an expanded action.

isBackKeyToCollapseActivatorView

fun isBackKeyToCollapseActivatorView