Header.Builder
public final class Header.Builder
A builder of Header.
Summary
Public constructors |
|---|
Builder() |
Public methods |
|
|---|---|
@NonNull Header.Builder |
addEndHeaderAction(@NonNull Action headerAction)Adds an |
@NonNull Header |
build()Constructs the component defined by this builder. |
@NonNull Header.Builder |
@ExperimentalCarApiSets the |
@NonNull Header.Builder |
setStartHeaderAction(@NonNull Action headerAction)Sets the |
@NonNull Header.Builder |
@ExperimentalCarApiSets the subtitle of the component. |
@NonNull Header.Builder |
@ExperimentalCarApiSets the subtitle of the component. |
@NonNull Header.Builder |
Sets the title of the component, with support for multiple length variants. |
@NonNull Header.Builder |
setTitle(@NonNull CharSequence title)Sets the title of the component. |
Public constructors
Public methods
addEndHeaderAction
public @NonNull Header.Builder addEndHeaderAction(@NonNull Action headerAction)
Adds an Action that will be displayed at the end of a header.
Note: End header action will show up differently inside and outside of map-based templates.
- In a Non-map screen (eg.
MessageTemplate), actions appear as is, just as the app provides. A background color is allowed on the primary action. - In a Map-based screen (eg. Setting Header in the ContentTemplate in a
MapWithContentTemplate) only actions with custom icons or standard actions will appear in the Header. The label will be stripped off each action if an app still provides that. Any tint on the icon will be disabled and default to neutral token. The background color on the primary action would also be removed.
build
public @NonNull Header build()
Constructs the component defined by this builder.
Requirements
Either a start header Action or title must be set on the component.
| Throws | |
|---|---|
java.lang.IllegalStateException |
if neither a title nor start header |
java.lang.IllegalArgumentException |
if |
setBackground
@ExperimentalCarApi
@RequiresCarApi(value = 9)
public @NonNull Header.Builder setBackground(@NonNull Background background)
Sets the Background of the component.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
setStartHeaderAction
public @NonNull Header.Builder setStartHeaderAction(@NonNull Action headerAction)
Sets the Action that will be displayed at the start of a header.
By default, a header will not have a start action.
Requirements
Only one ofAPP_ICON or BACK is supported as a start header Action.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if |
java.lang.NullPointerException |
if |
setSubtitle
@ExperimentalCarApi
@RequiresCarApi(value = 9)
public @NonNull Header.Builder setSubtitle(@NonNull CarText subtitle)
Sets the subtitle of the component.
Support colors and icons.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
| See also | |
|---|---|
CarText |
setSubtitle
@ExperimentalCarApi
@RequiresCarApi(value = 9)
public @NonNull Header.Builder setSubtitle(@NonNull CharSequence subtitle)
Sets the subtitle of the component.
Support colors and icons.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
| See also | |
|---|---|
CarText |
setTitle
public @NonNull Header.Builder setTitle(@NonNull CarText title)
Sets the title of the component, with support for multiple length variants.
Only DistanceSpans and DurationSpans are supported in the input string.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
| See also | |
|---|---|
CarText |
setTitle
public @NonNull Header.Builder setTitle(@NonNull CharSequence title)
Sets the title of the component.
Only DistanceSpans and DurationSpans are supported in the input string.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
| See also | |
|---|---|
CarText |