Added in API level 1

AnimationSet

Kotlin |Java

public class AnimationSet
extends Animation

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.

The way that AnimationSet inherits behavior from Animation is important to understand. Some of the Animation attributes applied to AnimationSet affect the AnimationSet itself, some are pushed down to the children, and some are ignored, as follows:

duration, repeatMode, fillBefore, fillAfter: These properties, when set on an AnimationSet object, will be pushed down to all child animations.
repeatCount, fillEnabled: These properties are ignored for AnimationSet.
startOffset, shareInterpolator: These properties apply to the AnimationSet itself.

Starting with Build.VERSION_CODES.ICE_CREAM_SANDWICH, the behavior of these properties is the same in XML resources and at runtime (prior to that release, the values set in XML were ignored for AnimationSet). That is, calling setDuration(500) on an AnimationSet has the same effect as declaring android:duration="500" in an XML resource for an AnimationSet object.

Summary

Inherited XML attributes

From class android.view.animation.Animation

`android:backdropColor`	Special option for window animations: whether the window's background should be used as a background to the animation.
`android:detachWallpaper`	Special option for window animations: if this window is on top of a wallpaper, don't animate the wallpaper with it.
`android:duration`	Amount of time (in milliseconds) for the animation to run.
`android:fillAfter`	When set to true, the animation transformation is applied after the animation is over.
`android:fillBefore`	When set to true or when fillEnabled is not set to true, the animation transformation is applied before the animation has started.
`android:fillEnabled`	When set to true, the value of fillBefore is taken into account.
`android:interpolator`	Defines the interpolator used to smooth the animation movement in time.
`android:repeatCount`	Defines how many times the animation should repeat.
`android:repeatMode`	Defines the animation behavior when it reaches the end and the repeat count is greater than 0 or infinite.
`android:showBackdrop`	Special option for window animations: whether to show a background behind the animating windows.
`android:startOffset`	Delay in milliseconds before the animation runs, once start time is reached.
`android:zAdjustment`	Allows for an adjustment of the Z ordering of the content being animated for the duration of the animation.

Inherited constants

From class android.view.animation.Animation

