GuidanceStylist
class GuidanceStylist : FragmentAnimationProvider
GuidanceStylist is used within a androidx.leanback.app.GuidedStepFragment to display contextual information for the decision(s) required at that step.
Many aspects of the base GuidanceStylist 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 file used to display the guidance; more complex layouts may be supported by also providing a subclass of GuidanceStylist.Guidance with extra fields.
Note: If an alternate layout is provided, the following view IDs should be used to refer to base elements:
View IDs are allowed to be missing, in which case the corresponding views will be null. guidedStepImeAppearingAnimationguidedStepImeDisappearingAnimationguidanceContainerStyleguidanceTitleStyleguidanceDescriptionStyleguidanceBreadcrumbStyleguidanceIconStyle
Summary
Nested types |
|---|
class GuidanceStylist.GuidanceA data class representing contextual information for a . |
Public constructors |
|---|
Public functions |
|
|---|---|
TextView? |
Returns the view displaying the breadcrumb of the guidance. |
TextView? |
Returns the view displaying the description of the guidance. |
ImageView? |
Returns the view displaying the icon of the guidance. |
TextView? |
Returns the view displaying the title of the guidance. |
View |
onCreateView(Creates an appropriately configured view for the given Guidance, using the provided inflater and container. |
Unit |
Called when destroy the View created by GuidanceStylist. |
Unit |
onImeAppearing(animators: (Mutable)List<Animator!>)Animates the fragment in response to the IME appearing. |
Unit |
onImeDisappearing(animators: (Mutable)List<Animator!>)Animates the fragment in response to the IME disappearing. |
Int |
Provides the resource ID of the layout defining the guidance view. |
Public constructors
Public functions
getBreadcrumbView
fun getBreadcrumbView(): TextView?
Returns the view displaying the breadcrumb of the guidance.
| Returns | |
|---|---|
TextView? |
The text view object for the breadcrumb. |
getDescriptionView
fun getDescriptionView(): TextView?
Returns the view displaying the description of the guidance.
| Returns | |
|---|---|
TextView? |
The text view object for the description. |
getIconView
fun getIconView(): ImageView?
Returns the view displaying the icon of the guidance.
| Returns | |
|---|---|
ImageView? |
The image view object for the icon. |
getTitleView
fun getTitleView(): TextView?
Returns the view displaying the title of the guidance.
| Returns | |
|---|---|
TextView? |
The text view object for the title. |
onCreateView
fun onCreateView(
inflater: LayoutInflater,
container: ViewGroup?,
guidance: GuidanceStylist.Guidance
): View
Creates an appropriately configured view for the given Guidance, using the provided inflater and container.
Note: Does not actually add the created view to the container; the caller should do this.
| Parameters | |
|---|---|
inflater: LayoutInflater |
The layout inflater to be used when constructing the view. |
container: ViewGroup? |
The view group to be passed in the call to |
guidance: GuidanceStylist.Guidance |
The guidance data for the view. |
| Returns | |
|---|---|
View |
The view to be added to the caller's view hierarchy. |
onDestroyView
fun onDestroyView(): Unit
Called when destroy the View created by GuidanceStylist.
onImeAppearing
fun onImeAppearing(animators: (Mutable)List<Animator!>): Unit
Animates the fragment in response to the IME appearing.
onImeDisappearing
fun onImeDisappearing(animators: (Mutable)List<Animator!>): Unit
Animates the fragment in response to the IME disappearing.
onProvideLayoutId
fun onProvideLayoutId(): Int
Provides the resource ID of the layout defining the guidance view. Subclasses may override to provide their own customized layouts. The base implementation returns lb_guidance. 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.
| Returns | |
|---|---|
Int |
The resource ID of the layout to be inflated to define the guidance view. |