RangeBuilder
open class RangeBuilder
kotlin.Any | |
↳ | androidx.slice.builders.ListBuilder.RangeBuilder |
Builder to construct a range row which can be added to a ListBuilder
.
A range row supports displaying a horizontal progress indicator.
Summary
Public constructors | |
---|---|
<init>() Builder to construct a range row which can be added to a |
Public methods | |
---|---|
open ListBuilder.RangeBuilder |
setContentDescription(@NonNull description: CharSequence) Sets the content description. |
open ListBuilder.RangeBuilder |
setLayoutDirection(layoutDirection: Int) Sets the desired layout direction for the content in this row. |
open ListBuilder.RangeBuilder |
Set the upper limit of the range. |
open ListBuilder.RangeBuilder |
Sets the progress bar mode, it could be the determinate or indeterminate mode. |
open ListBuilder.RangeBuilder |
setPrimaryAction(@NonNull action: SliceAction) Set the primary action for this row. |
open ListBuilder.RangeBuilder |
setSubtitle(@NonNull title: CharSequence) Set the subtitle. |
open ListBuilder.RangeBuilder |
setTitle(@NonNull title: CharSequence) Set the title. |
open ListBuilder.RangeBuilder |
setTitleItem(@NonNull icon: IconCompat, imageMode: Int) Sets the title item to be the provided icon. |
open ListBuilder.RangeBuilder |
setTitleItem(@NonNull icon: IconCompat, imageMode: Int, isLoading: Boolean) Sets the title item to be the provided icon. |
open ListBuilder.RangeBuilder |
Set the current value of the range. |
Public constructors
<init>
RangeBuilder()
Builder to construct a range row which can be added to a ListBuilder
.
A range row supports displaying a horizontal progress indicator. It supports two modes to represent progress: determinate and indeterminate, see setMode(int)
. Determinate mode is the default for progress indicator.
See Also
Public methods
setContentDescription
@NonNull open fun setContentDescription(@NonNull description: CharSequence): ListBuilder.RangeBuilder
Sets the content description.
setLayoutDirection
@NonNull open fun setLayoutDirection(layoutDirection: Int): ListBuilder.RangeBuilder
Sets the desired layout direction for the content in this row.
Parameters | |
---|---|
layoutDirection |
Int: the layout direction to set. |
setMax
@NonNull open fun setMax(max: Int): ListBuilder.RangeBuilder
Set the upper limit of the range. The default is 100.
setMode
@NonNull open fun setMode(mode: Int): ListBuilder.RangeBuilder
Sets the progress bar mode, it could be the determinate or indeterminate mode.
Parameters | |
---|---|
mode |
Int: the mode that progress bar should represent progress. |
setPrimaryAction
@NonNull open fun setPrimaryAction(@NonNull action: SliceAction): ListBuilder.RangeBuilder
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 androidx.slice.widget.SliceView#MODE_SHORTCUT
representation of the slice.
setSubtitle
@NonNull open fun setSubtitle(@NonNull title: CharSequence): ListBuilder.RangeBuilder
Set the subtitle.
setTitle
@NonNull open fun setTitle(@NonNull title: CharSequence): ListBuilder.RangeBuilder
Set the title.
setTitleItem
@NonNull open fun setTitleItem(
@NonNull icon: IconCompat,
imageMode: Int
): ListBuilder.RangeBuilder
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 using this method or its overload setTitleItem(IconCompat, int, boolean)
.
Parameters | |
---|---|
icon |
IconCompat: the image to display. |
imageMode |
Int: the mode that image should be displayed in. |
See Also
setTitleItem
@NonNull open fun setTitleItem(
@NonNull icon: IconCompat,
imageMode: Int,
isLoading: Boolean
): ListBuilder.RangeBuilder
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 using this method or its overload setTitleItem(IconCompat, int)
.
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 | |
---|---|
icon |
IconCompat: the image to display. |
imageMode |
Int: the mode that image should be displayed in. |
isLoading |
Boolean: whether this content is being loaded in the background. |
See Also
setValue
@NonNull open fun setValue(value: Int): ListBuilder.RangeBuilder
Set the current value of the range.
Parameters | |
---|---|
value |
Int: the value of the range, between 0 and setMax(int) . |