Android APIs
public static class

GuidanceStylist.Guidance

extends Object
java.lang.Object
   ↳ android.support.v17.leanback.widget.GuidanceStylist.Guidance

Class Overview

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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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 The title for the current guided step.
description The description for the current guided step.
breadcrumb The breadcrumb for the current guided step.
icon The icon drawable representing the current guided step.

Public Methods

public String getBreadcrumb ()

Returns the breadcrumb specified when this Guidance was constructed.

Returns
  • The breadcrumb for this Guidance.

public String getDescription ()

Returns the description specified when this Guidance was constructed.

Returns
  • The description for this Guidance.

public Drawable getIconDrawable ()

Returns the icon drawable specified when this Guidance was constructed.

Returns
  • The icon for this Guidance.

public String getTitle ()

Returns the title specified when this Guidance was constructed.

Returns
  • The title for this Guidance.