Row.Builder

Builder()

Returns an empty Builder instance.

@RequiresCarApi(value = 6)
fun addAction(action: Action): Row.Builder

Adds an additional action to the end of the row. Note: From Car API 8 onwards, Rows are allowed to have 2 max actions to be set.

fun addText(text: CarText): Row.Builder

Adds a text string to the row below the title, with support for multiple length variants.

fun addText(text: CharSequence): Row.Builder

Adds a text string to the row below the title.

The text can be customized with ForegroundCarColorSpan, androidx.car.app.model.DistanceSpan, and androidx.car.app.model.DurationSpan instances, any other spans will be ignored by the host.

Most templates allow up to 2 text strings, but this may vary. This limit is documented in each individual template.

For example, assuming 2 lines are allowed in the template where the row will be used, this code:

rowBuilder
    .addText("This is a rather long line of text")
    .addText("More text")

would wrap the text like this:

This is a rather long li...
More text

rowBuilder
    .addText("This is a rather long line of text. More text")

would wrap the single line of text at a maximum of 2 lines, producing a different result:

This is a rather long line
of text. More text

Note that when using a single line, a line break character can be used to break it into two, but the results may be unpredictable depending on the width the text is wrapped at:

rowBuilder
    .addText("This is a rather long line of text\nMore text")

would produce a result that may loose the "More text" string:

This is a rather long line
of text

fun build(): Row

Constructs the Row defined by this builder.

fun setBrowsable(isBrowsable: Boolean): Row.Builder

Shows an icon at the end of the row that indicates that the row is browsable.

Browsable rows can be used, for example, to represent the parent row in a hierarchy of lists with child lists.

If a row is browsable, then no Action or Toggle can be added to it. A browsable row must have an OnClickListener set.

@RequiresCarApi(value = 5)
fun setEnabled(enabled: Boolean): Row.Builder

Sets the initial enabled state for Row.

The default state of a Row is enabled.

fun setImage(image: CarIcon): Row.Builder

Sets an image to show in the row with the default size IMAGE_TYPE_SMALL.

fun setImage(image: CarIcon, imageType: Int): Row.Builder

Sets an image to show in the row with the given image type.

For a custom CarIcon, its androidx.core.graphics.drawable.IconCompat instance can be of TYPE_BITMAP, TYPE_RESOURCE, or TYPE_URI.

If the input image's size exceeds the sizing requirements for the given image type in either one of the dimensions, it will be scaled down to be centered inside the bounding box while preserving its aspect ratio.

See CarIcon for more details related to providing icon and image resources that work with different car screen pixel densities.

@ExperimentalCarApi
fun setIndexable(indexable: Boolean): Row.Builder

Sets whether this item can be included in indexed lists. By default, this is set to true.

The host creates indexed lists to help users navigate through long lists more easily by sorting, filtering, or some other means.

For example, a media app may, by default, show a user's playlists sorted by date created. If the app provides these playlists via the SectionedItemTemplate and enables #isAlphabeticalIndexingAllowed, the user will be able to select a letter on a keyboard to jump to their playlists that start with that letter. When this happens, the list is reconstructed and sorted alphabetically, then shown to the user, jumping down to the letter. Items that are set to #setIndexable(false), do not show up in this new sorted list. Sticking with the media example, a media app may choose to hide things like "autogenerated playlists" from the list and only keep user created playlists.

Individual items can be set to be included or excluded from filtered lists, but it's also possible to enable/disable the creation of filtered lists as a whole via the template's API (eg. SectionedItemTemplate .Builder#setAlphabeticalIndexingAllowed(Boolean)).

fun setMetadata(metadata: Metadata): Row.Builder

Sets the Metadata associated with the row.

@RequiresCarApi(value = 6)
fun setNumericDecoration(decoration: Int): @IntRange(from = 0) Row.Builder

Sets a numeric decoration to display in the row.

Numeric decorations are displayed at the end of the row, but before any actions. Numeric decorations are not displayed in half-list templates.

Numeric decorations typically represent a quantity of unseen content. For example, a decoration might represent a number of missed notifications, or a number of unread messages in a conversation.

fun setOnClickListener(onClickListener: OnClickListener): Row.Builder

Sets the OnClickListener to be called back when the row is clicked.

Note that the listener relates to UI events and will be executed on the main thread using getMainLooper.

fun setTitle(title: CarText): Row.Builder

Sets the title of the row, with support for multiple length variants.

Only DistanceSpans and DurationSpans are supported in the input string.

fun setTitle(title: CharSequence): Row.Builder

Sets the title of the row.

Only DistanceSpans and DurationSpans are supported in the input string.

fun setToggle(toggle: Toggle): Row.Builder

Sets a Toggle to show in the row.

If a row has a toggle set, then no Action, OnClickListener or numeric decoration can be set.