added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0-beta01

ProgressBarManager

public final class ProgressBarManager
extends Object

java.lang.Object
   ↳ androidx.leanback.app.ProgressBarManager


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 & VerticalGridFragment to show ProgressBar while the data is being loaded.

Summary

Public constructors

ProgressBarManager()

Public methods

void disableProgressBar()

Disables progress bar.

void enableProgressBar()

Enables progress bar.

long getInitialDelay()

Returns the initial delay.

void hide()

Hides the progress bar.

void setInitialDelay(long initialDelay)

Sets the initial delay.

void setProgressBarView(View progressBarView)

Sets a custom view to be shown in place of the default ProgressBar.

void setRootView(ViewGroup rootView)

Sets the root view on which the progress bar will be attached.

void show()

Displays the progress bar.

Inherited methods

Public constructors

ProgressBarManager

added in version 1.0.0
public ProgressBarManager ()

Public methods

disableProgressBar

added in version 1.0.0
public void disableProgressBar ()

Disables progress bar.

enableProgressBar

added in version 1.0.0
public void enableProgressBar ()

Enables progress bar.

getInitialDelay

added in version 1.0.0
public long getInitialDelay ()

Returns the initial delay.

Returns
long

hide

added in version 1.0.0
public void hide ()

Hides the progress bar.

setInitialDelay

added in version 1.0.0
public void setInitialDelay (long initialDelay)

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

Parameters
initialDelay long: millisecond representing the initial delay.

setProgressBarView

added in version 1.0.0
public void setProgressBarView (View progressBarView)

Sets a custom view to be shown in place of the default ProgressBar. This view must have a parent. Once set, we maintain the visibility property of this view.

Parameters
progressBarView View: custom view that will be shown to indicate progress.

setRootView

added in version 1.0.0
public void setRootView (ViewGroup rootView)

Sets the root view on which the progress bar will be attached. This class assumes the root view to be FrameLayout in order to position the progress bar widget in the center of the screen.

Parameters
rootView ViewGroup: view that will contain the progress bar.

show

added in version 1.0.0
public void show ()

Displays the progress bar.