Animation

ABSOLUTE

int ABSOLUTE

The specified dimension is an absolute number of pixels.

Constant Value: 0 (0x00000000)

INFINITE

int INFINITE

Repeat the animation indefinitely.

Constant Value: -1 (0xffffffff)

RELATIVE_TO_PARENT

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.

Constant Value: 2 (0x00000002)

RELATIVE_TO_SELF

int RELATIVE_TO_SELF

The specified dimension holds a float and should be multiplied by the height or width of the object being animated.

Constant Value: 1 (0x00000001)

RESTART

int RESTART

When the animation reaches the end and the repeat count is INFINTE_REPEAT or a positive value, the animation restarts from the beginning.

Constant Value: 1 (0x00000001)

REVERSE

int REVERSE

When the animation reaches the end and the repeat count is INFINTE_REPEAT or a positive value, the animation plays backward (and then forward again).

Constant Value: 2 (0x00000002)

START_ON_FIRST_FRAME

int START_ON_FIRST_FRAME

Can be used as the start time to indicate the start time should be the current time when getTransformation(long, Transformation) is invoked for the first animation frame. This can is useful for short animations.

Constant Value: -1 (0xffffffff)

ZORDER_BOTTOM

int ZORDER_BOTTOM

Requests that the content being animated be forced under all other content for the duration of the animation.

Constant Value: -1 (0xffffffff)

ZORDER_NORMAL

int ZORDER_NORMAL

Requests that the content being animated be kept in its current Z order.

Constant Value: 0 (0x00000000)

ZORDER_TOP

int ZORDER_TOP

Requests that the content being animated be forced on top of all other content for the duration of the animation.

Constant Value: 1 (0x00000001)

Animation

Animation ()

Creates a new animation with a duration of 0ms, the default interpolator, with fillBefore set to true and fillAfter set to false

Animation

Animation (Context context, 
                AttributeSet attrs)

Creates a new animation whose parameters come from the specified context and attributes set.

cancel

void cancel ()

Cancel the animation. Cancelling an animation invokes the animation listener, if set, to notify the end of the animation. If you cancel an animation manually, you must call reset() before starting the animation again.

computeDurationHint

long computeDurationHint ()

Compute a hint at how long the entire animation may last, in milliseconds. Animations can be written to cause themselves to run for a different duration than what is computed here, but generally this should be accurate.

getBackgroundColor

int getBackgroundColor ()

Returns the background color behind the animation.

getDetachWallpaper

boolean getDetachWallpaper ()

Return value of setDetachWallpaper(boolean).

Related XML Attributes:

• android:detachWallpaper

getDuration

long getDuration ()

How long this animation should last

Related XML Attributes:

• android:duration

getFillAfter

boolean getFillAfter ()

If fillAfter is true, this animation will apply its transformation after the end time of the animation.

Related XML Attributes:

• android:fillAfter

getFillBefore

boolean getFillBefore ()

If fillBefore is true, this animation will apply its transformation before the start time of the animation. If fillBefore is false and fillEnabled is true, the transformation will not be applied until the start time of the animation.

Related XML Attributes:

• android:fillBefore

getInterpolator

Interpolator getInterpolator ()

Gets the acceleration curve type for this animation.

Related XML Attributes:

• android:interpolator

getRepeatCount

int getRepeatCount ()

Defines how many times the animation should repeat. The default value is 0.

Related XML Attributes:

• android:repeatCount

getRepeatMode

int getRepeatMode ()

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

Related XML Attributes:

• android:repeatMode

getStartOffset

long getStartOffset ()

When this animation should start, relative to StartTime

Related XML Attributes:

• android:startOffset

getStartTime

long getStartTime ()

When this animation should start. If the animation has not startet yet, this method might return START_ON_FIRST_FRAME.

getTransformation

boolean getTransformation (long currentTime, 
                Transformation outTransformation, 
                float scale)

Gets the transformation to apply at a specified point in time. Implementations of this method should always replace the specified Transformation or document they are doing otherwise.

getTransformation

boolean getTransformation (long currentTime, 
                Transformation outTransformation)

Gets the transformation to apply at a specified point in time. Implementations of this method should always replace the specified Transformation or document they are doing otherwise.

getZAdjustment

int getZAdjustment ()

Returns the Z ordering mode to use while running the animation as previously set by setZAdjustment(int).

Related XML Attributes:

• android:zAdjustment

hasEnded

boolean hasEnded ()

Indicates whether this animation has ended or not.

hasStarted

boolean hasStarted ()

Indicates whether this animation has started or not.

initialize

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 specified relative to these dimensions.)

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

isFillEnabled

boolean isFillEnabled ()

