Animator

DURATION_INFINITE

static val DURATION_INFINITE: Long

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

Value: -1L

addListener

open fun addListener(listener: Animator.AnimatorListener!): Unit

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

open fun addPauseListener(listener: Animator.AnimatorPauseListener!): Unit

Adds a pause listener to this animator.

cancel

open fun cancel(): Unit

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

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

clone

open fun clone(): Animator

end

open fun end(): Unit

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

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

getDuration

abstract fun getDuration(): Long

Gets the duration of the animation.

getInterpolator

open fun getInterpolator(): TimeInterpolator!

Returns the timing interpolator that this animation uses.

getListeners

open fun getListeners(): ArrayList<Animator.AnimatorListener!>!

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

getStartDelay

abstract fun getStartDelay(): Long

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

getTotalDuration

open fun getTotalDuration(): Long

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

isPaused

open fun isPaused(): Boolean

Returns whether this animator is currently in a paused state.

isRunning

abstract fun isRunning(): Boolean

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

isStarted

open fun isStarted(): Boolean

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

open fun pause(): Unit

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

open fun removeAllListeners(): Unit

Removes all listeners and pauseListeners from this object.

removeListener

open fun removeListener(listener: Animator.AnimatorListener!): Unit

Removes a listener from the set listening to this animation.

removePauseListener

open fun removePauseListener(listener: Animator.AnimatorPauseListener!): Unit

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

resume

open fun resume(): Unit

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

abstract fun setDuration(duration: Long): Animator!

Sets the duration of the animation.

setInterpolator

abstract fun setInterpolator(value: TimeInterpolator!): Unit

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 android.view.animation.AccelerateDecelerateInterpolator.

setStartDelay

abstract fun setStartDelay(startDelay: Long): Unit

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

setTarget

open fun setTarget(target: Any?): Unit

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

open fun setupEndValues(): Unit

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

open fun setupStartValues(): Unit

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

open fun start(): Unit

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.