added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0-beta01

GuidanceStylist.Guidance

public static class GuidanceStylist.Guidance
extends Object

java.lang.Object
   ↳ androidx.leanback.widget.GuidanceStylist.Guidance


A data class representing contextual information for a GuidedStepFragment. Guidance consists of a short title, a longer description, a breadcrumb to help with global navigation (often indicating where the back button will lead), and an optional icon. All this information is intended to provide users with the appropriate context to make the decision(s) required by the current step.

Clients may provide a subclass of this if they wish to remember auxiliary data for use in a customized GuidanceStylist.

Summary

Public constructors

GuidanceStylist.Guidance(String title, String description, String breadcrumb, Drawable icon)

Constructs a Guidance object with the specified title, description, breadcrumb, and icon drawable.

Public methods

String getBreadcrumb()

Returns the breadcrumb specified when this Guidance was constructed.

String getDescription()

Returns the description specified when this Guidance was constructed.

Drawable getIconDrawable()

Returns the icon drawable specified when this Guidance was constructed.

String getTitle()

Returns the title specified when this Guidance was constructed.

Inherited methods

Public constructors

GuidanceStylist.Guidance

added in version 1.0.0
public GuidanceStylist.Guidance (String title, 
                String description, 
                String breadcrumb, 
                Drawable icon)

Constructs a Guidance object with the specified title, description, breadcrumb, and icon drawable.

Parameters
title String: The title for the current guided step.

description String: The description for the current guided step.

breadcrumb String: The breadcrumb for the current guided step.

icon Drawable: The icon drawable representing the current guided step.

Public methods

getBreadcrumb

added in version 1.0.0
public String getBreadcrumb ()

Returns the breadcrumb specified when this Guidance was constructed.

Returns
String The breadcrumb for this Guidance.

getDescription

added in version 1.0.0
public String getDescription ()

Returns the description specified when this Guidance was constructed.

Returns
String The description for this Guidance.

getIconDrawable

added in version 1.0.0
public Drawable getIconDrawable ()

Returns the icon drawable specified when this Guidance was constructed.

Returns
Drawable The icon for this Guidance.

getTitle

added in version 1.0.0
public String getTitle ()

Returns the title specified when this Guidance was constructed.

Returns
String The title for this Guidance.