Overview

A builder of GridTemplate.

Summary

Constructors
public	Builder() Returns an empty GridTemplate.Builder instance.

Methods
public GridTemplate	build() Constructs the template defined by this builder.
public GridTemplate.Builder	setActionStrip(ActionStrip actionStrip) Sets the ActionStrip for this template.
public GridTemplate.Builder	setHeaderAction(Action headerAction) Sets the Action that will be displayed in the header of the template.
public GridTemplate.Builder	setLoading(boolean isLoading) Sets whether the template is in a loading state.
public GridTemplate.Builder	setSingleList(ItemList list) Sets a single ItemList to show in the template.
public GridTemplate.Builder	setTitle(java.lang.CharSequence title) Sets the title of the template.
from java.lang.Object	clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

Returns an empty GridTemplate.Builder instance.

Methods

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 Screen.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 GridTemplate.Builder.setSingleList(ItemList).

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

This template only supports either one of Action.APP_ICON and Action.BACK as a header Action.

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.

Sets a single ItemList to show in the template.

Sets the ActionStrip for this template.

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

Requirements

This template allows up to 2 Actions in its ActionStrip. Of the 2 allowed Actions, one of them can contain a title as set via Action.Builder.setTitle(CharSequence). Otherwise, only Actions with icons are allowed.

Constructs the template defined by this builder.

Requirements

The number of items in the ItemList should be smaller or equal than the limit provided by ConstraintManager.CONTENT_LIMIT_TYPE_GRID. The host will ignore any items over that limit.

Either a header Action or title must be set on the template.

See also: ConstraintManager.getContentLimit(int)