ListBuilder.RatingBuilder
public final class ListBuilder.RatingBuilder
Builder to construct a input star rating.
An star rating row supports displaying a horizontal tappable stars allowing rating input.
| See also | |
|---|---|
addRating |
Summary
Public constructors |
|---|
|
Builder to construct a star rating row. |
Public constructors
RatingBuilder
public RatingBuilder()
Builder to construct a star rating row.
An star rating row supports displaying a horizontal slider allowing slider input.
| See also | |
|---|---|
addRating |
Public methods
setContentDescription
public @NonNull ListBuilder.RatingBuilder setContentDescription(@NonNull CharSequence description)
Sets the content description.
setInputAction
public @NonNull ListBuilder.RatingBuilder setInputAction(@NonNull PendingIntent action)
Set the PendingIntent to send when the current value is updated.
setInputAction
public @NonNull ListBuilder.RatingBuilder setInputAction(@NonNull RemoteCallback callback)
Set the PendingIntent to send when the current value is updated.
setMax
public @NonNull ListBuilder.RatingBuilder setMax(int max)
Set the upper limit of the range. The default is 100.
setMin
public @NonNull ListBuilder.RatingBuilder setMin(int min)
Set the lower limit of the range. The default is 0.
setPrimaryAction
public @NonNull ListBuilder.RatingBuilder setPrimaryAction(@NonNull SliceAction action)
Set the primary action for this row.
The action specified here will be sent when the whole row is clicked. If this is the first row in a ListBuilder this action will also be used to define the MODE_SHORTCUT representation of the slice.
setSubtitle
public @NonNull ListBuilder.RatingBuilder setSubtitle(@NonNull CharSequence title)
Set the subtitle.
setTitle
public @NonNull ListBuilder.RatingBuilder setTitle(@NonNull CharSequence title)
Set the title.
setTitleItem
public @NonNull ListBuilder.RatingBuilder setTitleItem(@NonNull IconCompat icon, int imageMode)
Sets the title item to be the provided icon. There can only be one title item, this will replace any other title items that may have been set.
| Parameters | |
|---|---|
@NonNull IconCompat icon |
the image to display. |
int imageMode |
the mode that image should be displayed in. |
| See also | |
|---|---|
ICON_IMAGE |
|
SMALL_IMAGE |
|
LARGE_IMAGE |
setTitleItem
public @NonNull ListBuilder.RatingBuilder setTitleItem(@NonNull IconCompat icon, int imageMode, boolean isLoading)
Sets the title item to be the provided icon. There can only be one title item, this will replace any other title items that may have been set.
When set to true, the parameter isLoading indicates that the app is doing work to load this content in the background, in this case the template displays a placeholder until updated.
| Parameters | |
|---|---|
@NonNull IconCompat icon |
the image to display. |
int imageMode |
the mode that image should be displayed in. |
boolean isLoading |
whether this content is being loaded in the background. |
| See also | |
|---|---|
ICON_IMAGE |
|
SMALL_IMAGE |
|
LARGE_IMAGE |
setValue
public @NonNull ListBuilder.RatingBuilder setValue(float value)
Set the current value of the range.