ViewPropertyAnimator

alpha

open fun alpha(value: Float): ViewPropertyAnimator

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.

alphaBy

open fun alphaBy(value: Float): ViewPropertyAnimator

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.

cancel

open fun cancel(): Unit

Cancels all property animations that are currently running or pending.

getDuration

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

getInterpolator

open fun getInterpolator(): TimeInterpolator?

Returns the timing interpolator that this animation uses.

getStartDelay

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

rotation

open fun rotation(value: Float): ViewPropertyAnimator

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.

rotationBy

open fun rotationBy(value: Float): ViewPropertyAnimator

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.

rotationX

open fun rotationX(value: Float): ViewPropertyAnimator

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.

rotationXBy

open fun rotationXBy(value: Float): ViewPropertyAnimator

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.

rotationY

open fun rotationY(value: Float): ViewPropertyAnimator

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.

rotationYBy

open fun rotationYBy(value: Float): ViewPropertyAnimator

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.

scaleX

open fun scaleX(value: Float): ViewPropertyAnimator

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.

scaleXBy

open fun scaleXBy(value: Float): ViewPropertyAnimator

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.

scaleY

open fun scaleY(value: Float): ViewPropertyAnimator

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.

scaleYBy

open fun scaleYBy(value: Float): ViewPropertyAnimator

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.

setDuration

open fun setDuration(duration: Long): ViewPropertyAnimator

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.

setInterpolator

open fun setInterpolator(interpolator: TimeInterpolator!): ViewPropertyAnimator

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.

setListener

open fun setListener(listener: Animator.AnimatorListener?): ViewPropertyAnimator

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

setStartDelay

open fun setStartDelay(startDelay: Long): ViewPropertyAnimator

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.

setUpdateListener

open fun setUpdateListener(listener: ValueAnimator.AnimatorUpdateListener?): ViewPropertyAnimator

Sets a listener for update events in the underlying ValueAnimator that runs the property animations. Note that the underlying animator is animating between 0 and 1 (these values are then turned into the actual property values internally by ViewPropertyAnimator). So the animator cannot give information on the current values of the properties being animated by this ViewPropertyAnimator, although the view object itself can be queried to get the current values.

start

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

translationX

open fun translationX(value: Float): ViewPropertyAnimator

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.

translationXBy

open fun translationXBy(value: Float): ViewPropertyAnimator

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.

translationY

open fun translationY(value: Float): ViewPropertyAnimator

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.

translationYBy

open fun translationYBy(value: Float): ViewPropertyAnimator

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.

translationZ

open fun translationZ(value: Float): ViewPropertyAnimator

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.

translationZBy

open fun translationZBy(value: Float): ViewPropertyAnimator

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.

withEndAction

open fun withEndAction(runnable: Runnable!): ViewPropertyAnimator

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(java.lang.Runnable), 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);
  

withLayer

open fun withLayer(): ViewPropertyAnimator

The View associated with this ViewPropertyAnimator will have its layer type set to View#LAYER_TYPE_HARDWARE for the duration of the next animation. As stated in the documentation for View#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 View#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 View#setLayerType(int, android.graphics.Paint)) will result in some inconsistency, including having the layer type restored to its pre-withLayer() value when the animation ends.

withStartAction

open fun withStartAction(runnable: Runnable!): ViewPropertyAnimator

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(java.lang.Runnable), is intended to help facilitate choreographing ViewPropertyAnimator animations with other animations or actions in the application.

x

open fun x(value: Float): ViewPropertyAnimator

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.

xBy

open fun xBy(value: Float): ViewPropertyAnimator

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.

y

open fun y(value: Float): ViewPropertyAnimator

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.

yBy

open fun yBy(value: Float): ViewPropertyAnimator

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.

z

open fun z(value: Float): ViewPropertyAnimator

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.

zBy

open fun zBy(value: Float): ViewPropertyAnimator

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.