public class ViewPropertyAnimator extends Object
ObjectAnimator
is fine; the property setters called by ObjectAnimator
are well equipped to do the right thing to set the property and invalidate the view
appropriately. But if several properties are animated simultaneously, or if you just want a
more convenient syntax to animate a specific property, then ViewPropertyAnimator might be
more well-suited to the task.
This class may provide better performance for several simultaneous animations, because it will optimize invalidate calls to take place only once for several properties instead of each animated property independently causing its own invalidation. Also, the syntax of using this class could be easier to use because the caller need only tell the View object which property to animate, and the value to animate either to or by, and this class handles the details of configuring the underlying Animator class and starting it.
This class is not constructed by the caller, but rather by the View whose properties
it will animate. Calls to View.animate()
will return a reference
to the appropriate ViewPropertyAnimator object for that View.
Modifier and Type | Method and Description |
---|---|
ViewPropertyAnimator |
alpha(float value)
This method will cause the View's
alpha property to be animated to the
specified value. |
ViewPropertyAnimator |
alphaBy(float value)
This method will cause the View's
alpha property to be animated by the
specified value. |
void |
cancel()
Cancels all property animations that are currently running or pending.
|
long |
getDuration()
Returns the current duration of property animations.
|
long |
getStartDelay()
Returns the current startDelay of property animations.
|
ViewPropertyAnimator |
rotation(float value)
This method will cause the View's
rotation property to be animated to the
specified value. |
ViewPropertyAnimator |
rotationBy(float value)
This method will cause the View's
rotation property to be animated by the
specified value. |
ViewPropertyAnimator |
rotationX(float value)
This method will cause the View's
rotationX property to be animated to the
specified value. |
ViewPropertyAnimator |
rotationXBy(float value)
This method will cause the View's
rotationX property to be animated by the
specified value. |
ViewPropertyAnimator |
rotationY(float value)
This method will cause the View's
rotationY property to be animated to the
specified value. |
ViewPropertyAnimator |
rotationYBy(float value)
This method will cause the View's
rotationY property to be animated by the
specified value. |
ViewPropertyAnimator |
scaleX(float value)
This method will cause the View's
scaleX property to be animated to the
specified value. |
ViewPropertyAnimator |
scaleXBy(float value)
This method will cause the View's
scaleX property to be animated by the
specified value. |
ViewPropertyAnimator |
scaleY(float value)
This method will cause the View's
scaleY property to be animated to the
specified value. |
ViewPropertyAnimator |
scaleYBy(float value)
This method will cause the View's
scaleY property to be animated by the
specified value. |
ViewPropertyAnimator |
setDuration(long duration)
Sets the duration for the underlying animator that animates the requested properties.
|
ViewPropertyAnimator |
setInterpolator(TimeInterpolator interpolator)
Sets the interpolator for the underlying animator that animates the requested properties.
|
ViewPropertyAnimator |
setListener(Animator.AnimatorListener listener)
Sets a listener for events in the underlying Animators that run the property
animations.
|
ViewPropertyAnimator |
setStartDelay(long startDelay)
Sets the startDelay for the underlying animator that animates the requested properties.
|
void |
start()
Starts the currently pending property animations immediately.
|
ViewPropertyAnimator |
translationX(float value)
This method will cause the View's
translationX property to be animated to the
specified value. |
ViewPropertyAnimator |
translationXBy(float value)
This method will cause the View's
translationX property to be animated by the
specified value. |
ViewPropertyAnimator |
translationY(float value)
This method will cause the View's
translationY property to be animated to the
specified value. |
ViewPropertyAnimator |
translationYBy(float value)
This method will cause the View's
translationY property to be animated by the
specified value. |
ViewPropertyAnimator |
withEndAction(Runnable runnable)
Specifies an action to take place when the next animation ends.
|
ViewPropertyAnimator |
withLayer()
The View associated with this ViewPropertyAnimator will have its
layer type set to
View.LAYER_TYPE_HARDWARE for the duration of the next animation. |
ViewPropertyAnimator |
withStartAction(Runnable runnable)
Specifies an action to take place when the next animation runs.
|
ViewPropertyAnimator |
x(float value)
This method will cause the View's
x property to be animated to the
specified value. |
ViewPropertyAnimator |
xBy(float value)
This method will cause the View's
x property to be animated by the
specified value. |
ViewPropertyAnimator |
y(float value)
This method will cause the View's
y property to be animated to the
specified value. |
ViewPropertyAnimator |
yBy(float value)
This method will cause the View's
y property to be animated by the
specified value. |
public ViewPropertyAnimator setDuration(long duration)
duration
- The length of ensuing property animations, in milliseconds. The value
cannot be negative.public long getDuration()
setDuration(long)
public long getStartDelay()
setStartDelay(long)
public ViewPropertyAnimator setStartDelay(long startDelay)
startDelay
- The delay of ensuing property animations, in milliseconds. The value
cannot be negative.public ViewPropertyAnimator setInterpolator(TimeInterpolator interpolator)
interpolator
- The TimeInterpolator to be used for ensuing property animations.public ViewPropertyAnimator setListener(Animator.AnimatorListener listener)
listener
- The listener to be called with AnimatorListener events.public void start()
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 void cancel()
public ViewPropertyAnimator x(float value)
x
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setX(float)
public ViewPropertyAnimator xBy(float value)
x
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setX(float)
public ViewPropertyAnimator y(float value)
y
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setY(float)
public ViewPropertyAnimator yBy(float value)
y
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setY(float)
public ViewPropertyAnimator rotation(float value)
rotation
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setRotation(float)
public ViewPropertyAnimator rotationBy(float value)
rotation
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setRotation(float)
public ViewPropertyAnimator rotationX(float value)
rotationX
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setRotationX(float)
public ViewPropertyAnimator rotationXBy(float value)
rotationX
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setRotationX(float)
public ViewPropertyAnimator rotationY(float value)
rotationY
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setRotationY(float)
public ViewPropertyAnimator rotationYBy(float value)
rotationY
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setRotationY(float)
public ViewPropertyAnimator translationX(float value)
translationX
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setTranslationX(float)
public ViewPropertyAnimator translationXBy(float value)
translationX
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setTranslationX(float)
public ViewPropertyAnimator translationY(float value)
translationY
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setTranslationY(float)
public ViewPropertyAnimator translationYBy(float value)
translationY
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setTranslationY(float)
public ViewPropertyAnimator scaleX(float value)
scaleX
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setScaleX(float)
public ViewPropertyAnimator scaleXBy(float value)
scaleX
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setScaleX(float)
public ViewPropertyAnimator scaleY(float value)
scaleY
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setScaleY(float)
public ViewPropertyAnimator scaleYBy(float value)
scaleY
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setScaleY(float)
public ViewPropertyAnimator alpha(float value)
alpha
property to be animated to the
specified value. Animations already running on the property will be canceled.value
- The value to be animated to.View.setAlpha(float)
public ViewPropertyAnimator alphaBy(float value)
alpha
property to be animated by the
specified value. Animations already running on the property will be canceled.value
- The amount to be animated by, as an offset from the current value.View.setAlpha(float)
public ViewPropertyAnimator withLayer()
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.
View.setLayerType(int, android.graphics.Paint)
public ViewPropertyAnimator withStartAction(Runnable runnable)
startDelay
set on this ViewPropertyAnimator, then the
action will run after that startDelay expires, when the actual animation begins.
This method, along with withEndAction(Runnable)
, is intended to help facilitate
choreographing ViewPropertyAnimator animations with other animations or actions
in the application.runnable
- The action to run when the next animation starts.public ViewPropertyAnimator withEndAction(Runnable runnable)
withStartAction(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).onEnd(endAction);
runnable
- The action to run when the next animation ends.