If fillEnabled is true, this animation will apply the value of fillBefore.

Related XML Attributes:

• android:fillEnabled

isInitialized

boolean isInitialized ()

Whether or not the animation has been initialized.

reset

void reset ()

Reset the initialization state of this animation.

restrictDuration

void restrictDuration (long durationMillis)

Ensure that the duration that this animation will run is not longer than durationMillis. In addition to adjusting the duration itself, this ensures that the repeat count also will not make it run longer than the given time.

scaleCurrentDuration

void scaleCurrentDuration (float scale)

How much to scale the duration by.

setAnimationListener

void setAnimationListener (Animation.AnimationListener listener)

Binds an animation listener to this animation. The animation listener is notified of animation events such as the end of the animation or the repetition of the animation.

setBackgroundColor

void setBackgroundColor (int bg)

Set background behind animation.

setDetachWallpaper

void setDetachWallpaper (boolean detachWallpaper)

If detachWallpaper is true, and this is a window animation of a window that has a wallpaper background, then the window will be detached from the wallpaper while it runs. That is, the animation will only be applied to the window, and the wallpaper behind it will remain static.

Related XML Attributes:

• android:detachWallpaper

setDuration

void setDuration (long durationMillis)

How long this animation should last. The duration cannot be negative.

Related XML Attributes:

• android:duration

setFillAfter

void setFillAfter (boolean fillAfter)

If fillAfter is true, the transformation that this animation performed will persist when it is finished. Defaults to false if not set. Note that this applies to individual animations and when using an AnimationSet to chain animations.

Related XML Attributes:

• android:fillAfter

setFillBefore

void setFillBefore (boolean fillBefore)

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

Related XML Attributes:

• android:fillBefore

setFillEnabled

void setFillEnabled (boolean fillEnabled)

If fillEnabled is true, the animation will apply the value of fillBefore. Otherwise, fillBefore is ignored and the animation transformation is always applied until the animation ends.

Related XML Attributes:

• android:fillEnabled

setInterpolator

void setInterpolator (Context context, 
                int resID)

Sets the acceleration curve for this animation. The interpolator is loaded as a resource from the specified context.

Related XML Attributes:

• android:interpolator

setInterpolator

void setInterpolator (Interpolator i)

Sets the acceleration curve for this animation. Defaults to a linear interpolation.

Related XML Attributes:

• android:interpolator

setRepeatCount

void setRepeatCount (int repeatCount)

Sets how many times the animation should be repeated. If the repeat count is 0, the animation is never repeated. If the repeat count is greater than 0 or INFINITE, the repeat mode will be taken into account. The repeat count is 0 by default.

Related XML Attributes:

• android:repeatCount

setRepeatMode

void setRepeatMode (int repeatMode)

Defines what this animation should do when it reaches the end. This setting is applied only when the repeat count is either greater than 0 or INFINITE. Defaults to RESTART.

Related XML Attributes:

• android:repeatMode

setStartOffset

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.

Related XML Attributes:

• android:startOffset

setStartTime

void setStartTime (long startTimeMillis)

When this animation should start. When the start time is set to START_ON_FIRST_FRAME, the animation will start the first time getTransformation(long, Transformation) is invoked. The time passed to this method should be obtained by calling currentAnimationTimeMillis() instead of currentTimeMillis().

setZAdjustment

void setZAdjustment (int zAdjustment)

Set the Z ordering mode to use while running the animation.

Related XML Attributes:

• android:zAdjustment

start

void start ()

Convenience method to start the animation the first time getTransformation(long, Transformation) is invoked.

startNow

void startNow ()

Convenience method to start the animation at the current time in milliseconds.

willChangeBounds

boolean willChangeBounds ()

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

willChangeTransformationMatrix

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.

applyTransformation

void applyTransformation (float interpolatedTime, 
                Transformation t)

Helper for getTransformation. Subclasses should implement this to apply their transforms given an interpolation value. Implementations of this method should always replace the specified Transformation or document they are doing otherwise.

clone

Animation clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

 x.clone().getClass() == x.getClass()

 x.clone().equals(x)

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

ensureInterpolator

void ensureInterpolator ()

Gurantees that this animation has an interpolator. Will use a AccelerateDecelerateInterpolator is nothing else was specified.

finalize

void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java^TM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

getScaleFactor

float getScaleFactor ()

The scale factor is set by the call to getTransformation. Overrides of getTransformation(long, Transformation, float) will get this value directly. Overrides of applyTransformation(float, Transformation) can call this method to get the value.

resolveSize

float resolveSize (int type, 
                float value, 
                int size, 
                int parentSize)

Convert the information in the description of a size to an actual dimension