GuidedActionsStylist

public class GuidedActionsStylist
extends Object implements FragmentAnimationProvider

java.lang.Object
   ↳ androidx.leanback.widget.GuidedActionsStylist


GuidedActionsStylist is used within a 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:

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

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 GuidedActionsStylist.ViewHolder will be null.

In order to support editable actions, the view associated with guidedactions_item_title should be a subclass of EditText, and should satisfy the ImeKeyMonitor interface and GuidedActionAutofillSupport interface. R.attr.guidedStepImeAppearingAnimation R.attr.guidedStepImeDisappearingAnimation R.attr.guidedActionsSelectorDrawable R.attr.guidedActionsListStyle R.attr.guidedSubActionsListStyle R.attr.guidedButtonActionsListStyle R.attr.guidedActionItemContainerStyle R.attr.guidedActionItemCheckmarkStyle R.attr.guidedActionItemIconStyle R.attr.guidedActionItemContentStyle R.attr.guidedActionItemTitleStyle R.attr.guidedActionItemDescriptionStyle R.attr.guidedActionItemChevronStyle R.attr.guidedActionPressedAnimation R.attr.guidedActionUnpressedAnimation R.attr.guidedActionEnabledChevronAlpha R.attr.guidedActionDisabledChevronAlpha R.attr.guidedActionTitleMinLines R.attr.guidedActionTitleMaxLines R.attr.guidedActionDescriptionMinLines R.attr.guidedActionVerticalPadding

Summary

Nested classes

class GuidedActionsStylist.ViewHolder

ViewHolder caches information about the action item layouts' subviews. 

Constants

int VIEW_TYPE_DATE_PICKER

ViewType for DatePicker.

int VIEW_TYPE_DEFAULT

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

Public constructors

GuidedActionsStylist()

Public methods

void collapseAction(boolean withTransition)

Collapse expanded action.

void expandAction(GuidedAction action, boolean withTransition)

Expand an action.

VerticalGridView getActionsGridView()

Returns the VerticalGridView that displays the list of GuidedActions.

GuidedAction getExpandedAction()
int getItemViewType(GuidedAction action)

Return view type of action, each different type can have differently associated layout Id.

VerticalGridView getSubActionsGridView()

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

final boolean isBackKeyToCollapseActivatorView()
final boolean isBackKeyToCollapseSubActions()
boolean isButtonActions()

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

boolean isExpandTransitionSupported()

Returns if expand/collapse animation is supported.

boolean isExpanded()
boolean isInExpandTransition()

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

boolean isSubActionsExpanded()
void