Banner.Builder
public final class Banner.Builder
A builder of Banner.
Summary
Public methods |
|
|---|---|
@NonNull Banner.Builder |
addBelowAction(@NonNull Action action) |
@NonNull Banner.Builder |
addTrailingAction(@NonNull Action action)Adds an |
@NonNull Banner.Builder |
addTrailingIcon(@NonNull CarIcon icon)Adds a |
@NonNull Banner.Builder |
addTrailingImage(@NonNull CarIcon image)Adds a |
@NonNull Banner |
build()Constructs the |
@NonNull Banner.Builder |
setBackground(@NonNull Background background)Sets the |
@NonNull Banner.Builder |
setLeadingIcon(@NonNull CarIcon icon)Sets the leading element in this banner to be a |
@NonNull Banner.Builder |
setLeadingImage(@NonNull CarIcon image)Sets the leading element in this banner to be a |
@NonNull Banner.Builder |
setOnClickListener(@NonNull OnClickListener onClickListener)Sets the |
@NonNull Banner.Builder |
setSubtitle(@NonNull CarText subtitle)Sets the subtitle of the banner. |
@NonNull Banner.Builder |
setSubtitle(@NonNull CharSequence subtitle)Sets the subtitle of the banner. |
@NonNull Banner.Builder |
Sets the title of the banner. |
@NonNull Banner.Builder |
setTitle(@NonNull CharSequence title)Sets the title of the banner. |
Public methods
addBelowAction
public @NonNull Banner.Builder addBelowAction(@NonNull Action action)
Adds an Action below the title and subtitle of the Banner.
A Banner's below actions must conform to ACTION_CONSTRAINTS_BANNER_BELOW
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
addTrailingAction
public @NonNull Banner.Builder addTrailingAction(@NonNull Action action)
Adds an Action to the trailing part of the banner.
A banner can have at most 2 trailing elements
action must conform to ACTION_CONSTRAINTS_BANNER_TRAILING.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if there are already 2 trailing elements |
addTrailingIcon
public @NonNull Banner.Builder addTrailingIcon(@NonNull CarIcon icon)
Adds a CarIcon to be displayed as an icon to the trailing part of the banner.
A banner can have at most 2 trailing elements
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if there are already 2 trailing elements |
addTrailingImage
public @NonNull Banner.Builder addTrailingImage(@NonNull CarIcon image)
Adds a CarIcon to be displayed as an image to the trailing part of the banner.
A banner can have at most 2 trailing elements
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if there are already 2 trailing elements |
build
public @NonNull Banner build()
Constructs the Banner defined by this builder.
| Throws | |
|---|---|
java.lang.IllegalStateException |
if the title is null or empty |
java.lang.IllegalStateException |
if there are more than 4 elements across the banner's leading and trailing elements lists OR more than 2 of these elements are |
setBackground
public @NonNull Banner.Builder setBackground(@NonNull Background background)
Sets the Background of the banner.
The background must conform to COLOR_ONLY.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if an unsupported background is added |
setLeadingIcon
public @NonNull Banner.Builder setLeadingIcon(@NonNull CarIcon icon)
Sets the leading element in this banner to be a CarIcon displayed as an icon.
Only a single leading icon or image can be set, so this will overwrite calls to setLeadingImage.
This is visually distinct from setLeadingImage as icons are smaller due to added padding, and are expected to be tinted.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
setLeadingImage
public @NonNull Banner.Builder setLeadingImage(@NonNull CarIcon image)
Sets the leading element in this banner to be a CarIcon displayed as an image.
Only a single leading icon or image can be set, so this will overwrite calls to setLeadingIcon.
This is visually distinct from setLeadingIcon as images have no added padding, and are not expected to be tinted.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
setOnClickListener
public @NonNull Banner.Builder setOnClickListener(@NonNull OnClickListener onClickListener)
Sets the OnClickListener to be called back when the banner is clicked.
Note that the listener relates to UI events and will be executed on the main thread using getMainLooper.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
setSubtitle
public @NonNull Banner.Builder setSubtitle(@NonNull CarText subtitle)
Sets the subtitle of the banner.
The subtitle allows TEXT_WITH_COLORS_AND_ICON spans to be added.
The subtitle is automatically truncated if it's too long.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if any unsupported span types are added |
setSubtitle
public @NonNull Banner.Builder setSubtitle(@NonNull CharSequence subtitle)
Sets the subtitle of the banner.
The subtitle allows TEXT_WITH_COLORS_AND_ICON spans to be added.
The subtitle is automatically truncated if it's too long.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if any unsupported span types are added |
setTitle
public @NonNull Banner.Builder setTitle(@NonNull CarText title)
Sets the title of the banner.
The title allows TEXT_AND_ICON spans to be added.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if any unsupported span types are added |
setTitle
public @NonNull Banner.Builder setTitle(@NonNull CharSequence title)
Sets the title of the banner.
The title allows TEXT_AND_ICON spans to be added.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if any unsupported span types are added |