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)
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:
Developers
setColor(int))setBitmap(Bitmap) or
setDrawable(Drawable)), which may be in transitionBackgroundManager holds references to potentially large bitmap Drawables.
Call release() to release these references when the Activity is not
visible.
Public methods | |
|---|---|
void
|
attach(Window window)
Makes the background visible on the given Window. |
final
int
|
getColor()
Returns the current background color. |
Drawable
|
getDefaultDimLayer()
Returns the default drawable used as a dim layer. |
Drawable
|
getDimLayer()
Returns the drawable used as a dim layer. |
Drawable
|
getDrawable()
Returns the current background |
static
BackgroundManager
|
getInstance(Activity activity)
Returns the BackgroundManager associated with the given Activity. |
boolean
|
isAttached()
Returns true if the background manager is currently attached; false otherwise. |
void
|
release()
Release references to Drawables. |
void
|
setBitmap(Bitmap bitmap)
Sets the given bitmap into the background. |
void
|
setColor(int color)
Sets the background to the given color. |
void
|
setDimLayer(Drawable drawable)
Sets the drawable used as a dim layer. |
void
|
setDrawable(Drawable drawable)
Sets the given drawable into the background. |
void
|
setThemeDrawableResourceId(int resourceId)
Sets the resource id for the drawable to be shown when there is no background set. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
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
|
int getColor ()
Returns the current background color.
| Returns | |
|---|---|
int |
|
Drawable getDefaultDimLayer ()
Returns the default drawable used as a dim layer.
| Returns | |
|---|---|
Drawable |
|
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 |
|
boolean isAttached ()
Returns true if the background manager is currently attached; false otherwise.
| Returns | |
|---|---|
boolean |
|
void release ()
Release references to Drawables. Typically called to reduce memory overhead when not visible.
When an Activity is started, 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.
void setBitmap (Bitmap bitmap)
Sets the given bitmap into the background. When using setBitmap 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
|
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
|
void setDimLayer (Drawable drawable)
Sets the drawable used as a dim layer.
| Parameters | |
|---|---|
drawable |
Drawable
|
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
|
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
|