ListTemplate
@CarProtocol
class ListTemplate : Template
A template representing a list 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
ItemListstructure between the templates have not changed. This means that if the previous template has multipleItemListsections, the new template must have the same number of sections with the same headers. Further, the number of rows and the title (not counting spans) of each row must not have changed. - For rows that contain a
Toggle, updates to the title are also allowed if the toggle state has changed between the previous and new templates.
Summary
Nested types |
|---|
class ListTemplate.BuilderA builder of |
Public functions |
|
|---|---|
Boolean |
|
ActionStrip? |
This function is deprecated. use |
(Mutable)List<Action!> |
@RequiresCarApi(value = 6)Returns the list of additional actions. |
Header? |
Returns the |
Action? |
This function is deprecated. use |
(Mutable)List<SectionedItemList!> |
Returns the list of |
ItemList? |
Returns the |
CarText? |
This function is deprecated. use |
Int |
hashCode() |
Boolean |
Returns whether the template is loading. |
ListTemplate.Builder |
Creates and returns a new |
String |
toString() |
Public functions
fungetActionStrip(): ActionStrip?
Returns the ActionStrip for this template or null if not set.
| See also | |
|---|---|
setActionStrip |
getActions
@RequiresCarApi(value = 6)
fun getActions(): (Mutable)List<Action!>
Returns the list of additional actions.
| See also | |
|---|---|
addAction |
getHeader
fun getHeader(): Header?
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 |
fungetHeaderAction(): Action?
Returns the Action that is set to be displayed in the header of the template, or null if not set.
| See also | |
|---|---|
setHeaderAction |
getSectionedLists
fun getSectionedLists(): (Mutable)List<SectionedItemList!>
Returns the list of SectionedItemList instances to be displayed in the template.
| See also | |
|---|---|
addSectionedList |
getSingleList
fun getSingleList(): ItemList?
Returns the ItemList instance containing the list of items to display or
null if one hasn't been set.
| See also | |
|---|---|
setSingleList |
isLoading
fun isLoading(): Boolean
Returns whether the template is loading.
| See also | |
|---|---|
setLoading |
toBuilder
@ExperimentalCarApi
fun toBuilder(): ListTemplate.Builder
Creates and returns a new Builder initialized with this ListTemplate's data.