# BackgroundManager added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1 Summary:[Methods](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#) # BackgroundManager | This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings). ` public final class BackgroundManager ` ` extends Object `` ` |---|----------------------------------------------------| | java.lang.Object || | ↳ | android.support.v17.leanback.app.BackgroundManager |
*** ** * ** *** Supports background image continuity between multiple Activities. An Activity should instantiate a BackgroundManager and[attach(Window)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#attach(android.view.Window))to the Activity's window. When the Activity is started, the background is initialized to the current background values stored in a continuity service. The background continuity service is updated as the background is updated. At some point, for example when it is stopped, the Activity may release its background state. When an Activity is resumed, if the BackgroundManager has not been released, the continuity service is updated from the BackgroundManager state. If the BackgroundManager was released, the BackgroundManager inherits the current state from the continuity service. When the last Activity is destroyed, the background state is reset. Backgrounds consist of several layers, from back to front: - the background Drawable of the theme - a solid color (set via[setColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setColor(int))) - two Drawables, previous and current (set via[setBitmap(Bitmap)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setBitmap(android.graphics.Bitmap))or[setDrawable(Drawable)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setDrawable(android.graphics.drawable.Drawable))), which may be in transition BackgroundManager holds references to potentially large bitmap Drawables. Call[release()](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#release())to release these references when the Activity is not visible. ## Summary | ### Public methods || |---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void` | ` `[attach](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#attach(android.view.Window))`(`[Window](https://developer.android.com/reference/android/view/Window.html)` window) ` Makes the background visible on the given Window. | | ` void` | ` `[attachToView](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#attachToView(android.view.View))`(`[View](https://developer.android.com/reference/android/view/View.html)` sceneRoot) ` Adds the composite drawable to the given view. | | ` void` | ` `[clearDrawable](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#clearDrawable())`() ` Clears the Drawable set by[setDrawable(Drawable)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setDrawable(android.graphics.drawable.Drawable))or[setBitmap(Bitmap)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setBitmap(android.graphics.Bitmap)). | | ` int` | ` `[getColor](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#getColor())`() ` Returns the current background color. | | ` `[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) | ` `[getDefaultDimLayer](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#getDefaultDimLayer())`() ` *This method was deprecated in API level 25.1.0. No longer support dim layer.* | | ` `[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) | ` `[getDimLayer](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#getDimLayer())`() ` *This method was deprecated in API level 25.1.0. No longer support dim layer.* | | ` `[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) | ` `[getDrawable](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#getDrawable())`() ` Returns the current background[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html). | | ` static `[BackgroundManager](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager) | ` `[getInstance](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#getInstance(android.app.Activity))`(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` activity) ` Returns the BackgroundManager associated with the given Activity. | | ` boolean` | ` `[isAttached](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#isAttached())`() ` Returns true if the background manager is currently attached; false otherwise. | | ` boolean` | ` `[isAutoReleaseOnStop](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#isAutoReleaseOnStop())`() ` | | ` void` | ` `[release](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#release())`() ` Release references to Drawable/Bitmap. | | ` void` | ` `[setAutoReleaseOnStop](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setAutoReleaseOnStop(boolean))`(boolean autoReleaseOnStop) ` Enable or disable call release() in Activity onStop(). | | ` void` | ` `[setBitmap](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setBitmap(android.graphics.Bitmap))`(`[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html)` bitmap) ` Sets the given bitmap into the background. | | ` void` | ` `[setColor](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setColor(int))`(int color) ` Sets the background to the given color. | | ` void` | ` `[setDimLayer](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setDimLayer(android.graphics.drawable.Drawable))`(`[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)` drawable) ` *This method was deprecated in API level 25.1.0. No longer support dim layer.* | | ` void` | ` `[setDrawable](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setDrawable(android.graphics.drawable.Drawable))`(`[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)` drawable) ` Sets the given drawable into the background. | | ` void` | ` `[setThemeDrawableResourceId](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setThemeDrawableResourceId(int))`(int resourceId) ` Sets the resource id for the drawable to be shown when there is no background set. | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#)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() ` | || ## Public methods ### attach added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void attach (Window window) ``` Makes the background visible on the given Window. The background manager must be attached when the background is set.
| Parameters || |----------|-----------------| | `window` | `Window`
| ### attachToView added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void attachToView (View sceneRoot) ``` Adds the composite drawable to the given view.
| Parameters || |-------------|---------------| | `sceneRoot` | `View`
| ### clearDrawable added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void clearDrawable () ``` Clears the Drawable set by[setDrawable(Drawable)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setDrawable(android.graphics.drawable.Drawable))or[setBitmap(Bitmap)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setBitmap(android.graphics.Bitmap)). BackgroundManager will show a solid color set by[setColor(int)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setColor(int))or theme drawable if color is not provided.
### getColor added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` int getColor () ``` Returns the current background color.
| Returns || |-------|--------| | `int` |
| ### getDefaultDimLayer added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` Drawable getDefaultDimLayer () ```
**This method was deprecated in API level 25.1.0.** No longer support dim layer. Returns the default drawable used as a dim layer.
| Returns || |---------------------------------------------------------------------------------------------|--------| | [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) |
| ### getDimLayer added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` Drawable getDimLayer () ```
**This method was deprecated in API level 25.1.0.** No longer support dim layer. Returns the drawable used as a dim layer.
| Returns || |---------------------------------------------------------------------------------------------|--------| | [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) |
| ### getDrawable added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` Drawable getDrawable () ``` Returns the current background[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html).
| Returns || |---------------------------------------------------------------------------------------------|--------| | [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html) |
| ### getInstance added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` BackgroundManager getInstance (Activity activity) ``` Returns the BackgroundManager associated with the given Activity. The BackgroundManager will be created on-demand for each individual Activity. Subsequent calls will return the same BackgroundManager created for this Activity.
| Parameters || |------------|-------------------| | `activity` | `Activity`
| | Returns || |-----------------------------------------------------------------------------------------------------------------|--------| | [BackgroundManager](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager) |
| ### isAttached added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean isAttached () ``` Returns true if the background manager is currently attached; false otherwise.
| Returns || |-----------|--------| | `boolean` |
| ### isAutoReleaseOnStop added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean isAutoReleaseOnStop () ```

| Returns || |-----------|-----------------------------------------------------------------| | `boolean` | True if release() in Activity.onStop(), false otherwise.
| ### release added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void release () ``` Release references to Drawable/Bitmap. Typically called in Activity onStop() to reduce memory overhead when not visible. It's app's responsibility to restore the drawable/bitmap in Activity onStart(). The method is automatically called in onStop() when[isAutoReleaseOnStop()](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#isAutoReleaseOnStop())is true.
**See also:** - [setAutoReleaseOnStop(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager#setAutoReleaseOnStop(boolean)) ### setAutoReleaseOnStop added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setAutoReleaseOnStop (boolean autoReleaseOnStop) ``` Enable or disable call release() in Activity onStop(). Default is true.
| Parameters || |---------------------|---------------------------------------------------------------------------------| | `autoReleaseOnStop` | `boolean`: True to call release() in Activity onStop(), false otherwise.
| ### setBitmap added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setBitmap (Bitmap bitmap) ``` Sets the given bitmap into the background. When using setCoverImageBitmap to set the background, the provided bitmap will be scaled and cropped to correctly fit within the dimensions of the view. The timing for when this becomes visible in the app is undefined and may take place after a small delay.
| Parameters || |----------|-----------------| | `bitmap` | `Bitmap`
| ### setColor added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setColor (int color) ``` Sets the background to the given color. The timing for when this becomes visible in the app is undefined and may take place after a small delay.
| Parameters || |---------|--------------| | `color` | `int`
| ### setDimLayer added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setDimLayer (Drawable drawable) ```
**This method was deprecated in API level 25.1.0.** No longer support dim layer. Sets the drawable used as a dim layer.
| Parameters || |------------|-------------------| | `drawable` | `Drawable`
| ### setDrawable added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setDrawable (Drawable drawable) ``` Sets the given drawable into the background. The provided Drawable will be used unmodified as the background, without any scaling or cropping applied to it. The timing for when this becomes visible in the app is undefined and may take place after a small delay.
| Parameters || |------------|-------------------| | `drawable` | `Drawable`
| ### setThemeDrawableResourceId added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setThemeDrawableResourceId (int resourceId) ``` Sets the resource id for the drawable to be shown when there is no background set. Overrides the window background drawable from the theme. This should be called before attaching.
| Parameters || |--------------|--------------| | `resourceId` | `int`
| - ## Interfaces - [BrowseFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentHost) - [BrowseFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterProvider) - [BrowseFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapterProvider) - [BrowseSupportFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentHost) - [BrowseSupportFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterProvider) - [BrowseSupportFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapterProvider) - [HeadersFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderClickedListener) - [HeadersFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderViewSelectedListener) - [HeadersSupportFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderClickedListener) - [HeadersSupportFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderViewSelectedListener) - [SearchFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider) - [SearchSupportFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.SearchResultProvider) - ## Classes - [BackgroundManager](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager) - [BaseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseFragment) - [BaseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseSupportFragment) - [BrandedFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedFragment) - [BrandedSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedSupportFragment) - [BrowseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment) - [BrowseFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.BrowseTransitionListener) - [BrowseFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentFactory) - [BrowseFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.ListRowFragmentFactory) - [BrowseFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapter) - [BrowseFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterRegistry) - [BrowseFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapter) - [BrowseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment) - [BrowseSupportFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.BrowseTransitionListener) - [BrowseSupportFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentFactory) - [BrowseSupportFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.ListRowFragmentFactory) - [BrowseSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapter) - [BrowseSupportFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterRegistry) - [BrowseSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapter) - [DetailsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragment) - [DetailsFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragmentBackgroundController) - [DetailsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragment) - [DetailsSupportFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragmentBackgroundController) - [ErrorFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorFragment) - [ErrorSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorSupportFragment) - [GuidedStepFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepFragment) - [GuidedStepSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepSupportFragment) - [HeadersFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment) - [HeadersSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment) - [OnboardingFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingFragment) - [OnboardingSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment) - [PlaybackFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment) - [PlaybackFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragmentGlueHost) - [PlaybackSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragment) - [PlaybackSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragmentGlueHost) - [ProgressBarManager](https://developer.android.com/reference/android/support/v17/leanback/app/ProgressBarManager) - [RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment) - [RowsFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentAdapter) - [RowsFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentRowsAdapter) - [RowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment) - [RowsSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentAdapter) - [RowsSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentRowsAdapter) - [SearchFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment) - [SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment) - [VerticalGridFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridFragment) - [VerticalGridSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridSupportFragment) - [VideoFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragment) - [VideoFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragmentGlueHost) - [VideoSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragment) - [VideoSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragmentGlueHost)