# ProgressBarManager

# ProgressBarManager

Artifact:[androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback)  
[View Source](https://cs.android.com/search?q=file:androidx/leanback/app/ProgressBarManager.java+class:androidx.leanback.app.ProgressBarManager)  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/leanback/app/ProgressBarManager "View this page in Java")

<br />

```
class ProgressBarManager
```

<br />

*** ** * ** ***

Manager for showing/hiding progress bar widget. This class lets user specify an initial delay after which the progress bar will be shown. This is currently being used in[BrowseFragment](https://developer.android.com/reference/kotlin/androidx/leanback/app/BrowseFragment)\&[VerticalGridFragment](https://developer.android.com/reference/kotlin/androidx/leanback/app/VerticalGridFragment)to show[ProgressBar](https://developer.android.com/reference/android/widget/ProgressBar.html)while the data is being loaded.

## Summary

|                                                        ### Public constructors                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------|
| [ProgressBarManager](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#ProgressBarManager())`()` |

|                             ### Public functions                              |
|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [disableProgressBar](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#disableProgressBar())`()` Disables progress bar.                                                                                                                                                                                                                                   |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [enableProgressBar](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#enableProgressBar())`()` Enables progress bar.                                                                                                                                                                                                                                      |
| [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | [getInitialDelay](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#getInitialDelay())`()` Returns the initial delay.                                                                                                                                                                                                                                     |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [hide](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#hide())`()` Hides the progress bar.                                                                                                                                                                                                                                                              |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setInitialDelay](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#setInitialDelay(long))`(initialDelay: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`)` Sets the initial delay.                                                                                                                                       |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setProgressBarView](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#setProgressBarView(android.view.View))`(progressBarView: `[View](https://developer.android.com/reference/android/view/View.html)`!)` Sets a custom view to be shown in place of the default[ProgressBar](https://developer.android.com/reference/android/widget/ProgressBar.html). |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setRootView](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#setRootView(android.view.ViewGroup))`(rootView: `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)`!)` Sets the root view on which the progress bar will be attached.                                                                                      |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [show](https://developer.android.com/reference/kotlin/androidx/leanback/app/ProgressBarManager#show())`()` Displays the progress bar.                                                                                                                                                                                                                                                           |

## Public constructors

### ProgressBarManager

Added in 1.1.0  

```
ProgressBarManager()
```  

## Public functions

### disableProgressBar

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun disableProgressBar(): Unit
```

Disables progress bar.  

### enableProgressBar

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun enableProgressBar(): Unit
```

Enables progress bar.  

### getInitialDelay

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun getInitialDelay(): Long
```

Returns the initial delay.  

### hide

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun hide(): Unit
```

Hides the progress bar.  

### setInitialDelay

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun setInitialDelay(initialDelay: Long): Unit
```

Sets the initial delay. Progress bar will be shown after this delay has elapsed.  

|                                          Parameters                                           |
|-----------------------------------------------------------------------------------------------|---------------------------------------------|
| `initialDelay: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | millisecond representing the initial delay. |

### setProgressBarView

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun setProgressBarView(progressBarView: View!): Unit
```

Sets a custom view to be shown in place of the default[ProgressBar](https://developer.android.com/reference/android/widget/ProgressBar.html). This view must have a parent. Once set, we maintain the visibility property of this view.  

|                                          Parameters                                          |
|----------------------------------------------------------------------------------------------|------------------------------------------------------|
| `progressBarView: `[View](https://developer.android.com/reference/android/view/View.html)`!` | custom view that will be shown to indicate progress. |

### setRootView

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun setRootView(rootView: ViewGroup!): Unit
```

Sets the root view on which the progress bar will be attached. This class assumes the root view to be[FrameLayout](https://developer.android.com/reference/android/widget/FrameLayout.html)in order to position the progress bar widget in the center of the screen.  

|                                           Parameters                                            |
|-------------------------------------------------------------------------------------------------|------------------------------------------|
| `rootView: `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)`!` | view that will contain the progress bar. |

### show

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)  

```
fun show(): Unit
```

Displays the progress bar.