BackgroundManager - Android SDK

Summary: Methods | Inherited Methods | [Expand All]

public final class

BackgroundManager

extends Object

java.lang.Object
↳	android.support.v17.leanback.app.BackgroundManager

Class Overview

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:

the background Drawable of the theme
a solid color (set via setColor(int))
two Drawables, previous and current (set via setBitmap(Bitmap) or setDrawable(Drawable)), which may be in transition

BackgroundManager holds references to potentially large bitmap Drawables. Call release() to release these references when the Activity is not visible.

Summary

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 `Drawable`.
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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public void attach (Window window)

Makes the background visible on the given Window. The background manager must be attached when the background is set.

public final int getColor ()

Returns the current background color.

public Drawable getDefaultDimLayer ()

Returns the default drawable used as a dim layer.

public Drawable getDimLayer ()

Returns the drawable used as a dim layer.

public Drawable getDrawable ()

Returns the current background Drawable.

public static 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.

public boolean isAttached ()

Returns true if the background manager is currently attached; false otherwise.

public 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.

public 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.

public 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.

public void setDimLayer (Drawable drawable)

Sets the drawable used as a dim layer.

public 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.

public 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.

Results

Interfaces

Classes