Android - An Open Handset Alliance Project

android.graphics.drawable
public class

android.graphics.drawable.AnimationDrawable

java.lang.Object
	android.graphics.drawable.Drawable
		android.graphics.drawable.DrawableContainer		Drawable.Callback
			android.graphics.drawable.AnimationDrawable	Runnable

An object used to define frame-by-frame animations that can be used as a View object's background.

Each frame in a frame-by-frame animation is a drawable resource. The simplest way to create a frame-by-frame animation is to define the animation in an XML file in the drawable/ folder, set it as the background to a View object, then call AnimationDrawable.run() to start the animation, as shown here. More details about the format of the animation XML file are given in Frame by Frame Animation. spin_animation.xml file in res/drawable/ folder:

<!-- Animation frames are wheel0.png -- wheel5.png files inside the
 res/drawable/ folder -->
 <frames id="selected" oneshot="false">
    <frame drawable="@drawable/wheel0" duration="50" />
    <frame drawable="@drawable/wheel1" duration="50" />
    <frame drawable="@drawable/wheel2" duration="50" />
    <frame drawable="@drawable/wheel3" duration="50" />
    <frame drawable="@drawable/wheel4" duration="50" />
    <frame drawable="@drawable/wheel5" duration="50" />
 </frames>

Here is the Java 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.setBackground(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()

Summary

Public Constructors

AnimationDrawable()

Public Methods

				void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
				boolean	isRunning()
					Indicates whether the animation is currently running or not.
				void	run()
					This method exists for implementation purpose only and should not be called directly.
				boolean	setVisible(boolean visible, boolean restart)
					Set whether this Drawable is visible.
				void	start()
					Starts the animation, looping if necessary.
				void	stop()
					Stops the animation.
				void	unscheduleSelf(Runnable what)
					Use the current Drawable.Callback implementation to have this Drawable unscheduled.

Methods inherited from class android.graphics.drawable.DrawableContainer

				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).
				ConstantState	getConstantState()
				int	getIntrinsicHeight()
					Return the intrinsic height of the underlying drawable object.
				int	getIntrinsicWidth()
					Return the intrinsic width of the underlying drawable object.
				int	getMinimumHeight()
					Returns the minimum height suggested by this Drawable.
				int	getMinimumWidth()
					Returns the minimum width suggested by this Drawable.
				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	invalidateDrawable(Drawable who)
					Called when the drawable needs to be redrawn.
				boolean	isStateful()
					Indicates whether this view will change its appearance based on state.
				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.
				boolean	selectDrawable(int idx)
				void	setAlpha(int alpha)
					Specify an alpha value for the drawable.
				void	setColorFilter(ColorFilter cf)
					Specify an optional colorFilter for the drawable.
				void	setConstantState(DrawableContainerState state)
				void	setDither(boolean dither)
				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).

Methods inherited 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	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).
	final		Rect	getBounds()
				Return the drawable's bounds Rect.
			ConstantState	getConstantState()
			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)
			void	invalidateSelf()
				Use the current Drawable.Callback implementation to have this Drawable redrawn.
			boolean	isStateful()
				Indicates whether this view will change its appearance based on state.
	final		boolean	isVisible()
			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.
	final	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	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(Callback cb)
				Bind a Drawable.Callback object to this Drawable.
abstract			void	setColorFilter(ColorFilter cf)
				Specify an optional colorFilter for the drawable.
			void	setColorFilter(int color, Mode mode)
				Specify a color and porterduff mode to be the colorfilter for this drawable.
			void	setDither(boolean dither)
	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface android.graphics.drawable.Drawable.Callback

invalidateDrawable, scheduleDrawable, unscheduleDrawable

Methods inherited from interface java.lang.Runnable

run

Details

Public Constructors

public AnimationDrawable()

Public Methods

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

Throws

XmlPullParserException
IOException

public boolean isRunning()

Indicates whether the animation is currently running or not.

Returns

true if the animation is running, false otherwise

public void run()

This method exists for implementation purpose only and should not be called directly. Invoke start() instead.

public boolean setVisible(boolean visible, boolean restart)

Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.

Parameters

visible	Set to true if visible, false if not.
restart	You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.

public void start()

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

public void stop()

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

public void unscheduleSelf(Runnable what)

Use the current Drawable.Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

Parameters

what	The runnable that you no longer want called.

Android - An Open Handset Alliance Project

Documentation

Goodies

android.graphics.drawable.AnimationDrawable

Summary

Public Constructors

Public Methods

Methods inherited from class android.graphics.drawable.DrawableContainer

Methods inherited from class android.graphics.drawable.Drawable

Methods inherited from class java.lang.Object

Methods inherited from interface android.graphics.drawable.Drawable.Callback

Methods inherited from interface java.lang.Runnable

Details

Public Constructors

public AnimationDrawable()

Public Methods

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

Throws

public boolean isRunning()

Returns

public void run()

See Also

public boolean setVisible(boolean visible, boolean restart)

Parameters

public void start()

See Also

public void stop()

See Also

public void unscheduleSelf(Runnable what)

Parameters


e.g. "intent" or "activity"

				void	run()
					Begin doing the active part of the class' code.