AnimationDrawable  |  API reference  |  Android Developers (original) (raw)

public class AnimationDrawable
extends [DrawableContainer](/reference/android/graphics/drawable/DrawableContainer) implements[Animatable](/reference/android/graphics/drawable/Animatable), [Runnable](/reference/java/lang/Runnable)

An object used to create frame-by-frame animations, defined by a series of Drawable objects, which can be used as a View object's background.

The simplest way to create a frame-by-frame animation is to define the animation in an XML file, placed in the res/drawable/ folder, and set it as the background to a View object. Then, call [start()](/reference/android/graphics/drawable/AnimationDrawable#start%28%29) to run the animation.

An AnimationDrawable defined in XML consists of a single<animation-list> element and a series of nested<item> tags. Each item defines a frame of the animation. See the example below.

spin_animation.xml file in res/drawable/ folder:

Here is the code to load and play this animation.

// Load the ImageView that will host the animation and // set its background to our AnimationDrawable XML resource. ImageView img = (ImageView)findViewById(R.id.spinning_wheel_image); img.setBackgroundResource(R.drawable.spin_animation);

// Get the background, which has been compiled to an AnimationDrawable object. AnimationDrawable frameAnimation = (AnimationDrawable) img.getBackground();

// Start the animation (looped playback by default). frameAnimation.start();

Developer Guides

For more information about animating with AnimationDrawable, read theDrawable Animation developer guide.

Summary

XML attributes

android:drawable

Reference to a drawable resource to use for the frame. If not given, the drawable must be defined by the first child tag.

May be a reference to another resource, in the form "@[+][_package_:]_type_/_name_" or a theme attribute in the form "?[_package_:]_type_/_name_".

android:duration

Amount of time (in milliseconds) to display this frame.

May be an integer value, such as "100".

android:oneshot

If true, the animation will only run a single time and then stop. If false (the default), it will continually run, restarting at the first frame after the last has finished.

May be a boolean value, such as "true" or "false".

android:variablePadding

If true, allows the drawable's padding to change based on the current state that is selected. If false, the padding will stay the same (based on the maximum padding of all the states). Enabling this feature requires that the owner of the drawable deal with performing layout when the state changes, which is often not supported.

May be a boolean value, such as "true" or "false".

android:visible

Provides initial visibility state of the drawable; the default value is false. See[Drawable.setVisible(boolean, boolean)](/reference/android/graphics/drawable/Drawable#setVisible%28boolean,%20boolean%29).

May be a boolean value, such as "true" or "false".

Public constructors

AnimationDrawable

public AnimationDrawable ()

Public methods

addFrame

public void addFrame (Drawable frame, int duration)

Adds a frame to the animation

getDuration

public int getDuration (int i)

getFrame

public Drawable getFrame (int index)

getNumberOfFrames

public int getNumberOfFrames ()

inflate

public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.

isOneShot

public boolean isOneShot ()

isRunning

public boolean isRunning ()

Indicates whether the animation is currently running or not.

mutate

public Drawable mutate ()

Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.

run

public void run ()

This method exists for implementation purpose only and should not be called directly. Invoke [start()](/reference/android/graphics/drawable/AnimationDrawable#start%28%29) instead.

setOneShot

public void setOneShot (boolean oneShot)

Sets whether the animation should play once or repeat.

setVisible

public boolean setVisible (boolean visible, boolean restart)

Sets whether this AnimationDrawable is visible.

When the drawable becomes invisible, it will pause its animation. A subsequent change to visible with restart set to true will restart the animation from the first frame. If restart is false, the drawable will resume from the most recent frame. If the drawable has already reached the last frame, it will then loop back to the first frame, unless it's a one shot drawable (set through [setOneShot(boolean)](/reference/android/graphics/drawable/AnimationDrawable#setOneShot%28boolean%29)), in which case, it will stay on the last frame.

start

public void start ()

Starts the animation from the first frame, looping if necessary. This method has no effect if the animation is running.

Note: Do not call this in the[Activity.onCreate(Bundle)](/reference/android/app/Activity#onCreate%28android.os.Bundle%29) method of your activity, because the [AnimationDrawable](/reference/android/graphics/drawable/AnimationDrawable) is not yet fully attached to the window. If you want to play the animation immediately without requiring interaction, then you might want to call it from the[Activity.onWindowFocusChanged(boolean)](/reference/android/app/Activity#onWindowFocusChanged%28boolean%29) method in your activity, which will get called when Android brings your window into focus.

stop

public void stop ()

Stops the animation at the current frame. This method has no effect if the animation is not running.

unscheduleSelf

public void unscheduleSelf (Runnable what)

Use the current [Callback](/reference/android/graphics/drawable/Drawable.Callback) implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

Protected methods