Overview

Builder to construct a header row.

A header provides some additional functionality compared to a ListBuilder.RowBuilder. Like a row, a header has a title, subtitle, and primary action.

In addition to a row's title, subtitle, and primary action, a header also supports setting a summary description of the list contents using ListBuilder.HeaderBuilder.setSummary(CharSequence). This summary might be used when the rest of the list content is not shown (e.g. if SliceView presenting slice is configured to SliceView.MODE_SMALL.

The primary action specified by ListBuilder.HeaderBuilder.setPrimaryAction(SliceAction) will be used as the PendingIntent sent when header is clicked. This action is also used when when SliceView displays in SliceView.MODE_SHORTCUT.

Unlike row builder, header builder does not support end items (e.g. ListBuilder.RowBuilder.addEndItem(SliceAction)). The header may be used to display actions set on the list via ListBuilder.addAction(SliceAction).

Summary

Constructors

Create builder for a header.

Methods

Sets the title for the header builder. A title should be representative of the contents of the slice and fit on a single line.

Sets the title for the header builder. A title should be representative of the contents of the slice and fit on a single line.

Use this method to specify content that will appear in the template once it's been loaded.

Parameters:

isLoading: indicates whether the app is doing work to load the added content in the background or not.

Sets the subtitle for the header builder. The subtitle should fit on a single line.

Sets the subtitle for the header builder. The subtitle should fit on a single line.

Use this method to specify content that will appear in the template once it's been loaded.

Parameters:

isLoading: indicates whether the app is doing work to load the added content in the background or not.

Sets the summary for the header builder. A summary is optional and should fit on a single line and is ellipsized if too long.

The summary should be a description of the contents of the list. This summary might be used when the rest of the list content is not shown (e.g. if SliceView presenting slice is configured to SliceView.MODE_SMALL.

Sets the summary for the header builder. A summary is optional and should fit on a single line and is ellipsized if too long.

The summary should be a description of the contents of the list. This summary might be used when the rest of the list content is not shown (e.g. if SliceView presenting slice is configured to SliceView.MODE_SMALL.

Use this method to specify content that will appear in the template once it's been loaded.

Parameters:

isLoading: indicates whether the app is doing work to load the added content in the background or not.

Sets the action to send when the header is clicked.

Additionally, the action specified here is used when the slice associated with this header is displayed in SliceView.MODE_SHORTCUT.

Sets the content description for the header.

Sets the desired layout direction for the content in this row.

Parameters:

layoutDirection: the layout direction to set.