GuidedActionsStylist
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:
onProvideItemLayoutId(int)
and getItemViewType(GuidedAction)
, provides a layout id for the action. View#setActivated(boolean)
. onBindActivatorView(ViewHolder, GuidedAction)
to populate values into View. onUpdateActivatorView(ViewHolder, GuidedAction)
to update action.
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:
androidx.leanback.R.id#guidedactions_item_content
androidx.leanback.R.id#guidedactions_item_title
androidx.leanback.R.id#guidedactions_item_description
androidx.leanback.R.id#guidedactions_item_icon
androidx.leanback.R.id#guidedactions_item_checkmark
androidx.leanback.R.id#guidedactions_item_chevron
These view IDs are allowed to be missing, in which case the corresponding views in will be null.
In order to support editable actions, the view associated with guidedactions_item_title should be a subclass of android.widget.EditText
, and should satisfy the interface and GuidedActionAutofillSupport
interface. androidx.leanback.R.attr#guidedStepImeAppearingAnimation
androidx.leanback.R.attr#guidedStepImeDisappearingAnimation
androidx.leanback.R.attr#guidedActionsSelectorDrawable
androidx.leanback.R.attr#guidedActionsListStyle
androidx.leanback.R.attr#guidedSubActionsListStyle
androidx.leanback.R.attr#guidedButtonActionsListStyle
androidx.leanback.R.attr#guidedActionItemContainerStyle
androidx.leanback.R.attr#guidedActionItemCheckmarkStyle
androidx.leanback.R.attr#guidedActionItemIconStyle
androidx.leanback.R.attr#guidedActionItemContentStyle
androidx.leanback.R.attr#guidedActionItemTitleStyle
androidx.leanback.R.attr#guidedActionItemDescriptionStyle
androidx.leanback.R.attr#guidedActionItemChevronStyle
androidx.leanback.R.attr#guidedActionPressedAnimation
androidx.leanback.R.attr#guidedActionUnpressedAnimation
androidx.leanback.R.attr#guidedActionEnabledChevronAlpha
androidx.leanback.R.attr#guidedActionDisabledChevronAlpha
androidx.leanback.R.attr#guidedActionTitleMinLines
androidx.leanback.R.attr#guidedActionTitleMaxLines
androidx.leanback.R.attr#guidedActionDescriptionMinLines
androidx.leanback.R.attr#guidedActionVerticalPadding
Summary
Nested classes | |
---|---|
open |
ViewHolder caches information about the action item layouts' subviews. |
Constants | |
---|---|
static Int |
ViewType for DatePicker. |
static Int |
Default viewType that associated with default layout Id for the action item. |
Public constructors | |
---|---|
<init>() GuidedActionsStylist is used within a |
Public methods | |
---|---|
open Unit |
collapseAction(withTransition: Boolean) Collapse expanded action. |
open Unit |
expandAction(action: GuidedAction!, withTransition: Boolean) Expand an action. |
open VerticalGridView! |
Returns the VerticalGridView that displays the list of GuidedActions. |
open GuidedAction! | |
open Int |
getItemViewType(action: GuidedAction!) Return view type of action, each different type can have differently associated layout Id. |
open VerticalGridView! |
Returns the VerticalGridView that displays the sub actions list of an expanded action. |
Boolean | |
Boolean | |
open Boolean |
Returns true if it is button actions list, false for normal actions list. |
open Boolean |
Returns if expand/collapse animation is supported. |
open Boolean | |
open Boolean |
Returns true if it is running an expanding or collapsing transition, false otherwise. |
open Boolean | |
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 |
Resets the view holder's view to unpressed state. |
open Unit |