ViewPropertyAnimatorCompat

fun alpha(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's alpha property to be animated to the specified value. Animations already running on the property will be canceled.

fun alphaBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's alpha property to be animated by the specified value. Animations already running on the property will be canceled.

fun cancel(): Unit

Cancels all property animations that are currently running or pending.

fun getDuration(): Long

Returns the current duration of property animations. If the duration was set on this object, that value is returned. Otherwise, the default value of the underlying Animator is returned.

fun getInterpolator(): Interpolator?

Returns the timing interpolator that this animation uses.

fun getStartDelay(): Long

Returns the current startDelay of property animations. If the startDelay was set on this object, that value is returned. Otherwise, the default value of the underlying Animator is returned.

fun rotation(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's rotation property to be animated to the specified value. Animations already running on the property will be canceled.

fun rotationBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's rotation property to be animated by the specified value. Animations already running on the property will be canceled.

fun rotationX(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's rotationX property to be animated to the specified value. Animations already running on the property will be canceled.

fun rotationXBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's rotationX property to be animated by the specified value. Animations already running on the property will be canceled.

fun rotationY(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's rotationY property to be animated to the specified value. Animations already running on the property will be canceled.

fun rotationYBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's rotationY property to be animated by the specified value. Animations already running on the property will be canceled.

fun scaleX(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's scaleX property to be animated to the specified value. Animations already running on the property will be canceled.

fun scaleXBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's scaleX property to be animated by the specified value. Animations already running on the property will be canceled.

fun scaleY(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's scaleY property to be animated to the specified value. Animations already running on the property will be canceled.

fun scaleYBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's scaleY property to be animated by the specified value. Animations already running on the property will be canceled.

fun setDuration(value: Long): ViewPropertyAnimatorCompat

Sets the duration for the underlying animator that animates the requested properties. By default, the animator uses the default value for ValueAnimator. Calling this method will cause the declared value to be used instead.

fun setInterpolator(value: Interpolator?): ViewPropertyAnimatorCompat

Sets the interpolator for the underlying animator that animates the requested properties. By default, the animator uses the default interpolator for ValueAnimator. Calling this method will cause the declared object to be used instead.

fun setListener(listener: ViewPropertyAnimatorListener?): ViewPropertyAnimatorCompat

Sets a listener for events in the underlying Animators that run the property animations.

fun setStartDelay(value: Long): ViewPropertyAnimatorCompat

Sets the startDelay for the underlying animator that animates the requested properties. By default, the animator uses the default value for ValueAnimator. Calling this method will cause the declared value to be used instead.

fun setUpdateListener(listener: ViewPropertyAnimatorUpdateListener?): ViewPropertyAnimatorCompat

Sets a listener for update events in the underlying Animator that runs the property animations.

fun start(): Unit

Starts the currently pending property animations immediately. Calling start() is optional because all animations start automatically at the next opportunity. However, if the animations are needed to start immediately and synchronously (not at the time when the next event is processed by the hierarchy, which is when the animations would begin otherwise), then this method can be used.

fun translationX(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's translationX property to be animated to the specified value. Animations already running on the property will be canceled.

fun translationXBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's translationX property to be animated by the specified value. Animations already running on the property will be canceled.

fun translationY(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's translationY property to be animated to the specified value. Animations already running on the property will be canceled.

fun translationYBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's translationY property to be animated by the specified value. Animations already running on the property will be canceled.

fun translationZ(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's translationZ property to be animated to the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.

fun translationZBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's translationZ property to be animated by the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.

fun withEndAction(runnable: Runnable): ViewPropertyAnimatorCompat

Specifies an action to take place when the next animation ends. The action is only run if the animation ends normally; if the ViewPropertyAnimator is canceled during that animation, the runnable will not run. This method, along with withStartAction, is intended to help facilitate choreographing ViewPropertyAnimator animations with other animations or actions in the application.

For example, the following code animates a view to x=200 and then back to 0:

    Runnable endAction = new Runnable() {
        public void run() {
            view.animate().x(0);
        }
    };
    view.animate().x(200).withEndAction(endAction);

For API 14 and 15, this method will run by setting a listener on the ViewPropertyAnimatorCompat object and running the action in that listener's onAnimationEnd method.

fun withLayer(): ViewPropertyAnimatorCompat

The View associated with this ViewPropertyAnimator will have its layer type set to LAYER_TYPE_HARDWARE for the duration of the next animation. As stated in the documentation for LAYER_TYPE_HARDWARE, the actual type of layer used internally depends on the runtime situation of the view. If the activity and this view are hardware-accelerated, then the layer will be accelerated as well. If the activity or the view is not accelerated, then the layer will effectively be the same as LAYER_TYPE_SOFTWARE.

This state is not persistent, either on the View or on this ViewPropertyAnimator: the layer type of the View will be restored when the animation ends to what it was when this method was called, and this setting on ViewPropertyAnimator is only valid for the next animation. Note that calling this method and then independently setting the layer type of the View (by a direct call to setLayerType) will result in some inconsistency, including having the layer type restored to its pre-withLayer() value when the animation ends.

fun withStartAction(runnable: Runnable): ViewPropertyAnimatorCompat

Specifies an action to take place when the next animation runs. If there is a startDelay set on this ViewPropertyAnimator, then the action will run after that startDelay expires, when the actual animation begins. This method, along with withEndAction, is intended to help facilitate choreographing ViewPropertyAnimator animations with other animations or actions in the application.

fun x(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's x property to be animated to the specified value. Animations already running on the property will be canceled.

fun xBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's x property to be animated by the specified value. Animations already running on the property will be canceled.

fun y(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's y property to be animated to the specified value. Animations already running on the property will be canceled.

fun yBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's y property to be animated by the specified value. Animations already running on the property will be canceled.

fun z(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's z property to be animated to the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.

fun zBy(value: Float): ViewPropertyAnimatorCompat

This method will cause the View's z property to be animated by the specified value. Animations already running on the property will be canceled.

Prior to API 21, this method will do nothing.