Guidance
open class Guidance
| kotlin.Any | |
| ↳ | androidx.leanback.widget.GuidanceStylist.Guidance |
A data class representing contextual information for a . 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 |
|
|---|---|
|
Constructs a Guidance object with the specified title, description, breadcrumb, and icon drawable. |
|
Public methods |
|
|---|---|
| open String! |
Returns the breadcrumb specified when this Guidance was constructed. |
| open String! |
Returns the description specified when this Guidance was constructed. |
| open Drawable! |
Returns the icon drawable specified when this Guidance was constructed. |
| open String! |
getTitle()Returns the title specified when this Guidance was constructed. |
Public constructors
<init>
Guidance(title: String!, description: String!, breadcrumb: String!, icon: Drawable!)
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 |
String!: The icon drawable representing the current guided step. |
Public methods
getBreadcrumb
open fun getBreadcrumb(): String!
Returns the breadcrumb specified when this Guidance was constructed.
| Return | |
|---|---|
| String!: The breadcrumb for this Guidance. |
getDescription
open fun getDescription(): String!
Returns the description specified when this Guidance was constructed.
| Return | |
|---|---|
| String!: The description for this Guidance. |
getIconDrawable
open fun getIconDrawable(): Drawable!
Returns the icon drawable specified when this Guidance was constructed.
| Return | |
|---|---|
| Drawable!: The icon for this Guidance. |