Animator

DURATION_INFINITE

public static final long DURATION_INFINITE

The value used to indicate infinite duration (e.g. when Animators repeat infinitely).

Constant Value: -1 (0xffffffffffffffff)

Animator

public Animator ()

addListener

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

addPauseListener

public void addPauseListener (Animator.AnimatorPauseListener listener)

Adds a pause listener to this animator.

cancel

public void cancel ()

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

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

clone

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

end

public void end ()

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

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

getDuration

public abstract long getDuration ()

Gets the duration of the animation.

getInterpolator

public TimeInterpolator getInterpolator ()

Returns the timing interpolator that this animation uses.

getListeners

public ArrayList<Animator.AnimatorListener> getListeners ()

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

getStartDelay

public abstract long getStartDelay ()

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

getTotalDuration

public long getTotalDuration ()

Gets the total duration of the animation, accounting for animation sequences, start delay, and repeating. Return DURATION_INFINITE if the duration is infinite.

isPaused

public boolean isPaused ()

Returns whether this animator is currently in a paused state.

isRunning

public abstract boolean isRunning ()

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

isStarted

public boolean isStarted ()

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.

pause

public void pause ()

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

removeAllListeners

public void removeAllListeners ()

Removes all listeners and pauseListeners from this object.

removeListener

public void removeListener (Animator.AnimatorListener listener)

Removes a listener from the set listening to this animation.

removePauseListener

public void removePauseListener (Animator.AnimatorPauseListener listener)

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

resume

public void resume ()

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.

setDuration

public abstract Animator setDuration (long duration)

Sets the duration of the animation.

setInterpolator

public abstract void setInterpolator (TimeInterpolator value)

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.

setStartDelay

public abstract void setStartDelay (long startDelay)

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

setTarget

public void setTarget (Object target)

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.

Note: The target is stored as a weak reference internally to avoid leaking resources by having animators directly reference old targets. Therefore, you should ensure that animator targets always have a hard reference elsewhere.

setupEndValues

public void setupEndValues ()

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.

setupStartValues

public void setupStartValues ()

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.

start

public void start ()

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 AnimatorListener#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.