Skip to content

Most visited

Recently visited

navigation
added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:27.0.0

GuidanceStylist.Guidance

public static class GuidanceStylist.Guidance
extends Object

java.lang.Object
   ↳ android.support.v17.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

From class java.lang.Object

Public constructors

GuidanceStylist.Guidance

added in version 22.1.0
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 22.1.0
String getBreadcrumb ()

Returns the breadcrumb specified when this Guidance was constructed.

Returns
String The breadcrumb for this Guidance.

getDescription

added in version 22.1.0
String getDescription ()

Returns the description specified when this Guidance was constructed.

Returns
String The description for this Guidance.

getIconDrawable

added in version 22.1.0
Drawable getIconDrawable ()

Returns the icon drawable specified when this Guidance was constructed.

Returns
Drawable The icon for this Guidance.

getTitle

added in version 22.1.0
String getTitle ()

Returns the title specified when this Guidance was constructed.

Returns
String The title for this Guidance.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)