GridTemplate.Builder

public Builder()

Returns an empty Builder instance.

@RequiresCarApi(value = 7)
public @NonNull GridTemplate.Builder addAction(@NonNull Action action)

Adds a template scoped action outside of the grid items. This action will be displayed as a floating action button.

public @NonNull GridTemplate build()

Constructs the template defined by this builder.

Requirements

If none of the header Action, the header title or the action strip have been set on the template, the header is hidden.

public @NonNull GridTemplate.Builder setActionStrip(@NonNull ActionStrip actionStrip)

Sets the ActionStrip for this template.

Unless set with this method, the template will not have an action strip.

Requirements

@RequiresCarApi(value = 7)
public @NonNull GridTemplate.Builder setHeader(@NonNull Header header)

Sets the Header for this template.

The end header actions will show up differently inside vs outside of a map template. See addEndHeaderAction for more details.

public @NonNull GridTemplate.Builder setHeaderAction(@NonNull Action headerAction)

Sets the Action that will be displayed in the header of the template.

Unless set with this method, the template will not have a header action.

Requirements

@RequiresCarApi(value = 8)
public @NonNull GridTemplate.Builder setItemImageShape(int itemImageShape)

Sets the item image shape for this template.

Grid item images will all be cropped to the specified shape. If set to ITEM_IMAGE_SHAPE_UNSET, the images will be rendered as-is without changing the shape.

If not set, default to ITEM_IMAGE_SHAPE_UNSET.

@RequiresCarApi(value = 8)
public @NonNull GridTemplate.Builder setItemSize(int gridItemSize)

Sets a relative size of all grid items in the template.

This setting will affect the grid item image size and minimum width of each item. It can also impact the number of items displayed per row depending on screen size. These values may change in the future.

This setting takes precedence over the IMAGE_TYPE_LARGE setting for determining the grid item image size.

If this is not called, the default value is ITEM_SIZE_SMALL

public @NonNull GridTemplate.Builder setLoading(boolean isLoading)

Sets whether the template is in a loading state.

If set to true, the UI shows a loading indicator where the grid content would be otherwise. The caller is expected to call invalidate and send the new template content to the host once the data is ready. If set to false, the UI shows the ItemList contents added via setSingleList.

public @NonNull GridTemplate.Builder setSingleList(@NonNull ItemList list)

Sets a single ItemList to show in the template.

public @NonNull GridTemplate.Builder setTitle(@NonNull CharSequence title)

Sets the title of the template.

Unless set with this method, the template will not have a title.

Only DistanceSpans and DurationSpans are supported in the input string.