`int`	`ABSOLUTE` The specified dimension is an absolute number of pixels.
`int`	`INFINITE` Repeat the animation indefinitely.
`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.
`int`	`RELATIVE_TO_SELF` The specified dimension holds a float and should be multiplied by the height or width of the object being animated.
`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.
`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).
`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, android.view.animation.Transformation)` is invoked for the first animation frame.
`int`	`ZORDER_BOTTOM` Requests that the content being animated be forced under all other content for the duration of the animation.
`int`	`ZORDER_NORMAL` Requests that the content being animated be kept in its current Z order.
`int`	`ZORDER_TOP` Requests that the content being animated be forced on top of all other content for the duration of the animation.

Public constructors
`AnimationSet(Context context, AttributeSet attrs)` Constructor used when 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.
`long`	`computeDurationHint()` The duration hint of an animation set is the maximum of the duration hints of all of its component animations.
`List<Animation>`	`getAnimations()`
`long`	`getDuration()` The duration of an AnimationSet is defined to be the duration of the longest child animation.
`long`	`getStartTime()` When this animation should start.
`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`	`reset()` Reset the initialization state of this animation.
`void`	`restrictDuration(long durationMillis)` Ensure that the duration that this animation will run is not longer than `durationMillis`.
`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`	`willChangeBounds()` Indicates whether or not this animation will affect the bounds of the animated view.
`boolean`	`willChangeTransformationMatrix()` Indicates whether or not this animation will affect the transformation matrix.

Protected methods
`AnimationSet`	`clone()` Creates and returns a copy of this object.

Inherited methods

From class


        
          android.view.animation.Animation

`void`	`applyTransformation(float interpolatedTime, Transformation t)` Helper for getTransformation.
`void`	`cancel()` Cancel the animation.
`Animation`	`clone()` Creates and returns a copy of this object.
`long`	`computeDurationHint()` Compute a hint at how long the entire animation may last, in milliseconds.
`void`	`ensureInterpolator()` Gurantees that this animation has an interpolator.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`int`	`getBackdropColor()` Returns the background color to show behind the animating windows.
`int`	`getBackgroundColor()` This method was deprecated in API level 30. None of window animations are running with background color.
`boolean`	`getDetachWallpaper()` This method was deprecated in API level 29. All window animations are running with detached wallpaper.
`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`	`getRepeatCount()` Defines how many times the animation should repeat.
`int`	`getRepeatMode()` Defines what this animation should do when it reaches the end.
`float`	`getScaleFactor()` The scale factor is set by the call to `getTransformation`.
`boolean`	`getShowBackdrop()` If showBackdrop is `true` and this animation is applied on a window, then the windows in the animation will animate with the background associated with this window behind them.
`long`	`getStartOffset()` When this animation should start, relative to StartTime
`long`	`getStartTime()` When this animation should start.
`boolean`	`getTransformation(long currentTime, Transformation outTransformation, float scale)` Gets the transformation to apply at a specified point in time.
`boolean`	`getTransformation(long currentTime, Transformation outTransformation)` Gets the transformation to apply at a specified point in time.
`int`	`getZAdjustment()` Returns the Z ordering mode to use while running the animation as previously set by `setZAdjustment(int)`.
`boolean`	`hasEnded()` Indicates whether this animation has ended or not.
`boolean`	`hasStarted()` Indicates whether this animation has started or not.
`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`	`isFillEnabled()` If fillEnabled is true, this animation will apply the value of fillBefore.
`boolean`	`isInitialized()` Whether or not the animation has been initialized.
`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`	`restrictDuration(long durationMillis)` Ensure that the duration that this animation will run is not longer than `durationMillis`.
`void`	`scaleCurrentDuration(float scale)` How much to scale the duration by.
`void`	`setAnimationListener(Animation.AnimationListener listener)` Binds an animation listener to this animation.
`void`	`setBackdropColor(int backdropColor)` Set the color to use for the backdrop shown behind the animating windows.
`void`	`setBackgroundColor(int bg)` This method was deprecated in API level 30. None of window animations are running with background color.
`void`	`setDetachWallpaper(boolean detachWallpaper)` This method was deprecated in API level 29. All window animations are running with detached wallpaper.
`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`	`setFillEnabled(boolean fillEnabled)` If fillEnabled is true, the animation will apply the value of fillBefore.
`void`	`setInterpolator(Interpolator i)` Sets the acceleration curve for this animation.
`void`	`setInterpolator(Context context, int resID)` Sets the acceleration curve for this animation.
`void`	`setRepeatCount(int repeatCount)` Sets how many times the animation should be repeated.
`void`	`setRepeatMode(int repeatMode)` Defines what this animation should do when it reaches the end.
`void`	`setShowBackdrop(boolean showBackdrop)` If showBackdrop is `true` and this animation is applied on a window, then the windows in the animation will animate with the background associated with this window behind them.
`void`	`setStartOffset(long startOffset)` When this animation should start relative to the start time.
`void`	`setStartTime(long startTimeMillis)` When this animation should start.
`void`	`setZAdjustment(int zAdjustment)` Set the Z ordering mode to use while running the animation.
`void`	`start()` Convenience method to start the animation the first time `getTransformation(long, android.view.animation.Transformation)` is invoked.
`void`	`startNow()` Convenience method to start the animation at the current time in milliseconds.
`boolean`	`willChangeBounds()` Indicates whether or not this animation will affect the bounds of the animated view.
`boolean`	`willChangeTransformationMatrix()` Indicates whether or not this animation will affect the transformation matrix.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

AnimationSet

Added in API level 1

public AnimationSet (Context context, 
                AttributeSet attrs)

Constructor used when an AnimationSet is loaded from a resource.

Parameters
`context`	`Context`: Application context to use
`attrs`	`AttributeSet`: Attribute set from which to read values

AnimationSet

Added in API level 1

public AnimationSet (boolean shareInterpolator)

Constructor to use when building an AnimationSet from code

Parameters
`shareInterpolator`	`boolean`: Pass true if all of the animations in this set should use the interpolator associated with this AnimationSet. Pass false if each animation should use its own interpolator.

Public methods

addAnimation

Added in API level 1

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`: Animation to add.

