Android - An Open Handset Alliance Project

android.view.animation
public class

android.view.animation.TranslateAnimation

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

An animation that controls the position of an object. See the full package description for details and sample code.

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

					TranslateAnimation(Context context, AttributeSet attrs)
					Constructor used whan an ScaleAnimation is loaded from a resource.
					TranslateAnimation(float fromXDelta, float toXDelta, float fromYDelta, float toYDelta)
					Constructor to use when building a ScaleAnimation from code
					TranslateAnimation(int fromXType, float fromXValue, int toXType, float toXValue, int fromYType, float fromYValue, int toYType, float toYValue)
					Constructor to use when building a ScaleAnimation from code

Public Methods

				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.

Protected Methods

				void	applyTransformation(float interpolatedTime, Transformation t)
					Helper for getTransformation.

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 TranslateAnimation(Context context, AttributeSet attrs)

Constructor used whan an ScaleAnimation is loaded from a resource.

Parameters

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

public TranslateAnimation(float fromXDelta, float toXDelta, float fromYDelta, float toYDelta)

Constructor to use when building a ScaleAnimation from code

Parameters

fromXDelta	Change in X coordinate to apply at the start of the animation
toXDelta	Change in X coordinate to apply at the end of the animation
fromYDelta	Change in Y coordinate to apply at the start of the animation
toYDelta	Change in Y coordinate to apply at the end of the animation

public TranslateAnimation(int fromXType, float fromXValue, int toXType, float toXValue, int fromYType, float fromYValue, int toYType, float toYValue)

Constructor to use when building a ScaleAnimation from code

Parameters

fromXType	Specifies how fromXValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.
fromXValue	Change in X coordinate to apply at the start of the animation. This value can either be an absolute number if fromXType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.
toXType	Specifies how toXValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.
toXValue	Change in X coordinate to apply at the end of the animation. This value can either be an absolute number if toXType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.
fromYType	Specifies how fromYValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.
fromYValue	Change in Y coordinate to apply at the start of the animation. This value can either be an absolute number if fromYType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.
toYType	Specifies how toYValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.
toYValue	Change in Y coordinate to apply at the end of the animation. This value can either be an absolute number if toYType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.

Public Methods

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

Protected Methods

protected void applyTransformation(float interpolatedTime, Transformation t)

Helper for getTransformation. Subclasses should implement this to apply their transforms given an interpolation value.

Parameters

interpolatedTime	The value of the normalized time (0.0 to 1.0) after it has been run through the interpolation function.
t	The Transofrmation object to fill in with the current transforms.

Android - An Open Handset Alliance Project

Documentation

Goodies

android.view.animation.TranslateAnimation

Summary

Constants inherited from class android.view.animation.Animation

Fields inherited from class android.view.animation.Animation

Public Constructors

Public Methods

Protected Methods

Methods inherited from class android.view.animation.Animation

Methods inherited from class java.lang.Object

Details

Public Constructors

public TranslateAnimation(Context context, AttributeSet attrs)

Parameters

public TranslateAnimation(float fromXDelta, float toXDelta, float fromYDelta, float toYDelta)

Parameters

public TranslateAnimation(int fromXType, float fromXValue, int toXType, float toXValue, int fromYType, float fromYValue, int toYType, float toYValue)

Parameters

Public Methods

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

Parameters

Protected Methods

protected void applyTransformation(float interpolatedTime, Transformation t)

Parameters

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"