Android - An Open Handset Alliance Project

android.view.animation
public class

android.view.animation.AnimationSet

java.lang.Object
	android.view.animation.Animation
		android.view.animation.AnimationSet

Represents a group of Animations that should be played together. The transformation of each individual animation are composed together into a single transform. If AnimationSet sets any properties that its children also set (for example, duration or fillBefore), the values of AnimationSet override the child values.

Summary

Constants inherited from class android.view.animation.Animation

ABSOLUTE, NO_REPEAT, RELATIVE_TO_PARENT, RELATIVE_TO_SELF, REPEAT, REVERSE

			Value
int	ABSOLUTE	The specified dimension is an absolute number of pixels.	0	0x00000000
int	NO_REPEAT	Don't do anything when the animation ends.	0	0x00000000
int	RELATIVE_TO_PARENT	The specified dimension holds a float and should be multiplied by the height or width of the parent of the object being animated.	2	0x00000002
int	RELATIVE_TO_SELF	The specified dimension holds a float and should be multiplied by the height or width of the object being animated.	1	0x00000001
int	REPEAT	Replay the animation from the beginning.	1	0x00000001
int	REVERSE	Replay the animation backwards (then forwards again).	2	0x00000002

Fields inherited from class android.view.animation.Animation

mCycleFlip, mDurationMillis, mEnded, mFillAfter, mFillBefore, mInitialized, mInterpolator, mListener, mRepeatMode, mStartOffsetMillis, mStartTimeMillis, mStarted

Public Constructors

					AnimationSet(Context context, AttributeSet attrs)
					Constructor used whan an AnimationSet is loaded from a resource.
					AnimationSet(boolean shareInterpolator)
					Constructor to use when building an AnimationSet from code

Public Methods

				void	addAnimation(Animation a)
					Add a child animation to this animation set.
				List	getAnimations()
				long	getDuration()
					The duration of an AnimationSet is defined to be the duration of the longest child animation.
				long	getStartTime()
					When this animation was started
				boolean	getTransformation(long currentTime, Transformation t)
					The transformation of an animation set is the concatenation of all of its component animations
				void	initialize(int width, int height, int parentWidth, int parentHeight)
					Initialize this animation with the dimensions of the object being animated as well as the objects parents.
				void	scaleCurrentDuration(float scale)
					How much to scale the duration by.
				void	setDuration(long durationMillis)
					Sets the duration of every child animation.
				void	setFillAfter(boolean fillAfter)
					If fillAfter is true, the transformation that this animation performed will persist when it is finished.
				void	setFillBefore(boolean fillBefore)
					If fillBefore is true, this animation will apply its transformation before the start time of the animation.
				void	setRepeatMode(int repeatMode)
					Defines what this animation should do when it reaches the end.
				void	setStartOffset(long startOffset)
					When this animation should start relative to the start time.
				void	setStartTime(long startTimeMillis)
					Sets the start time of this animation and all child animations
				boolean	willChangeTargetViewBounds()
					Indicates whether or not this animation will affect the current bounds of the target view.
				boolean	willChangeTransformationMatrix()
					Indicates whether or not this animation will affect the transformation matrix.

Methods inherited from class android.view.animation.Animation

				void	applyTransformation(float interpolatedTime, Transformation t)
					Helper for getTransformation.
				void	ensureInterpolator()
					Gurantees that this animation has an interpolator.
				long	getDuration()
					How long this animation should last
				boolean	getFillAfter()
					If fillAfter is true, this animation will apply its transformation after the end time of the animation.
				boolean	getFillBefore()
					If fillBefore is true, this animation will apply its transformation before the start time of the animation.
				Interpolator	getInterpolator()
					Gets the acceleration curve type for this animation.
				int	getRepeatMode()
					Defines what this animation should do when it reaches the end.
				long	getStartOffset()
					When this animation should start, relative to StartTime
				long	getStartTime()
					When this animation was started
				boolean	getTransformation(long currentTime, Transformation outTransformation)
					Gets the transformation to apply at a specified point in time
				void	initialize(int width, int height, int parentWidth, int parentHeight)
					Initialize this animation with the dimensions of the object being animated as well as the objects parents.
				boolean	isEnded()
					Indicates whether this animation has ended or not.
				boolean	isInitialized()
					Whether or not the animation has been initialized.
				boolean	isStarted()
					Indicates whether this animation has started or not.
				void	reset()
					Reset the initialization state of this animation.
				float	resolveSize(int type, float value, int size, int parentSize)
					Convert the information in the description of a size to an actual dimension
				void	scaleCurrentDuration(float scale)
					How much to scale the duration by.
				void	setAnimationListener(AnimationListener listener)
					Binds an animation listener to this animation.
				void	setDuration(long durationMillis)
					How long this animation should last.
				void	setFillAfter(boolean fillAfter)
					If fillAfter is true, the transformation that this animation performed will persist when it is finished.
				void	setFillBefore(boolean fillBefore)
					If fillBefore is true, this animation will apply its transformation before the start time of the animation.
				void	setInterpolator(Context context, int resID)
					Sets the acceleration curve for this animation.
				void	setInterpolator(Interpolator i)
					Sets the acceleration curve for this animation.
				void	setRepeatMode(int repeatMode)
					Defines what this animation should do when it reaches the end.
				void	setStartOffset(long startOffset)
					When this animation should start relative to the start time.
				void	setStartTime(long startTimeMillis)
					When this animation should start.
				void	start()
					Convenience method to start the animation the first time getTransformation(long, Transformation) is invoked.
				void	startNow()
					Convenience method to start the animation at the current time in milliseconds.
				boolean	willChangeTargetViewBounds()
					Indicates whether or not this animation will affect the current bounds of the target view.
				boolean	willChangeTransformationMatrix()
					Indicates whether or not this animation will affect the transformation matrix.

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

