AnimatorSet.Builder

Kotlin |Java

public class AnimatorSet.Builder
extends Object

java.lang.Object
↳	android.animation.AnimatorSet.Builder

The Builder object is a utility class to facilitate adding animations to a AnimatorSet along with the relationships between the various animations. The intention of the Builder methods, along with the play() method of AnimatorSet is to make it possible to express the dependency relationships of animations in a natural way. Developers can also use the playTogether() and playSequentially() methods if these suit the need, but it might be easier in some situations to express the AnimatorSet of animations in pairs.

The Builder object cannot be constructed directly, but is rather constructed internally via a call to AnimatorSet.play(Animator).

For example, this sets up a AnimatorSet to play anim1 and anim2 at the same time, anim3 to play when anim2 finishes, and anim4 to play when anim3 finishes:

     AnimatorSet s = new AnimatorSet();
     s.play(anim1).with(anim2);
     s.play(anim2).before(anim3);
     s.play(anim4).after(anim3);

Note in the example that both Builder.before(Animator) and after(android.animation.Animator) are used. These are just different ways of expressing the same relationship and are provided to make it easier to say things in a way that is more natural, depending on the situation.

It is possible to make several calls into the same Builder object to express multiple relationships. However, note that it is only the animation passed into the initial AnimatorSet.play(Animator) method that is the dependency in any of the successive calls to the Builder object. For example, the following code starts both anim2 and anim3 when anim1 ends; there is no direct dependency relationship between anim2 and anim3:

   AnimatorSet s = new AnimatorSet();
   s.play(anim1).before(anim2).before(anim3);

If the desired result is to play anim1 then anim2 then anim3, this code expresses the relationship correctly:

   AnimatorSet s = new AnimatorSet();
   s.play(anim1).before(anim2);
   s.play(anim2).before(anim3);

Note that it is possible to express relationships that cannot be resolved and will not result in sensible results. For example, play(anim1).after(anim1) makes no sense. In general, circular dependencies like this one (or more indirect ones where a depends on b, which depends on c, which depends on a) should be avoided. Only create AnimatorSets that can boil down to a simple, one-way relationship of animations starting with, before, and after other, different, animations.

Summary

Public methods
`AnimatorSet.Builder`	`after(long delay)` Sets up the animation supplied in the `AnimatorSet.play(Animator)` call that created this `Builder` object to play when the given amount of time elapses.
`AnimatorSet.Builder`	`after(Animator anim)` Sets up the given animation to play when the animation supplied in the `AnimatorSet.play(Animator)` call that created this `Builder` object to start when the animation supplied in this method call ends.
`AnimatorSet.Builder`	`before(Animator anim)` Sets up the given animation to play when the animation supplied in the `AnimatorSet.play(Animator)` call that created this `Builder` object ends.
`AnimatorSet.Builder`	`with(Animator anim)` Sets up the given animation to play at the same time as the animation supplied in the `AnimatorSet.play(Animator)` call that created this `Builder` object.

Inherited methods

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 methods

after

Added in API level 11

public AnimatorSet.Builder after (long delay)

Sets up the animation supplied in the AnimatorSet.play(Animator) call that created this Builder object to play when the given amount of time elapses.

Parameters
`delay`	`long`: The number of milliseconds that should elapse before the animation starts.

Returns
`AnimatorSet.Builder`

after

Added in API level 11

public AnimatorSet.Builder after (Animator anim)

Sets up the given animation to play when the animation supplied in the AnimatorSet.play(Animator) call that created this Builder object to start when the animation supplied in this method call ends.

Parameters
`anim`	`Animator`: The animation whose end will cause the animation supplied to the `AnimatorSet.play(Animator)` method to play.

Returns
`AnimatorSet.Builder`

before

Added in API level 11

public AnimatorSet.Builder before (Animator anim)

Sets up the given animation to play when the animation supplied in the AnimatorSet.play(Animator) call that created this Builder object ends.

Parameters
`anim`	`Animator`: The animation that will play when the animation supplied to the `AnimatorSet.play(Animator)` method ends.

Returns
`AnimatorSet.Builder`

with

Added in API level 11

public AnimatorSet.Builder with (Animator anim)

Sets up the given animation to play at the same time as the animation supplied in the AnimatorSet.play(Animator) call that created this Builder object.

Parameters
`anim`	`Animator`: The animation that will play when the animation supplied to the `AnimatorSet.play(Animator)` method starts.

Returns
`AnimatorSet.Builder`