Android APIs
public abstract class

Animator

extends Object
implements Cloneable
java.lang.Object
   ↳ android.animation.Animator
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This is the superclass for classes which provide basic support for animations which can be started, ended, and have AnimatorListeners added to them.

Summary

Nested Classes
interface Animator.AnimatorListener

An animation listener receives notifications from an animation. 

interface Animator.AnimatorPauseListener A pause listener receives notifications from an animation when the animation is paused or resumed
Public Constructors
Animator()
Public Methods
void addListener(Animator.AnimatorListener listener)
Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.
void addPauseListener(Animator.AnimatorPauseListener listener)
Adds a pause listener to this animator.
void cancel()
Cancels the animation.
Animator clone()
Creates and returns a copy of this Object.
void end()
Ends the animation.
abstract long getDuration()
Gets the duration of the animation.
TimeInterpolator getInterpolator()
Returns the timing interpolator that this animation uses.
ArrayList<Animator.AnimatorListener> getListeners()
Gets the set of Animator.AnimatorListener objects that are currently listening for events on this Animator object.
abstract long getStartDelay()
The amount of time, in milliseconds, to delay processing the animation after start() is called.
boolean isPaused()
Returns whether this animator is currently in a paused state.
abstract boolean isRunning()
Returns whether this Animator is currently running (having been started and gone past any initial startDelay period and not yet ended).
boolean isStarted()
Returns whether this Animator has been started and not yet ended.
void pause()
Pauses a running animation.
void removeAllListeners()
Removes all listeners and pauseListeners from this object.
void removeListener(Animator.AnimatorListener listener)
Removes a listener from the set listening to this animation.
void removePauseListener(Animator.AnimatorPauseListener listener)
Removes a pause listener from the set listening to this animation.
void resume()
Resumes a paused animation, causing the animator to pick up where it left off when it was paused.
abstract Animator setDuration(long duration)
Sets the duration of the animation.
abstract void setInterpolator(TimeInterpolator value)
The time interpolator used in calculating the elapsed fraction of the animation.
abstract void setStartDelay(long startDelay)
The amount of time, in milliseconds, to delay processing the animation after start() is called.
void setTarget(Object target)
Sets the target object whose property will be animated by this animation.
void setupEndValues()
This method tells the object to use appropriate information to extract ending values for the animation.
void setupStartValues()
This method tells the object to use appropriate information to extract starting values for the animation.
void start()
Starts this animation.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Animator ()

Added in API level 11

Public Methods

public void addListener (Animator.AnimatorListener listener)

Added in API level 11

Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.

Parameters
listener Animator.AnimatorListener: the listener to be added to the current set of listeners for this animation.

public void addPauseListener (Animator.AnimatorPauseListener listener)

Added in API level 19

Adds a pause listener to this animator.

Parameters
listener Animator.AnimatorPauseListener: the listener to be added to the current set of pause listeners for this animation.

public void cancel ()

Added in API level 11

Cancels the animation. Unlike end(), cancel() causes the animation to stop in its tracks, sending an onAnimationCancel(Animator) to its listeners, followed by an onAnimationEnd(Animator) message.

This method must be called on the thread that is running the animation.

public Animator clone ()

Added in API level 11

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns
Animator a copy of this object.

public void end ()

Added in API level 11

Ends the animation. This causes the animation to assign the end value of the property being animated, then calling the onAnimationEnd(Animator) method on its listeners.

This method must be called on the thread that is running the animation.

public abstract long getDuration ()

Added in API level 11

Gets the duration of the animation.

Returns
long The length of the animation, in milliseconds.

public TimeInterpolator getInterpolator ()

Added in API level 18

Returns the timing interpolator that this animation uses.

Returns
TimeInterpolator The timing interpolator for this animation.

public ArrayList<Animator.AnimatorListener> getListeners ()

Added in API level 11

Gets the set of Animator.AnimatorListener objects that are currently listening for events on this Animator object.

