CarText.Builder
public final class CarText.Builder
A builder of CarText.
Summary
Public constructors |
|---|
Builder(@NonNull CharSequence text)Returns a new instance of a |
Public methods |
|
|---|---|
@NonNull CarText.Builder |
@RequiresCarApi(value = 2)Adds a text variant for the |
@NonNull CarText |
build()Constructs the |
Public constructors
Builder
public Builder(@NonNull CharSequence text)
Returns a new instance of a Builder.
Only CarSpan type spans are allowed in a CarText, other spans will be removed from the provided CharSequence.
| Parameters | |
|---|---|
@NonNull CharSequence text |
the first variant of the text to use. This represents the app's preferred text variant. Other alternatives can be supplied with |
| Throws | |
|---|---|
java.lang.NullPointerException |
if the text is |
| See also | |
|---|---|
addVariant |
Public methods
addVariant
@RequiresCarApi(value = 2)
public @NonNull CarText.Builder addVariant(@NonNull CharSequence text)
Adds a text variant for the CarText instance.
Only CarSpan type spans are allowed in a CarText, other spans will be removed from the provided CharSequence.
The text variants should be added in order of preference, from most to least preferred (for instance, from longest to shortest). If the text provided via Builder does not fit in the screen, the host will display the first variant that fits in the screen.
For instance, if the variant order is ["long string", "shorter", "short"], and the screen can fit 7 characters, "shorter" will be chosen. However, if the order is ["short", "shorter", "long string"], "short" will be chosen, because "short" fits within the 7 character limit.
| Throws | |
|---|---|
java.lang.NullPointerException |
if the text is |