CircularProgressIndicator.Builder

Added in 1.1.0
Deprecated in 1.2.0

class CircularProgressIndicator.Builder : LayoutElementBuilders.LayoutElement.Builder


Builder class for CircularProgressIndicator

Summary

Public constructors

Creates a builder for the CircularProgressIndicator.

Public functions

CircularProgressIndicator

Constructs and returns CircularProgressIndicator with the provided field and look.

CircularProgressIndicator.Builder
setCircularProgressIndicatorColors(
    circularProgressIndicatorColors: ProgressIndicatorColors
)

Sets the colors for the CircularProgressIndicator.

CircularProgressIndicator.Builder
setContentDescription(contentDescription: CharSequence)

Sets the content description of the CircularProgressIndicator to be used for accessibility support.

CircularProgressIndicator.Builder
setEndAngle(endAngle: Float)

Sets the end angle of the CircularProgressIndicator's background arc, where angle 0 is 12 o'clock.

CircularProgressIndicator.Builder
setProgress(progressPercentage: @FloatRange(from = 0, to = 1) Float)

Sets the progress of the CircularProgressIndicator.

CircularProgressIndicator.Builder
setStartAngle(startAngle: Float)

Sets the start angle of the CircularProgressIndicator's background arc, where angle 0 is 12 o'clock.

CircularProgressIndicator.Builder

Sets the stroke width of the CircularProgressIndicator.

CircularProgressIndicator.Builder
setStrokeWidth(strokeWidth: @Dimension(unit = 0) Float)

Sets the stroke width of the CircularProgressIndicator.

Public constructors

Builder

Added in 1.1.0
Deprecated in 1.2.0
Builder()

Creates a builder for the CircularProgressIndicator.

Public functions

build

Added in 1.1.0
Deprecated in 1.2.0
fun build(): CircularProgressIndicator

Constructs and returns CircularProgressIndicator with the provided field and look.

setCircularProgressIndicatorColors

Added in 1.1.0
Deprecated in 1.2.0
fun setCircularProgressIndicatorColors(
    circularProgressIndicatorColors: ProgressIndicatorColors
): CircularProgressIndicator.Builder

Sets the colors for the CircularProgressIndicator. If set, getIndicatorColor will be used for a progress that has been made, while getTrackColor will be used for a background full size arc. If not set, DEFAULT_COLORS will be used.

setContentDescription

Added in 1.1.0
Deprecated in 1.2.0
fun setContentDescription(contentDescription: CharSequence): CircularProgressIndicator.Builder

Sets the content description of the CircularProgressIndicator to be used for accessibility support.

setEndAngle

Added in 1.1.0
Deprecated in 1.2.0
fun setEndAngle(endAngle: Float): CircularProgressIndicator.Builder

Sets the end angle of the CircularProgressIndicator's background arc, where angle 0 is 12 o'clock. End angle doesn't need to be within 0-360 range, but it must be larger than start angle. If not set 360 will be used and the indicator will have full length.

setProgress

Added in 1.1.0
Deprecated in 1.2.0
fun setProgress(progressPercentage: @FloatRange(from = 0, to = 1) Float): CircularProgressIndicator.Builder

Sets the progress of the CircularProgressIndicator. Progress should be percentage from 0 to 1. Progress will be colored in getTrackColor. If not set, 0 will be used.

setStartAngle

Added in 1.1.0
Deprecated in 1.2.0
fun setStartAngle(startAngle: Float): CircularProgressIndicator.Builder

Sets the start angle of the CircularProgressIndicator's background arc, where angle 0 is 12 o'clock. Start angle doesn't need to be within 0-360 range. I.e. -90 is to start arc from the 9 o'clock. If not set 0 will be used and the indicator will have full length.

setStrokeWidth

Added in 1.1.0
Deprecated in 1.2.0
fun setStrokeWidth(strokeWidth: DimensionBuilders.DpProp): CircularProgressIndicator.Builder

Sets the stroke width of the CircularProgressIndicator. Strongly recommended value is DEFAULT_STROKE_WIDTH.

setStrokeWidth

Added in 1.1.0
Deprecated in 1.2.0
fun setStrokeWidth(strokeWidth: @Dimension(unit = 0) Float): CircularProgressIndicator.Builder

Sets the stroke width of the CircularProgressIndicator. Strongly recommended value is DEFAULT_STROKE_WIDTH.