Stay organized with collections
Save and categorize content based on your preferences.
BaseProgressIndicatorSpec
public
abstract
class
BaseProgressIndicatorSpec
extends Object
| java.lang.Object
|
| ↳ |
com.google.android.material.progressindicator.BaseProgressIndicatorSpec
|
This class contains the parameters shared between linear type and circular type. The parameters
reflect the attributes defined in R.styleable.BaseProgressIndicator.
Summary
Fields |
|---|
public
int |
hideAnimationBehavior
The animation behavior to hide the indicator and track.
|
public
int[] |
indicatorColors
The color array used in the indicator.
|
public
int |
indicatorTrackGapSize
The size of the gap between the indicator and the rest of the track.
|
public
int |
showAnimationBehavior
The animation behavior to show the indicator and track.
|
public
int |
trackColor
The color used in the track.
|
public
int |
trackCornerRadius
When this is greater than 0, the corners of both the track and the indicator will be rounded
with this radius.
|
public
int |
trackThickness
The thickness of the track and indicator.
|
Protected constructors |
|---|
BaseProgressIndicatorSpec(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Instantiates BaseProgressIndicatorSpec.
|
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
Fields
hideAnimationBehavior
public int hideAnimationBehavior
The animation behavior to hide the indicator and track.
indicatorColors
public int[] indicatorColors
The color array used in the indicator. In determinate mode, only the first item will be used.
indicatorTrackGapSize
public int indicatorTrackGapSize
The size of the gap between the indicator and the rest of the track.
showAnimationBehavior
public int showAnimationBehavior
The animation behavior to show the indicator and track.
trackColor
public int trackColor
The color used in the track. If not defined, it will be set to the indicatorColors and apply
the first disable alpha value from the theme.
trackCornerRadius
public int trackCornerRadius
When this is greater than 0, the corners of both the track and the indicator will be rounded
with this radius. If the radius is greater than half of the track width, an IllegalArgumentException will be thrown during initialization.
trackThickness
public int trackThickness
The thickness of the track and indicator.
Protected constructors
BaseProgressIndicatorSpec
protected BaseProgressIndicatorSpec (Context context,
AttributeSet attrs,
int defStyleAttr,
int defStyleRes)
Instantiates BaseProgressIndicatorSpec.
If attributes are missing, the values defined in the default style R.style.Widget_MaterialComponents_ProgressIndicator will be loaded.
| Parameters |
|---|
context |
Context: Current themed context. |
attrs |
AttributeSet: Component's attributes set.
|
defStyleAttr |
int |
defStyleRes |
int |
Public methods
isHideAnimationEnabled
public boolean isHideAnimationEnabled ()
isShowAnimationEnabled
public boolean isShowAnimationEnabled ()
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# BaseProgressIndicatorSpec\n\nSummary: [Fields](#lfields) \\| [Protected Ctors](#proctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nBaseProgressIndicatorSpec\n=========================\n\n\n`\npublic\n\n\nabstract\nclass\nBaseProgressIndicatorSpec\n`\n\n\n`\n\nextends Object\n\n\n`\n\n`\n\n\n`\n\n|---|-------------------------------------------------------------------------|\n| java.lang.Object ||\n| ↳ | com.google.android.material.progressindicator.BaseProgressIndicatorSpec |\n\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known direct subclasses [CircularProgressIndicatorSpec](/reference/com/google/android/material/progressindicator/CircularProgressIndicatorSpec), [LinearProgressIndicatorSpec](/reference/com/google/android/material/progressindicator/LinearProgressIndicatorSpec) |-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| | [CircularProgressIndicatorSpec](/reference/com/google/android/material/progressindicator/CircularProgressIndicatorSpec) | This class contains the parameters for drawing a circular type progress indicator. | | [LinearProgressIndicatorSpec](/reference/com/google/android/material/progressindicator/LinearProgressIndicatorSpec) | This class contains the parameters for drawing a linear type progress indicator. | |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nThis class contains the parameters shared between linear type and circular type. The parameters\nreflect the attributes defined in `R.styleable.BaseProgressIndicator`.\n\nSummary\n-------\n\n| ### Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` public int` | [hideAnimationBehavior](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#hideAnimationBehavior) The animation behavior to hide the indicator and track. |\n| ` public int[]` | [indicatorColors](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#indicatorColors) The color array used in the indicator. |\n| ` public int` | [indicatorTrackGapSize](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#indicatorTrackGapSize) The size of the gap between the indicator and the rest of the track. |\n| ` public int` | [showAnimationBehavior](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#showAnimationBehavior) The animation behavior to show the indicator and track. |\n| ` public int` | [trackColor](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#trackColor) The color used in the track. |\n| ` public int` | [trackCornerRadius](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#trackCornerRadius) When this is greater than 0, the corners of both the track and the indicator will be rounded with this radius. |\n| ` public int` | [trackThickness](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#trackThickness) The thickness of the track and indicator. |\n\n| ### Protected constructors ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[BaseProgressIndicatorSpec](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#BaseProgressIndicatorSpec(android.content.Context,%20android.util.AttributeSet,%20int,%20int))`(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) ` Instantiates BaseProgressIndicatorSpec. |\n\n| ### Public methods ||\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| ` boolean` | ` `[isHideAnimationEnabled](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#isHideAnimationEnabled())`() ` |\n| ` boolean` | ` `[isShowAnimationEnabled](/reference/com/google/android/material/progressindicator/BaseProgressIndicatorSpec#isShowAnimationEnabled())`() ` |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class\u003c?\u003e` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||\n\nFields\n------\n\n### hideAnimationBehavior\n\n```\npublic int hideAnimationBehavior\n```\n\nThe animation behavior to hide the indicator and track.\n\n\u003cbr /\u003e\n\n### indicatorColors\n\n```\npublic int[] indicatorColors\n```\n\nThe color array used in the indicator. In determinate mode, only the first item will be used.\n\n\u003cbr /\u003e\n\n### indicatorTrackGapSize\n\n```\npublic int indicatorTrackGapSize\n```\n\nThe size of the gap between the indicator and the rest of the track.\n\n\u003cbr /\u003e\n\n### showAnimationBehavior\n\n```\npublic int showAnimationBehavior\n```\n\nThe animation behavior to show the indicator and track.\n\n\u003cbr /\u003e\n\n### trackColor\n\n```\npublic int trackColor\n```\n\nThe color used in the track. If not defined, it will be set to the indicatorColors and apply\nthe first disable alpha value from the theme.\n\n\u003cbr /\u003e\n\n### trackCornerRadius\n\n```\npublic int trackCornerRadius\n```\n\nWhen this is greater than 0, the corners of both the track and the indicator will be rounded\nwith this radius. If the radius is greater than half of the track width, an `IllegalArgumentException` will be thrown during initialization.\n\n\u003cbr /\u003e\n\n### trackThickness\n\n```\npublic int trackThickness\n```\n\nThe thickness of the track and indicator.\n\n\u003cbr /\u003e\n\nProtected constructors\n----------------------\n\n### BaseProgressIndicatorSpec\n\n```\nprotected BaseProgressIndicatorSpec (Context context, \n AttributeSet attrs, \n int defStyleAttr, \n int defStyleRes)\n```\n\nInstantiates BaseProgressIndicatorSpec.\n\nIf attributes are missing, the values defined in the default style [R.style.Widget_MaterialComponents_ProgressIndicator](/reference/com/google/android/material/R.style#Widget_MaterialComponents_ProgressIndicator) will be loaded.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|----------------|----------------------------------------------------|\n| `context` | `Context`: Current themed context. \u003cbr /\u003e |\n| `attrs` | `AttributeSet`: Component's attributes set. \u003cbr /\u003e |\n| `defStyleAttr` | `int` \u003cbr /\u003e |\n| `defStyleRes` | `int` \u003cbr /\u003e |\n\nPublic methods\n--------------\n\n### isHideAnimationEnabled\n\n```\npublic boolean isHideAnimationEnabled ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------|--------|\n| `boolean` | \u003cbr /\u003e |\n\n### isShowAnimationEnabled\n\n```\npublic boolean isShowAnimationEnabled ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------|--------|\n| `boolean` | \u003cbr /\u003e |"]]
