ListBuilder.RangeBuilder

class ListBuilder.RangeBuilder

Known direct subclasses
RangeBuilderDsl

Helper class annotated with @SliceMarker, which is annotated with @DslMarker.


Builder to construct a range row which can be added to a ListBuilder.

A range row supports displaying a horizontal progress indicator.

See also
addRange

Summary

Public constructors

Builder to construct a range row which can be added to a ListBuilder.

Public functions

ListBuilder.RangeBuilder

Sets the content description.

ListBuilder.RangeBuilder
setLayoutDirection(layoutDirection: Int)

Sets the desired layout direction for the content in this row.

ListBuilder.RangeBuilder
setMax(max: Int)

Set the upper limit of the range.

ListBuilder.RangeBuilder
setMode(mode: Int)

Sets the progress bar mode, it could be the determinate or indeterminate mode.

ListBuilder.RangeBuilder

Set the primary action for this row.

ListBuilder.RangeBuilder

Set the subtitle.

ListBuilder.RangeBuilder

Set the title.

ListBuilder.RangeBuilder
setTitleItem(icon: IconCompat, imageMode: Int)

Sets the title item to be the provided icon.

ListBuilder.RangeBuilder
setTitleItem(icon: IconCompat, imageMode: Int, isLoading: Boolean)

Sets the title item to be the provided icon.

ListBuilder.RangeBuilder
setValue(value: Int)

Set the current value of the range.

Public constructors

RangeBuilder

Added in 1.1.0-alpha02
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. Determinate mode is the default for progress indicator.

See also
addRange

Public functions

setContentDescription

Added in 1.1.0-alpha02
fun setContentDescription(description: CharSequence): ListBuilder.RangeBuilder

Sets the content description.

setLayoutDirection

Added in 1.1.0-alpha02
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

Added in 1.1.0-alpha02
fun setMax(max: Int): ListBuilder.RangeBuilder

Set the upper limit of the range. The default is 100.

setMode

Added in 1.1.0-alpha02
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

Added in 1.1.0-alpha02
fun setPrimaryAction(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 MODE_SHORTCUT representation of the slice.

setSubtitle

Added in 1.1.0-alpha02
fun setSubtitle(title: CharSequence): ListBuilder.RangeBuilder

Set the subtitle.

setTitle

Added in 1.1.0-alpha02
fun setTitle(title: CharSequence): ListBuilder.RangeBuilder

Set the title.

setTitleItem

Added in 1.1.0-alpha02
fun setTitleItem(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.

Parameters
icon: IconCompat

the image to display.

imageMode: Int

the mode that image should be displayed in.

setTitleItem

Added in 1.1.0-alpha02
fun setTitleItem(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.

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.

setValue

Added in 1.1.0-alpha02
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.