public class GuidanceStylist extends Object implements FragmentAnimationProvider
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:
android.support.v17.leanback.R.id#guidance_title
android.support.v17.leanback.R.id#guidance_description
android.support.v17.leanback.R.id#guidance_breadcrumb
android.support.v17.leanback.R.id#guidance_icon
View IDs are allowed to be missing, in which case the corresponding views will be null.
GuidedStepFragment
,
GuidanceStylist.Guidance
Modifier and Type | Class and Description |
---|---|
static class |
GuidanceStylist.Guidance
A data class representing contextual information for a
GuidedStepFragment . |
Constructor and Description |
---|
GuidanceStylist() |
Modifier and Type | Method and Description |
---|---|
TextView |
getBreadcrumbView()
Returns the view displaying the breadcrumb of the guidance.
|
TextView |
getDescriptionView()
Returns the view displaying the description of the guidance.
|
ImageView |
getIconView()
Returns the view displaying the icon of the guidance.
|
TextView |
getTitleView()
Returns the view displaying the title of the guidance.
|
View |
onCreateView(LayoutInflater inflater,
ViewGroup container,
GuidanceStylist.Guidance guidance)
Creates an appropriately configured view for the given Guidance, using the provided
inflater and container.
|
void |
onDestroyView()
Called when destroy the View created by GuidanceStylist.
|
void |
onImeAppearing(List<Animator> animators)
Animates the fragment in response to the IME appearing.
|
void |
onImeDisappearing(List<Animator> animators)
Animates the fragment in response to the IME disappearing.
|
int |
onProvideLayoutId()
Provides the resource ID of the layout defining the guidance view.
|
public View onCreateView(LayoutInflater inflater, ViewGroup container, GuidanceStylist.Guidance guidance)
Note: Does not actually add the created view to the container; the caller should do this.
inflater
- The layout inflater to be used when constructing the view.container
- The view group to be passed in the call to
LayoutInflater.inflate
.guidance
- The guidance data for the view.public void onDestroyView()
public int onProvideLayoutId()
android.support.v17.leanback.R.layout#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.public TextView getTitleView()
public TextView getDescriptionView()
public TextView getBreadcrumbView()
public ImageView getIconView()
public void onImeAppearing(@NonNull List<Animator> animators)
onImeAppearing
in interface FragmentAnimationProvider
animators
- A list of animations to which this provider's animations should be added.public void onImeDisappearing(@NonNull List<Animator> animators)
onImeDisappearing
in interface FragmentAnimationProvider
animators
- A list of animations to which this provider's animations should be added.