computeDurationHint

Added in API level 3

public long computeDurationHint ()

The duration hint of an animation set is the maximum of the duration hints of all of its component animations.

Returns
`long`

See also:

Animation.computeDurationHint()

getAnimations

Added in API level 1

public List<Animation> getAnimations ()

Returns
`List<Animation>`	All the child animations in this AnimationSet. Note that this may include other AnimationSets, which are not expanded.

getDuration

Added in API level 1

public long getDuration ()

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

Returns
`long`	the duration in milliseconds of the animation

See also:

Animation.getDuration()

getStartTime

Added in API level 1

public long getStartTime ()

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

Returns
`long`	the time in milliseconds when the animation should start or `START_ON_FIRST_FRAME`

getTransformation

Added in API level 1

public boolean getTransformation (long currentTime, 
                Transformation t)

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

Parameters
`currentTime`	`long`: Where we are in the animation. This is wall clock time.
`t`	`Transformation`: A transformation object that is provided by the caller and will be filled in by the animation.

Returns
`boolean`	True if the animation is still running

See also:

Animation.getTransformation(long, Transformation)

initialize

Added in API level 1

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

Parameters
`width`	`int`: Width of the object being animated
`height`	`int`: Height of the object being animated
`parentWidth`	`int`: Width of the animated object's parent
`parentHeight`	`int`: Height of the animated object's parent

See also:

Animation.initialize(int, int, int, int)

reset

Added in API level 1

public void reset ()

Reset the initialization state of this animation.

restrictDuration

Added in API level 1

public 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.

Parameters
`durationMillis`	`long`: The maximum duration the animation is allowed to run.

scaleCurrentDuration

Added in API level 1

public void scaleCurrentDuration (float scale)

How much to scale the duration by.

Parameters
`scale`	`float`: The amount to scale the duration.

See also:

Animation.scaleCurrentDuration(float)

setDuration

Added in API level 1

public void setDuration (long durationMillis)

Sets the duration of every child animation.

Parameters
`durationMillis`	`long`: the duration of the animation, in milliseconds, for every child in this set

setFillAfter

Added in API level 1

public 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.

Parameters
`fillAfter`	`boolean`: true if the animation should apply its transformation after it ends

setFillBefore

Added in API level 1

public 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.

Parameters
`fillBefore`	`boolean`: true if the animation should apply its transformation before it starts

setRepeatMode

Added in API level 1

public 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.

Parameters
`repeatMode`	`int`: `Animation.RESTART` or `Animation.REVERSE`

setStartOffset

Added in API level 1

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`	`long`: When this Animation should start, in milliseconds from the start time of the root AnimationSet.

setStartTime

Added in API level 1

public void setStartTime (long startTimeMillis)

Sets the start time of this animation and all child animations

Parameters
`startTimeMillis`	`long`: the start time in milliseconds

See also:

Animation.setStartTime(long)

willChangeBounds

Added in API level 1

public 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.

Returns
`boolean`	true if this animation will change the view's bounds

willChangeTransformationMatrix

Added in API level 1

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.

Returns
`boolean`	true if this animation will change the transformation matrix

Protected methods

clone

Added in API level 1

protected AnimationSet 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

will be true, and that the expression:

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

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

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.

Returns
`AnimationSet`	a clone of this instance.

Throws
`CloneNotSupportedException`