androidx.car.app.model


Interfaces

AlertCallback

A listener of dismiss events.

AlertCallbackDelegate

A host-side interface for reporting cancel events to clients.

Content

Interface implemented by models that can be invalidated and refreshed individually.

InputCallback

A listener for handling text input completion event.

InputCallbackDelegate

A host-side delegate for sending InputCallback events to the car app.

Item

Interface implemented by models that can be added to an ItemList.

ItemList.OnItemVisibilityChangedListener

A listener for handling item visibility changes.

ItemList.OnSelectedListener

A listener for handling selection events for lists with selectable items.

OnCheckedChangeDelegate

A host-side delegate for sending androidx.car.app.model.Toggle.OnCheckedChangeListener events to the car app.

OnClickDelegate

A host-side interface for reporting click to clients.

OnClickListener

A listener of click events.

OnContentRefreshDelegate

A host-side delegate for sending androidx.car.app.model.OnContentRefreshListener events to the car app.

OnContentRefreshListener

A listener of content refresh requests

OnItemVisibilityChangedDelegate

A host-side delegate for sending androidx.car.app.model.ItemList.OnItemVisibilityChangedListener events to the car app.

OnSelectedDelegate

A host-side delegate for sending androidx.car.app.model.ItemList.OnSelectedListener events to the car app.

SearchCallbackDelegate

A host-side delegate for sending androidx.car.app.model.SearchTemplate.SearchCallback events to the car app.

SearchTemplate.SearchCallback

A listener for search updates.

TabCallbackDelegate

A host-side delegate for sending androidx.car.app.model.TabTemplate.TabCallback events to the car app.

TabTemplate.TabCallback

A listener for tab selection.

Template

An interface used to denote a model that can act as a root for a tree of other models.

Toggle.OnCheckedChangeListener

A listener for handling checked state change events.

Classes

Action

Represents an action with an optional icon and text.

Action.Builder

A builder of Action.

ActionStrip

Represents a list of Actions that are used for a template.

ActionStrip.Builder

A builder of ActionStrip.

Alert

Represents an alert with an optional icon, subtitle and actions.

Alert.Builder

A builder of Alert.

Badge

Represents a badge that can be displayed as an overlay on top of an image.

Badge.Builder

A builder of Badge.

CarColor

Represents a color to be used in a car app.

CarIcon

Represents an icon to be used in a car app.

CarIcon.Builder

A builder of CarIcon.

CarIconSpan

A span that replaces the text it is attached to with a CarIcon that is aligned with the surrounding text.

CarLocation

Represents a geographical location with a latitude and a longitude.

CarSpan

Base class for all span types allowed for a car app.

CarText

A model that represents text to display in the car screen.

CarText.Builder

A builder of CarText.

ClickableSpan

A span that makes a section of text clickable.

DateTimeWithZone

A time with an associated time zone information.

Distance

Represents a distance value and how it should be displayed in the UI.

DistanceSpan

A span that replaces the text it is attached to with the string representation of a instance.

DurationSpan

A span that replaces the text it is attached to with a localized duration string.

ForegroundCarColorSpan

A span that changes the color of the text to which the span is attached.

GridItem

Represents a grid item with an image and an optional title.

GridItem.Builder

A builder of GridItem.

GridSection

A section within the SectionedItemTemplate that contains GridItems - good for showcase large artwork or images for every entry.

GridSection.Builder

A builder that constructs GridSection instances.

GridTemplate

A template representing a grid of items.

GridTemplate.Builder

A builder of GridTemplate.

Header

A component that holds onto data associated with a template's header.

Header.Builder

A builder of Header.

ItemList

Represents a list of Item instances.

ItemList.Builder

A builder of ItemList.

ListTemplate

A template representing a list of items.

ListTemplate.Builder

A builder of ListTemplate.

LongMessageTemplate

A template for displaying a long text, which could be several paragraphs long, with associated actions.

LongMessageTemplate.Builder

A builder of LongMessageTemplate.

MessageTemplate

A template for displaying a message and associated actions.

MessageTemplate.Builder

A builder of MessageTemplate.

Metadata

A metadata class used for attaching additional properties to models.

Metadata.Builder

A builder for Metadata.

Pane

Represents a list of rows used for displaying informational content and a set of Actions that users can perform based on such content.

Pane.Builder

A builder of Pane.

PaneTemplate

A template that displays a Pane.

PaneTemplate.Builder

A builder of PaneTemplate.

ParkedOnlyOnClickListener

An OnClickListener that wraps another one and executes its onClick method only when the car is parked.

Place

Represents a geographical location and additional information on how to display it.

Place.Builder

A builder of Place.

PlaceListMapTemplate

A template that displays a map along with a list of places.

PlaceListMapTemplate.Builder

A builder of PlaceListMapTemplate.

PlaceMarker

Describes how a place is to be displayed on a map.

PlaceMarker.Builder

A builder of PlaceMarker.

Row

Represents a row with a title, several lines of text, an optional image, and an optional action or switch.

Row.Builder

A builder of Row.

RowSection

A section within the SectionedItemTemplate that contains Rows - good for showcasing small icons and longer text for every entry.

RowSection.Builder

A builder that constructs RowSection instances.

SearchTemplate

A model that allows the user to enter text searches, and can display results in a list.

SearchTemplate.Builder

A builder of SearchTemplate.

Section

The generic interface for a single section within a sectioned item template.

Section.BaseBuilder

Generic Section builder that contains the fields that all sections share.

SectionedItemList

Represents an ItemList that is contained inside a section.

SectionedItemTemplate

A template that contains sections of items like rows, grid items, etc.

SectionedItemTemplate.Builder

A builder that constructs SectionedItemTemplate instances.

Tab

Represents a tab with a title and an image.

Tab.Builder

A builder of Tab.

TabContents

Represents the contents to display for a selected tab in a TabTemplate.

TabContents.Builder

A builder of TabContents.

TabTemplate

A template representing a list of tabs and contents for the active tab.

TabTemplate.Builder

A builder of TabTemplate.

TemplateInfo

Stores information about Template returned from a .

TemplateWrapper

A wrapper for mapping a Template with a unique ID used for implementing task flow restrictions.

Toggle

Represents a toggle that can have either a checked or unchecked state.

Toggle.Builder

A builder of Toggle.