Banner.Builder
@RequiresCarApi(value = 9)
@ExperimentalCarApi
public final class Banner.Builder
A builder of Banner.
Summary
Public constructors |
|---|
Builder() |
Public methods |
|
|---|---|
@NonNull Banner.Builder |
addBelowAction(@NonNull Action action) |
@NonNull Banner.Builder |
addTrailingAction(@NonNull Action action)Adds an |
@NonNull Banner.Builder |
addTrailingImage(@NonNull CarIcon image)Adds a |
@NonNull Banner.Builder |
addTrailingImage(@NonNull CarIcon image, int imageType)Adds a |
@NonNull Banner |
build()Constructs the |
@NonNull Banner.Builder |
setLeadingImage(@NonNull CarIcon image)Sets the leading element in this banner to be a |
@NonNull Banner.Builder |
setLeadingImage(@NonNull CarIcon image, int imageType)Sets the leading element in this banner to be a |
@NonNull Banner.Builder |
setOnClickListener(@NonNull OnClickListener onClickListener)Sets the |
@NonNull Banner.Builder |
setStyle(@NonNull BannerStyle style)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 constructors
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.
Below actions cannot be used in combination with a large image.
| 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 |
addTrailingImage
public @NonNull Banner.Builder addTrailingImage(@NonNull CarIcon image)
Adds a CarIcon to be displayed as an IMAGE_TYPE_MEDIUM image at the trailing part of the Banner, not expected to be tinted.
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, int imageType)
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.
A large image cannot be used in combination with addBelowAction.
A large trailing image cannot be used in combination with another large trailing image.
| Parameters | |
|---|---|
@NonNull CarIcon image |
the |
int imageType |
one of |
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if there are already 2 trailing elements |
java.lang.IllegalArgumentException |
if a large trailing image is combined with anything other than a trailing small image or action |
build
public @NonNull Banner build()
Constructs the Banner defined by this builder.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the title is null or empty |
java.lang.IllegalArgumentException |
if below actions are used in combination with a large image |
setLeadingImage
public @NonNull Banner.Builder setLeadingImage(@NonNull CarIcon image)
Sets the leading element in this banner to be a CarIcon displayed as an IMAGE_TYPE_MEDIUM image, not expected to be tinted.
Only a single leading image can be set. Subsequent calls will overwrite previous calls.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
setLeadingImage
public @NonNull Banner.Builder setLeadingImage(@NonNull CarIcon image, int imageType)
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. Subsequent calls will overwrite previous calls.
A large image cannot be used in combination with addBelowAction.
| Parameters | |
|---|---|
@NonNull CarIcon image |
the |
int imageType |
one of |
| 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 |
setStyle
public @NonNull Banner.Builder setStyle(@NonNull BannerStyle style)
Sets the BannerStyle of the banner.
If a style is not provided via this method, a host default style will be used.
| 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 |