SectionedItemTemplate.Builder

Builder()

Create a new SectionedItemTemplate builder.

Builder(template: SectionedItemTemplate)

Create a new SectionedItemTemplate builder, copying the values from an existing instance.

@CanIgnoreReturnValue
fun addAction(action: Action): SectionedItemTemplate.Builder

Adds a single Action to this template, appending to the existing list of actions. All actions must conform to the ACTIONS_CONSTRAINTS_FAB constraints.

@CanIgnoreReturnValue
fun addSection(section: Section<*>): SectionedItemTemplate.Builder

Adds a single Section to this template, appending to the existing list of sections. Only sections listed in Builder can be added.

fun build(): SectionedItemTemplate

Constructs a new SectionedItemTemplate from the current state of this builder, throwing exceptions for any invalid state.

@CanIgnoreReturnValue
fun clearActions(): SectionedItemTemplate.Builder

Removes all actions in this template.

@CanIgnoreReturnValue
fun clearSections(): SectionedItemTemplate.Builder

Removes all sections from this template.

@CanIgnoreReturnValue
fun setActions(actions: (Mutable)List<Action!>): SectionedItemTemplate.Builder

Sets the actions that show up alongside the sections of this template (as opposed to the actions in the header), overwriting any other previously set actions from addAction or setActions. All actions must conform to the ACTIONS_CONSTRAINTS_FAB constraints.

@CanIgnoreReturnValue
fun setAlphabeticalIndexingAllowed(alphabeticalIndexingAllowed: Boolean): SectionedItemTemplate.Builder

Sets whether this list can be indexed alphabetically, by item title. By default, this is false.

"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.

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 jump to their playlists that start with the letter "H". When this happens, the list is reconstructed and sorted alphabetically, then shown to the user, jumping down to the letter "H".

Individual items may be excluded from the list by setting their #isIndexable field to false.

@CanIgnoreReturnValue
fun setAlphabeticalIndexingStrategy(alphabeticalIndexingStrategy: Int): SectionedItemTemplate.Builder

Sets how this list can be indexed alphabetically. By default, this is ALPHABETICAL_INDEXING_DISABLED.

"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.

For example, a media app may, by default, provide a user's playlists sorted by date created in addSection. If setAlphabeticalIndexingStrategy is set to a non-disabled value, the user will be able to jump to their playlists that start with the letter "H". When this happens, the list is reconstructed and sorted alphabetically, then shown to the user, jumping down to the letter "H".

Individual items may be excluded from the reconstructed list by setting their #isIndexable field to false.

@CanIgnoreReturnValue
fun setHeader(header: Header?): SectionedItemTemplate.Builder

Sets or clears the optional header for this template.

@CanIgnoreReturnValue
fun setLoading(isLoading: Boolean): SectionedItemTemplate.Builder

Sets whether or not this template is in a loading state. If passed true, sections cannot be added to the template. By default, this is false.

@CanIgnoreReturnValue
fun setScrollStatePersistenceStrategy(scrollStatePersistenceStrategy: Int): SectionedItemTemplate.Builder

Set how to handle a user's scroll position when this template is used as a refresh of another SectionedItemTemplate.

For example, if a user is currently scrolled down to item 10 in an existing SectionedItemTemplate, setting this field to SCROLL_STATE_PRESERVE_INDEX would cause the user to be shown item 10 from this template. Alternatively, SCROLL_STATE_RESET_TO_TOP would cause the user to be reset to the top of this template.

By default, this is set to SCROLL_STATE_RESET_TO_TOP.

@CanIgnoreReturnValue
fun setSections(sections: (Mutable)List<Section<*>!>): SectionedItemTemplate.Builder

Sets the sections in this template, overwriting any other previously set sections. Only sections listed in Builder can be added.