| java.lang.Object | |
| ↳ | android.support.v17.leanback.widget.GuidanceStylist |
GuidanceStylist is used within a 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.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| GuidanceStylist.Guidance |
A data class representing contextual information for a GuidedStepFragment.
|
||||||||||
| XML Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| android.support.v17.leanback:guidanceBreadcrumbStyle | Theme attribute for the style of the breadcrumb in a GuidanceStylist. | ||||||||||
| android.support.v17.leanback:guidanceContainerStyle | Theme attribute for the style of the main container in a GuidanceStylist. | ||||||||||
| android.support.v17.leanback:guidanceDescriptionStyle | Theme attribute for the style of the description in a GuidanceStylist. | ||||||||||
| android.support.v17.leanback:guidanceEntryAnimation | Theme attribute for the animation used when the guidance is animated in at activity start. | ||||||||||
| android.support.v17.leanback:guidanceIconStyle | Theme attribute for the style of the icon in a GuidanceStylist. | ||||||||||
| android.support.v17.leanback:guidanceTitleStyle | Theme attribute for the style of the title in a GuidanceStylist. | ||||||||||
| android.support.v17.leanback:guidedStepEntryAnimation | Theme attribute for the animation used when a guided step element is animated in on fragment stack push. | ||||||||||
| android.support.v17.leanback:guidedStepExitAnimation | Theme attribute for the animation used when a guided step element is animated out on fragment stack push. | ||||||||||
| android.support.v17.leanback:guidedStepReentryAnimation | Theme attribute for the animation used when a guided step element is animated in on fragment stack pop. | ||||||||||
| android.support.v17.leanback:guidedStepReturnAnimation | Theme attribute for the animation used when a guided step element is animated out on fragment stack pop. | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns the view displaying the breadcrumb of the guidance.
| |||||||||||
Returns the view displaying the description of the guidance.
| |||||||||||
Returns the view displaying the icon of the guidance.
| |||||||||||
Returns the view displaying the title of the guidance.
| |||||||||||
Animates the entry of the fragment in the case where the activity is first being presented.
| |||||||||||
Animates the exit of the fragment in the case where the activity is about to pause.
| |||||||||||
Creates an appropriately configured view for the given Guidance, using the provided
inflater and container.
| |||||||||||
Animates the entry of the fragment in the case where there is a previous step fragment
participating in the animation.
| |||||||||||
Animates the exit of the fragment in the case where there is a previous step fragment
participating in the animation.
| |||||||||||
Animates the re-entry of the fragment in the case where there is a previous step fragment
participating in the animation.
| |||||||||||
Animates the return of the fragment in the case where there is a previous step fragment
participating in the animation.
| |||||||||||
Provides the resource ID of the layout defining the guidance view.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
android.support.v17.leanback.widget.FragmentAnimationProvider
| |||||||||||
Theme attribute for the style of the breadcrumb in a GuidanceStylist. Default is
Widget_Leanback_GuidanceBreadcrumbStyle.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the style of the main container in a GuidanceStylist. Default is
Widget_Leanback_GuidanceContainerStyle.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the style of the description in a GuidanceStylist. Default is
Widget_Leanback_GuidanceDescriptionStyle.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the animation used when the guidance is animated in at activity
start. Default is lb_guidance_entry.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the style of the icon in a GuidanceStylist. Default is
Widget_Leanback_GuidanceIconStyle.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the style of the title in a GuidanceStylist. Default is
Widget_Leanback_GuidanceTitleStyle.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the animation used when a guided step element is animated in on
fragment stack push. Default is lb_guidedstep_slide_in_from_end.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the animation used when a guided step element is animated out on
fragment stack push. Default is lb_guidedstep_slide_out_to_start.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the animation used when a guided step element is animated in on
fragment stack pop. Default is lb_guidedstep_slide_in_from_start.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Theme attribute for the animation used when a guided step element is animated out on
fragment stack pop. Default is lb_guidedstep_slide_out_to_end.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This is a private symbol.
Returns the view displaying the breadcrumb of the guidance.
Returns the view displaying the description of the guidance.
Returns the view displaying the icon of the guidance.
Returns the view displaying the title of the guidance.
Animates the entry of the fragment in the case where the activity is first being presented.
| animators | A list of animations to which this provider's animations should be added. |
|---|
Animates the exit of the fragment in the case where the activity is about to pause.
| animators | A list of animations to which this provider's animations should be added. |
|---|
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.
| 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. |
Animates the entry of the fragment in the case where there is a previous step fragment participating in the animation. Entry occurs when the fragment is preparing to be shown as it is pushed onto the back stack.
| animators | A list of animations to which this provider's animations should be added. |
|---|
Animates the exit of the fragment in the case where there is a previous step fragment participating in the animation. Exit occurs when the fragment is preparing to be removed, hidden, or detached due to pushing another fragment onto the back stack.
| animators | A list of animations to which this provider's animations should be added. |
|---|
Animates the re-entry of the fragment in the case where there is a previous step fragment participating in the animation. Re-entry occurs when the fragment is preparing to be shown due to popping the back stack.
| animators | A list of animations to which this provider's animations should be added. |
|---|
Animates the return of the fragment in the case where there is a previous step fragment participating in the animation. Return occurs when the fragment is preparing to be removed, hidden, or detached due to popping the back stack.
| animators | A list of animations to which this provider's animations should be added. |
|---|
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.
Developers