public class

GuidanceStylist.Guidance

extends java.lang.Object

 java.lang.Object

↳androidx.leanback.widget.GuidanceStylist.Guidance

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

Constructors
publicGuidance(java.lang.String title, java.lang.String description, java.lang.String breadcrumb, Drawable icon)

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

Methods
public java.lang.StringgetBreadcrumb()

Returns the breadcrumb specified when this Guidance was constructed.

public java.lang.StringgetDescription()

Returns the description specified when this Guidance was constructed.

public DrawablegetIconDrawable()

Returns the icon drawable specified when this Guidance was constructed.

public java.lang.StringgetTitle()

Returns the title specified when this Guidance was constructed.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Guidance(java.lang.String title, java.lang.String description, java.lang.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.

Methods

public java.lang.String getTitle()

Returns the title specified when this Guidance was constructed.

Returns:

The title for this Guidance.

public java.lang.String getDescription()

Returns the description specified when this Guidance was constructed.

Returns:

The description for this Guidance.

public java.lang.String getBreadcrumb()

Returns the breadcrumb specified when this Guidance was constructed.

Returns:

The breadcrumb for this Guidance.

public Drawable getIconDrawable()

Returns the icon drawable specified when this Guidance was constructed.

Returns:

The icon for this Guidance.

Generated Fri, 13 Sep 2024 06:45:45 +0000 by Michael Jentsch - Privacy Policy - Legal Details