to top

Added in API level 1

public class

TransitionDrawable

extends LayerDrawable
implements Drawable.Callback

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.LayerDrawable
		↳	android.graphics.drawable.TransitionDrawable

Class Overview

An extension of LayerDrawables that is intended to cross-fade between the first and second layer. To start the transition, call startTransition(int). To display just the first layer, call resetTransition().

It can be defined in an XML file with the <transition> element. Each Drawable in the transition is defined in a nested <item>. For more information, see the guide to Drawable Resources.

Summary

XML Attributes
Attribute Name	Related Method	Description
android:bottom		Bottom coordinate of the layer.
android:drawable		Drawable used to render the layer.
android:id		Identifier of the layer.
android:left		Left coordinate of the layer.
android:right		Right coordinate of the layer.
android:top		Top coordinate of the layer.

[Expand]

Inherited XML Attributes

From class android.graphics.drawable.LayerDrawable

Public Constructors
	TransitionDrawable(Drawable[] layers) Create a new transition drawable with the specified list of layers.

Public Methods
void	draw(Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
boolean	isCrossFadeEnabled() Indicates whether the cross fade is enabled for this transition.
void	resetTransition() Show only the first layer.
void	reverseTransition(int duration) Reverses the transition, picking up where the transition currently is.
void	setCrossFadeEnabled(boolean enabled) Enables or disables the cross fade of the drawables.
void	startTransition(int durationMillis) Begin the second layer on top of the first layer.

[Expand]

Inherited Methods

From class android.graphics.drawable.LayerDrawable

void	draw(Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
Drawable	findDrawableByLayerId(int id) Look for a layer with the given id, and returns its `Drawable`.
int	getAlpha() Gets the current alpha value for the drawable.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Drawable	getDrawable(int index) Returns the drawable at the specified layer index.
int	getId(int index) Returns the id of the specified layer.
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
int	getNumberOfLayers() Returns the number of layers contained within this.
int	getOpacity() Return the opacity/transparency of this Drawable.
boolean	getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource.
void	invalidateDrawable(Drawable who) Called when the drawable needs to be redrawn.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isStateful() Indicates whether this view will change its appearance based on state.
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you recognize the specified state.
boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
void	scheduleDrawable(Drawable who, Runnable what, long when) A Drawable can call this to schedule the next frame of its animation.
void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setColorFilter(ColorFilter cf) Specify an optional colorFilter for the drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
boolean	setDrawableByLayerId(int id, Drawable drawable) Sets (or replaces) the `Drawable` for the layer with the given id.
void	setId(int index, int id) Sets the ID of a layer.
void	setLayerInset(int index, int l, int t, int r, int b) Specify modifiers to the bounds for the drawable[index].
void	setOpacity(int opacity) Sets the opacity of this drawable directly, instead of collecting the states from the layers
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleDrawable(Drawable who, Runnable what) A Drawable can call this to unschedule an action previously scheduled with `scheduleDrawable(Drawable, Runnable, long)`.

From class android.graphics.drawable.Drawable

void	clearColorFilter()
final Rect	copyBounds() Return a copy of the drawable's bounds in a new Rect.
final void	copyBounds(Rect bounds) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller).
static Drawable	createFromPath(String pathName) Create a drawable from file path name.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromStream(InputStream is, String srcName) Create a drawable from an inputstream
static Drawable	createFromXml(Resources r, XmlPullParser parser) Create a drawable from an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs) Create from inside an XML document.
abstract void	draw(Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
int	getAlpha() Gets the current alpha value for the drawable.
final Rect	getBounds() Return the drawable's bounds Rect.
Drawable.Callback	getCallback() Return the current `Drawable.Callback` implementation attached to this Drawable.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Drawable	getCurrent()
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
final int	getLevel() Retrieve the current level.
int	getMinimumHeight() Returns the minimum height suggested by this Drawable.
int	getMinimumWidth() Returns the minimum width suggested by this Drawable.
abstract int	getOpacity() Return the opacity/transparency of this Drawable.
boolean	getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
int[]	getState() Describes the current state, as a union of primitve states, such as `state_focused`, `state_selected`, etc.
Region	getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource.
void	invalidateSelf() Use the current `Drawable.Callback` implementation to have this Drawable redrawn.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isStateful() Indicates whether this view will change its appearance based on state.
final boolean	isVisible()
void	jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you recognize the specified state.
boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
static int	resolveOpacity(int op1, int op2) Return the appropriate opacity value for two source opacities.
void	scheduleSelf(Runnable what, long when) Use the current `Drawable.Callback` implementation to have this Drawable scheduled.
abstract void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setBounds(Rect bounds) Specify a bounding rectangle for the Drawable.
void	setBounds(int left, int top, int right, int bottom) Specify a bounding rectangle for the Drawable.
final void	setCallback(Drawable.Callback cb) Bind a `Drawable.Callback` object to this Drawable.
void	setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
abstract void	setColorFilter(ColorFilter cf) Specify an optional colorFilter for the drawable.
void	setColorFilter(int color, PorterDuff.Mode mode) Specify a color and porterduff mode to be the colorfilter for this drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
void	setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps).
final boolean	setLevel(int level) Specify the level for the drawable.
boolean	setState(int[] stateSet) Specify a set of states for the drawable.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleSelf(Runnable what) Use the current `Drawable.Callback` implementation to have this Drawable unscheduled.

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.

