ViewPropertyAnimatorCompat

public @NonNull ViewPropertyAnimatorCompat alpha(float value)

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.

public @NonNull ViewPropertyAnimatorCompat alphaBy(float value)

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.

public void cancel()

Cancels all property animations that are currently running or pending.

public long getDuration()

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.

public @Nullable Interpolator getInterpolator()

Returns the timing interpolator that this animation uses.

public long getStartDelay()

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.

public @NonNull ViewPropertyAnimatorCompat rotation(float value)

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.

public @NonNull ViewPropertyAnimatorCompat rotationBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat rotationX(float value)

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.

public @NonNull ViewPropertyAnimatorCompat rotationXBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat rotationY(float value)

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.

public @NonNull ViewPropertyAnimatorCompat rotationYBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat scaleX(float value)

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.

public @NonNull ViewPropertyAnimatorCompat scaleXBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat scaleY(float value)

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.

public @NonNull ViewPropertyAnimatorCompat scaleYBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat setDuration(long value)

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.

public @NonNull ViewPropertyAnimatorCompat setInterpolator(@Nullable Interpolator value)

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.

public @NonNull ViewPropertyAnimatorCompat setListener(@Nullable ViewPropertyAnimatorListener listener)

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

public @NonNull ViewPropertyAnimatorCompat setStartDelay(long value)

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.

public @NonNull ViewPropertyAnimatorCompat setUpdateListener(@Nullable ViewPropertyAnimatorUpdateListener listener)

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

public void start()

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.

public @NonNull ViewPropertyAnimatorCompat translationX(float value)

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.

public @NonNull ViewPropertyAnimatorCompat translationXBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat translationY(float value)

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.

public @NonNull ViewPropertyAnimatorCompat translationYBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat translationZ(float value)

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.

public @NonNull ViewPropertyAnimatorCompat translationZBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat withEndAction(@NonNull Runnable runnable)

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.

public @NonNull ViewPropertyAnimatorCompat withLayer()

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.

public @NonNull ViewPropertyAnimatorCompat withStartAction(@NonNull Runnable runnable)

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.

public @NonNull ViewPropertyAnimatorCompat x(float value)

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.

public @NonNull ViewPropertyAnimatorCompat xBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat y(float value)

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.

public @NonNull ViewPropertyAnimatorCompat yBy(float value)

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.

public @NonNull ViewPropertyAnimatorCompat z(float value)

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.

public @NonNull ViewPropertyAnimatorCompat zBy(float value)

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.