LinearProgressIndicatorSpec

View Source

public final class LinearProgressIndicatorSpec extends BaseProgressIndicatorSpec

java.lang.Object
↳	com.google.android.material.progressindicator.BaseProgressIndicatorSpec
	↳	com.google.android.material.progressindicator.LinearProgressIndicatorSpec

This class contains the parameters for drawing a linear type progress indicator. The parameters reflect the attributes defined in R.styleable.BaseProgressIndicator and R.styleable.LinearProgressIndicator.

Summary

Public fields
`boolean`	`hasInnerCornerRadius`
`int`	`indeterminateAnimationType` The type of animation of indeterminate mode.
`int`	`indicatorDirection` The direction in which the indicator will swipe or grow to.
`int`	`trackInnerCornerRadius`
`float`	`trackInnerCornerRadiusFraction`
`Integer`	`trackStopIndicatorPadding` The padding of the stop indicator at the end of the track.
`int`	`trackStopIndicatorSize` The size of the stop indicator at the end of the track.
`boolean`	`useRelativeTrackInnerCornerRadius`

Public constructors
`LinearProgressIndicatorSpec(Context context, AttributeSet attrs)` Instantiates the spec for `LinearProgressIndicator`.
`LinearProgressIndicatorSpec( Context context, AttributeSet attrs, int defStyleAttr )`
`LinearProgressIndicatorSpec( Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes )`

Public methods
`int`	`getTrackInnerCornerRadiusInPx()`
`boolean`	`useStrokeCap()` Returns true if the stroke ROUND cap should be used to prevent artifacts like (b/319309456), when fully rounded corners are specified.

Inherited fields

From com.google.android.material.progressindicator.BaseProgressIndicatorSpec

`int`	`hideAnimationBehavior` The animation behavior to hide the indicator and track.
`float`	`indeterminateAnimatorDurationScale` The scale of the animation duration in indeterminate mode.
`int[]`	`indicatorColors` The color array used in the indicator.
`int`	`indicatorTrackGapSize` The size of the gap between the indicator and the rest of the track.
`int`	`showAnimationBehavior` The animation behavior to show the indicator and track.
`int`	`trackColor` The color used in the track.
`int`	`trackCornerRadius` When this is greater than 0, the corners of both the track and the indicator will be rounded with this radius.
`float`	`trackCornerRadiusFraction` The fraction of the track thickness to be used as the corner radius.
`int`	`trackThickness` The thickness of the track and indicator.
`boolean`	`useRelativeTrackCornerRadius` When this is true, the {#link trackCornerRadiusFraction} takes effect.
`int`	`waveAmplitude` The size of the amplitude, if a wave effect is configured.
`int`	`waveSpeed` The speed of the waveform, if a wave effect is configured.
`int`	`wavelengthDeterminate` The size of the wavelength in determinate mode, if a wave effect is configured.
`int`	`wavelengthIndeterminate` The size of the wavelength in indeterminate mode, if a wave effect is configured.

Inherited methods

From com.google.android.material.progressindicator.BaseProgressIndicatorSpec

`int`	`getTrackCornerRadiusInPx()` Returns the track corner radius in pixels.
`boolean`	`hasWavyEffect(boolean isDeterminate)`
`boolean`	`isHideAnimationEnabled()`
`boolean`	`isShowAnimationEnabled()`

Public fields

hasInnerCornerRadius

public boolean hasInnerCornerRadius

indeterminateAnimationType

public int indeterminateAnimationType

The type of animation of indeterminate mode.

indicatorDirection

public int indicatorDirection

The direction in which the indicator will swipe or grow to.

trackInnerCornerRadius

public int trackInnerCornerRadius

trackInnerCornerRadiusFraction

public float trackInnerCornerRadiusFraction

trackStopIndicatorPadding

public Integer trackStopIndicatorPadding

The padding of the stop indicator at the end of the track.

trackStopIndicatorSize

public int trackStopIndicatorSize

The size of the stop indicator at the end of the track.

useRelativeTrackInnerCornerRadius

public boolean useRelativeTrackInnerCornerRadius

Public constructors

LinearProgressIndicatorSpec

public LinearProgressIndicatorSpec(Context context, AttributeSet attrs)

Instantiates the spec for LinearProgressIndicator.

If attributes in R.styleable.LinearProgressIndicator are missing, the values in the default style Widget.MaterialComponents.LinearProgressIndicator will be loaded. If attributes in R.styleable.BaseProgressIndicator are missing, the values in the default style Widget.MaterialComponents.ProgressIndicator will be loaded.

Parameters
`Context context`	Current themed context.
`AttributeSet attrs`	Component's attributes set.

LinearProgressIndicatorSpec

public LinearProgressIndicatorSpec(
    Context context,
    AttributeSet attrs,
    int defStyleAttr
)

LinearProgressIndicatorSpec

public LinearProgressIndicatorSpec(
    Context context,
    AttributeSet attrs,
    int defStyleAttr,
    int defStyleRes
)

Public methods

getTrackInnerCornerRadiusInPx

public int getTrackInnerCornerRadiusInPx()

useStrokeCap

public boolean useStrokeCap()

Returns true if the stroke ROUND cap should be used to prevent artifacts like (b/319309456), when fully rounded corners are specified.