GridTemplate
@CarProtocol
public final class GridTemplate implements Template
A template representing a grid of items.
Template Restrictions In regards to template refreshes, as described inonGetTemplate, this template is considered a refresh of a previous one if:
- The previous template is in a loading state (see
setLoading, or - The template title has not changed, and the number of grid items and the title of each grid item have not changed.
Summary
Nested types |
|---|
public final class GridTemplate.BuilderA builder of |
Constants |
|
|---|---|
static final int |
Represents a preference to crop all grid item images into the shape of a circle. |
static final int |
Represents a preference to keep the images as-is without modifying their shape. |
static final int |
Represents a large size for all grid items within a template. |
static final int |
Represents a medium size for all grid items within a template. |
static final int |
Represents a small size for all grid items within a template. |
Public methods |
|
|---|---|
boolean |
|
@Nullable ActionStrip |
This method is deprecated. use |
@NonNull List<Action> |
@ExperimentalCarApiReturns the list of additional actions. |
@Nullable Header |
Returns the |
@Nullable Action |
This method is deprecated. use |
int |
Returns the item image shape. |
int |
Returns the grid item size, which applies to all grid items in the template. |
@Nullable ItemList |
Returns the |
@Nullable CarText |
This method is deprecated. use |
int |
hashCode() |
boolean |
Returns whether the template is loading. |
@NonNull String |
toString() |
Constants
ITEM_IMAGE_SHAPE_CIRCLE
@ExperimentalCarApi
public static final int ITEM_IMAGE_SHAPE_CIRCLE = 2
Represents a preference to crop all grid item images into the shape of a circle.
| See also | |
|---|---|
setItemImageShape |
ITEM_IMAGE_SHAPE_UNSET
@ExperimentalCarApi
public static final int ITEM_IMAGE_SHAPE_UNSET = 1
Represents a preference to keep the images as-is without modifying their shape.
This is the default setting.
| See also | |
|---|---|
setItemImageShape |
ITEM_SIZE_LARGE
@ExperimentalCarApi
public static final int ITEM_SIZE_LARGE = 4
Represents a large size for all grid items within a template.
| See also | |
|---|---|
setItemSize |
ITEM_SIZE_MEDIUM
@ExperimentalCarApi
public static final int ITEM_SIZE_MEDIUM = 2
Represents a medium size for all grid items within a template.
| See also | |
|---|---|
setItemSize |
ITEM_SIZE_SMALL
@ExperimentalCarApi
public static final int ITEM_SIZE_SMALL = 1
Represents a small size for all grid items within a template. This is the default size.
| See also | |
|---|---|
setItemSize |
Public methods
public @Nullable ActionStripgetActionStrip()
Returns the ActionStrip for this template or null if not set.
| See also | |
|---|---|
setActionStrip |
getActions
@ExperimentalCarApi
@RequiresCarApi(value = 7)
public @NonNull List<Action> getActions()
Returns the list of additional actions.
| See also | |
|---|---|
addAction |
getHeader
public @Nullable Header getHeader()
Returns the Header to display in this template.
This method was introduced in API 7, but is backwards compatible even if the client is using API 6 or below.
| See also | |
|---|---|
setHeader |
public @Nullable ActiongetHeaderAction()
Returns the Action that is set to be displayed in the header of the template, or null if not set.
| See also | |
|---|---|
setHeaderAction |
getItemImageShape
@ExperimentalCarApi
public int getItemImageShape()
Returns the item image shape.
All item images in the grid are cropped into the specified shape.
| See also | |
|---|---|
setItemImageShape |
getItemSize
@ExperimentalCarApi
public int getItemSize()
Returns the grid item size, which applies to all grid items in the template.
| See also | |
|---|---|
setItemSize |
getSingleList
public @Nullable ItemList getSingleList()
Returns the ItemList instance that contains the grid items to display or
null if not set.
| See also | |
|---|---|
setSingleList |
public @Nullable CarTextgetTitle()
Returns the title of the template or null if not set.
| See also | |
|---|---|
setTitle |
isLoading
public boolean isLoading()
Returns whether the template is loading.
| See also | |
|---|---|
setLoading |