Badge.Builder
public final class Badge.Builder
A builder of Badge.
Summary
Public methods |
|
|---|---|
@NonNull Badge |
build()Constructs the |
@NonNull Badge.Builder |
This method is deprecated. use |
@NonNull Badge.Builder |
setDotColor(@NonNull CarColor color)Sets the color of the dot to the given |
@NonNull Badge.Builder |
setHasDot(boolean hasDot)Enables a circular dot that denotes some sort of alert, notification, etc. |
@NonNull Badge.Builder |
Sets an icon to be displayed as a badge. |
@NonNull Badge.Builder |
setIconBackgroundColor(@NonNull CarColor color)Sets the color of the icon background to the given |
Public methods
build
public @NonNull Badge build()
Constructs the Badge defined by this builder.
| Throws | |
|---|---|
java.lang.IllegalStateException |
if the badge doesn't have a dot or an icon. |
java.lang.IllegalStateException |
if the a dot color is set but the badge has no dot. |
java.lang.IllegalStateException |
if the a icon background color is set but the badge has no icon. |
setBackgroundColor
public @NonNull Badge.BuildersetBackgroundColor(@NonNull CarColor backgroundColor)
Sets the color of the dot to the given backgroundColor.
setDotColor
public @NonNull Badge.Builder setDotColor(@NonNull CarColor color)
Sets the color of the dot to the given color.
setHasDot
public @NonNull Badge.Builder setHasDot(boolean hasDot)
Enables a circular dot that denotes some sort of alert, notification, etc.
setIcon
public @NonNull Badge.Builder setIcon(@NonNull CarIcon icon)
Sets an icon to be displayed as a badge.
An icon badge gives context about the associated element on which it is displayed. For example, a work profile icon badge is displayed with an app icon to indicate that it is a work app.
setIconBackgroundColor
public @NonNull Badge.Builder setIconBackgroundColor(@NonNull CarColor color)
Sets the color of the icon background to the given color.