Details

Public Constructors

public AnimationSet(Context context, AttributeSet attrs)

Constructor used whan an AnimationSet is loaded from a resource.

Parameters

context	Application context to use
attrs	Attribute set from which to read values

public AnimationSet(boolean shareInterpolator)

Constructor to use when building an AnimationSet from code

Parameters

shareInterpolator	Pass true if all of the animations in this set should use the interpolator assocciated with this AnimationSet. Pass false if each animation should use its own interpolator.

Public Methods

public void addAnimation(Animation a)

Add a child animation to this animation set. The transforms of the child animations are applied in the order that they were added

Parameters

a	Animation to add.

public List getAnimations()

Returns

All the child animations in this AnimationSet. Note that this may include other AnimationSets, which are not expanded.

public long getDuration()

The duration of an AnimationSet is defined to be the duration of the longest child animation.

public long getStartTime()

When this animation was started

public boolean getTransformation(long currentTime, Transformation t)

The transformation of an animation set is the concatenation of all of its component animations

Parameters

currentTime	Where we are in the animation. This is wall clock time.
t	A tranformation object that is provided by the caller and will be filled in by the animation.

public void initialize(int width, int height, int parentWidth, int parentHeight)

Initialize this animation with the dimensions of the object being animated as well as the objects parents. (This is to support animation sizes being specifed relative to these dimensions.)

Objects that interpret a Animations should call this method when the sizes of the object being animated and its parent are known, and before calling getTransformation(long, Transformation).

Parameters

width	Width of the object being animated
height	Height of the object being animated
parentWidth	Width of the animated object's parent
parentHeight	Height of the animated object's parent

public void scaleCurrentDuration(float scale)

How much to scale the duration by.

Parameters

scale	The amount to scale the duration.

public void setDuration(long durationMillis)

Sets the duration of every child animation.

Parameters

durationMillis	the duration of the animation, in milliseconds, for every child in this set

public void setFillAfter(boolean fillAfter)

If fillAfter is true, the transformation that this animation performed will persist when it is finished. Defaults to true if not set. Note that this applies when using an AnimationSet to chain animations. The transformation is not applied before the AnimationSet itself starts.

Parameters

fillAfter	true if the animation should apply its transformation after it ends

public void setFillBefore(boolean fillBefore)

If fillBefore is true, this animation will apply its transformation before the start time of the animation. Defaults to false if not set. Note that this applies when using an AnimationSet to chain animations. The transformation is not applied before the AnimationSet itself starts.

Parameters

fillBefore	true if the animation should apply its transformation before it starts

public void setRepeatMode(int repeatMode)

Defines what this animation should do when it reaches the end. Defaults to NO_REPEAT

Parameters

repeatMode	One of NO_REPEAT, REPEAT, or REVERSE

public void setStartOffset(long startOffset)

When this animation should start relative to the start time. This is most useful when composing complex animations using an AnimationSet where some of the animations components start at different times.

Parameters

startOffset	When this Animation should start, in milliseconds from the start time of the root AnimationSet.

public void setStartTime(long startTimeMillis)

Sets the start time of this animation and all child animations

Parameters

startTimeMillis	the start time in milliseconds

public boolean willChangeTargetViewBounds()

Indicates whether or not this animation will affect the current bounds of the target view. For instance, a fade animation will not affect the bounds whereas a scale animation will.

public boolean willChangeTransformationMatrix()

Indicates whether or not this animation will affect the transformation matrix. For instance, a fade animation will not affect the matrix whereas a scale animation will.

protected	boolean	mCycleFlip
protected	long	mDurationMillis
protected	boolean	mEnded
protected	boolean	mFillAfter
protected	boolean	mFillBefore
protected	boolean	mInitialized
protected	Interpolator	mInterpolator
protected	AnimationListener	mListener
protected	int	mRepeatMode
protected	long	mStartOffsetMillis
protected	long	mStartTimeMillis
protected	boolean	mStarted


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.view.animation.AnimationSet

Summary

Constants inherited from class android.view.animation.Animation

Fields inherited from class android.view.animation.Animation

Public Constructors

Public Methods

Methods inherited from class android.view.animation.Animation

Methods inherited from class java.lang.Object

Details

Public Constructors

public AnimationSet(Context context, AttributeSet attrs)

Parameters

public AnimationSet(boolean shareInterpolator)

Parameters

Public Methods

public void addAnimation(Animation a)

Parameters

public List getAnimations()

Returns

public long getDuration()

See Also

public long getStartTime()

public boolean getTransformation(long currentTime, Transformation t)

Parameters

See Also

public void initialize(int width, int height, int parentWidth, int parentHeight)

Parameters

See Also

public void scaleCurrentDuration(float scale)

Parameters

See Also

public void setDuration(long durationMillis)

Parameters

public void setFillAfter(boolean fillAfter)

Parameters

public void setFillBefore(boolean fillBefore)

Parameters

public void setRepeatMode(int repeatMode)

Parameters

public void setStartOffset(long startOffset)

Parameters

public void setStartTime(long startTimeMillis)

Parameters

See Also

public boolean willChangeTargetViewBounds()

public boolean willChangeTransformationMatrix()