CircularProgressIndicator.Builder


public final class CircularProgressIndicator.Builder


Builder class for CircularProgressIndicator

Summary

Public constructors

Creates a builder for the CircularProgressIndicator.

Public methods

@NonNull CircularProgressIndicator

Constructs and returns CircularProgressIndicator with the provided field and look.

@NonNull CircularProgressIndicator.Builder
setCircularProgressIndicatorColors(
    @NonNull ProgressIndicatorColors circularProgressIndicatorColors
)

Sets the colors for the CircularProgressIndicator.

@NonNull CircularProgressIndicator.Builder

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

@NonNull CircularProgressIndicator.Builder

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

@NonNull CircularProgressIndicator.Builder
setEndAngle(float endAngle)

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

@NonNull CircularProgressIndicator.Builder
setOuterMarginApplied(boolean isApplied)

Sets whether this CircularProgressIndicator should have outer margin or not.

@NonNull CircularProgressIndicator.Builder
setProgress(@FloatRange(from = 0, to = 1) float progressRatio)

Sets the progress of the CircularProgressIndicator.

@NonNull CircularProgressIndicator.Builder

Sets the progress of the CircularProgressIndicator.

@NonNull CircularProgressIndicator.Builder
setStartAngle(float startAngle)

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

@NonNull CircularProgressIndicator.Builder

Sets the stroke width of the CircularProgressIndicator.

@NonNull CircularProgressIndicator.Builder
setStrokeWidth(@Dimension(unit = 0) float strokeWidth)

Sets the stroke width of the CircularProgressIndicator.

Public constructors

Builder

Added in 1.0.0
public Builder()

Creates a builder for the CircularProgressIndicator.

Public methods

build

Added in 1.0.0
public @NonNull CircularProgressIndicator build()

Constructs and returns CircularProgressIndicator with the provided field and look.

setCircularProgressIndicatorColors

Added in 1.0.0
public @NonNull CircularProgressIndicator.Builder setCircularProgressIndicatorColors(
    @NonNull ProgressIndicatorColors circularProgressIndicatorColors
)

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.0.0
public @NonNull CircularProgressIndicator.Builder setContentDescription(@NonNull CharSequence contentDescription)

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

setContentDescription

Added in 1.0.0
public @NonNull CircularProgressIndicator.Builder setContentDescription(
    @NonNull TypeBuilders.StringProp contentDescription
)

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

While this field is statically accessible from 1.0, it's only bindable since version 1.2 and renderers supporting version 1.2 will use the dynamic value (if set).

setEndAngle

Added in 1.0.0
public @NonNull CircularProgressIndicator.Builder setEndAngle(float endAngle)

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.

setOuterMarginApplied

Added in 1.2.0
public @NonNull CircularProgressIndicator.Builder setOuterMarginApplied(boolean isApplied)

Sets whether this CircularProgressIndicator should have outer margin or not.

If this indicator is used as a smaller element, use this method to remove an additional margin around it by setting it to false.

Otherwise, if this indicator is used as a full screen one or in , it's strongly recommended to set this to true.

If not set, defaults to true.

setProgress

Added in 1.0.0
public @NonNull CircularProgressIndicator.Builder setProgress(@FloatRange(from = 0, to = 1) float progressRatio)

Sets the progress of the CircularProgressIndicator. Progress ratio should be a value between 0 and 1. If not set, 0 will be used. Progress will be colored in getIndicatorColor.

setProgress

Added in 1.0.0
public @NonNull CircularProgressIndicator.Builder setProgress(@NonNull TypeBuilders.FloatProp progressRatio)

Sets the progress of the CircularProgressIndicator. If not set, static value provided using setProgress will be used, or 0. Progress will be colored in getIndicatorColor.

While this field is statically accessible from 1.0, it's only bindable since version 1.2 and renderers supporting version 1.2 will use the dynamic value (if set).

Parameters
@NonNull TypeBuilders.FloatProp progressRatio

The progress between 0 and 1. This field supports setting a dynamic value. The static value of progressRatio will be considered as 0 if it's smaller than zero and as 1 if it's larger than one.

setStartAngle

Added in 1.0.0
public @NonNull CircularProgressIndicator.Builder setStartAngle(float startAngle)

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.0.0
public @NonNull CircularProgressIndicator.Builder setStrokeWidth(@NonNull DimensionBuilders.DpProp strokeWidth)

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

setStrokeWidth

Added in 1.0.0
public @NonNull CircularProgressIndicator.Builder setStrokeWidth(@Dimension(unit = 0) float strokeWidth)

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