From interface android.graphics.drawable.Drawable.Callback

XML Attributes

android:bottom

Bottom coordinate of the layer.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol bottom.

Related Methods

android:drawable

Drawable used to render the layer.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol drawable.

Related Methods

android:id

Identifier of the layer. This can be used to retrieve the layer from a drawbable container.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol id.

Related Methods

android:left

Left coordinate of the layer.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol left.

Related Methods

android:right

Right coordinate of the layer.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol right.

Related Methods

android:top

Top coordinate of the layer.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol top.

Related Methods

Public Constructors

public TransitionDrawable (Drawable[] layers)

Added in API level 3

Create a new transition drawable with the specified list of layers. At least 2 layers are required for this drawable to work properly.

Public Methods

public void draw (Canvas canvas)

Added in API level 1

Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

Parameters

canvas	The canvas to draw into

public boolean isCrossFadeEnabled ()

Added in API level 1

Indicates whether the cross fade is enabled for this transition.

Returns

True if cross fading is enabled, false otherwise.

public void resetTransition ()

Added in API level 1

Show only the first layer.

public void reverseTransition (int duration)

Added in API level 1

Reverses the transition, picking up where the transition currently is. If the transition is not currently running, this will start the transition with the specified duration. If the transition is already running, the last known duration will be used.

Parameters

duration	The duration to use if no transition is running.

public void setCrossFadeEnabled (boolean enabled)

Added in API level 1

Enables or disables the cross fade of the drawables. When cross fade is disabled, the first drawable is always drawn opaque. With cross fade enabled, the first drawable is drawn with the opposite alpha of the second drawable. Cross fade is disabled by default.

Parameters

enabled	True to enable cross fading, false otherwise.

public void startTransition (int durationMillis)

Added in API level 1

Begin the second layer on top of the first layer.

Parameters

durationMillis	The length of the transition in milliseconds

Results

Interfaces

Classes

Enums

TransitionDrawable

Class Overview

Summary

XML Attributes

android:bottom

Related Methods

android:drawable

Related Methods

android:id

Related Methods

android:left

Related Methods

android:right

Related Methods

android:top

Related Methods

Public Constructors

public TransitionDrawable (Drawable[] layers)

Public Methods

public void draw (Canvas canvas)

Parameters

public boolean isCrossFadeEnabled ()

Returns

public void resetTransition ()

public void reverseTransition (int duration)

Parameters

public void setCrossFadeEnabled (boolean enabled)

Parameters

public void startTransition (int durationMillis)

Parameters