SectionedItemTemplate
@CarProtocol
@ExperimentalCarApi
public final class SectionedItemTemplate implements Template
A template that contains sections of items like rows, grid items, etc.
Summary
Nested types |
|---|
@ExperimentalCarApiA builder that constructs |
Public methods |
|
|---|---|
boolean |
|
@NonNull List<Action> |
Returns the list of actions that should appear alongside the content of this template. |
@Nullable Header |
Returns the optional header for this template. |
@NonNull List<Section<Object>> |
Returns the list of sections within this template. |
int |
hashCode() |
boolean |
Returns whether this list can be indexed alphabetically, by item title. |
boolean |
Returns whether or not this template is in a loading state. |
@NonNull String |
toString() |
Public methods
getActions
public @NonNull List<Action> getActions()
Returns the list of actions that should appear alongside the content of this template.
getHeader
public @Nullable Header getHeader()
Returns the optional header for this template.
getSections
public @NonNull List<Section<Object>> getSections()
Returns the list of sections within this template.
isAlphabeticalIndexingAllowed
public boolean isAlphabeticalIndexingAllowed()
Returns whether this list can be indexed alphabetically, by item title.
"Indexing" refers to the process of examining list contents (e.g. item titles) to sort, partition, or filter a list. Indexing is generally used for features called "Accelerators", which allow a user to quickly find a particular Item in a long list.
To exclude a single item from indexing, see the relevant item's API.
To enable/disable accelerators for the entire list, see setAlphabeticalIndexingAllowed
isLoading
public boolean isLoading()
Returns whether or not this template is in a loading state.