Returns
ArrayList<Animator.AnimatorListener> ArrayList The set of listeners.

public abstract long getStartDelay ()

Added in API level 11

The amount of time, in milliseconds, to delay processing the animation after start() is called.

Returns
long the number of milliseconds to delay running the animation

public boolean isPaused ()

Added in API level 19

Returns whether this animator is currently in a paused state.

Returns
boolean True if the animator is currently paused, false otherwise.

See also:

public abstract boolean isRunning ()

Added in API level 11

Returns whether this Animator is currently running (having been started and gone past any initial startDelay period and not yet ended).

Returns
boolean Whether the Animator is running.

public boolean isStarted ()

Added in API level 14

Returns whether this Animator has been started and not yet ended. For reusable Animators (which most Animators are, apart from the one-shot animator produced by createCircularReveal()), this state is a superset of isRunning(), because an Animator with a nonzero startDelay will return true for isStarted() during the delay phase, whereas isRunning() will return true only after the delay phase is complete. Non-reusable animators will always return true after they have been started, because they cannot return to a non-started state.

Returns
boolean Whether the Animator has been started and not yet ended.

public void pause ()

Added in API level 19

Pauses a running animation. This method should only be called on the same thread on which the animation was started. If the animation has not yet been started or has since ended, then the call is ignored. Paused animations can be resumed by calling resume().

public void removeAllListeners ()

Added in API level 11

Removes all listeners and pauseListeners from this object.

public void removeListener (Animator.AnimatorListener listener)

Added in API level 11

Removes a listener from the set listening to this animation.

Parameters
listener Animator.AnimatorListener: the listener to be removed from the current set of listeners for this animation.

public void removePauseListener (Animator.AnimatorPauseListener listener)

Added in API level 19

Removes a pause listener from the set listening to this animation.

Parameters
listener Animator.AnimatorPauseListener: the listener to be removed from the current set of pause listeners for this animation.

public void resume ()

Added in API level 19

Resumes a paused animation, causing the animator to pick up where it left off when it was paused. This method should only be called on the same thread on which the animation was started. Calls to resume() on an animator that is not currently paused will be ignored.

public abstract Animator setDuration (long duration)

Added in API level 11

Sets the duration of the animation.

Parameters
duration long: The length of the animation, in milliseconds.
Returns
Animator

public abstract void setInterpolator (TimeInterpolator value)

Added in API level 11

The time interpolator used in calculating the elapsed fraction of the animation. The interpolator determines whether the animation runs with linear or non-linear motion, such as acceleration and deceleration. The default value is AccelerateDecelerateInterpolator.

Parameters
value TimeInterpolator: the interpolator to be used by this animation

public abstract void setStartDelay (long startDelay)

Added in API level 11

The amount of time, in milliseconds, to delay processing the animation after start() is called.

Parameters
startDelay long: The amount of the delay, in milliseconds

public void setTarget (Object target)

Added in API level 11

Sets the target object whose property will be animated by this animation. Not all subclasses operate on target objects (for example, ValueAnimator, but this method is on the superclass for the convenience of dealing generically with those subclasses that do handle targets.

Parameters
target Object: The object being animated

public void setupEndValues ()

Added in API level 11

This method tells the object to use appropriate information to extract ending values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.

public void setupStartValues ()

Added in API level 11

This method tells the object to use appropriate information to extract starting values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.

public void start ()

Added in API level 11

Starts this animation. If the animation has a nonzero startDelay, the animation will start running after that delay elapses. A non-delayed animation will have its initial value(s) set immediately, followed by calls to onAnimationStart(Animator) for any listeners of this animator.

The animation started by calling this method will be run on the thread that called this method. This thread should have a Looper on it (a runtime exception will be thrown if this is not the case). Also, if the animation will animate properties of objects in the view hierarchy, then the calling thread should be the UI thread for that view hierarchy.