belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1
ViewPropertyAnimatorCompat
public
final
class
ViewPropertyAnimatorCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.view.ViewPropertyAnimatorCompat |
Summary
Public methods | |
---|---|
ViewPropertyAnimatorCompat
|
alpha(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
alphaBy(float value)
This method will cause the View's |
void
|
cancel()
Cancels all property animations that are currently running or pending. |
long
|
getDuration()
Returns the current duration of property animations. |
Interpolator
|
getInterpolator()
Returns the timing interpolator that this animation uses. |
long
|
getStartDelay()
Returns the current startDelay of property animations. |
ViewPropertyAnimatorCompat
|
rotation(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
rotationBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
rotationX(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
rotationXBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
rotationY(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
rotationYBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
scaleX(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
scaleXBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
scaleY(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
scaleYBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
setDuration(long value)
Sets the duration for the underlying animator that animates the requested properties. |
ViewPropertyAnimatorCompat
|
setInterpolator(Interpolator value)
Sets the interpolator for the underlying animator that animates the requested properties. |
ViewPropertyAnimatorCompat
|
setListener(ViewPropertyAnimatorListener listener)
Sets a listener for events in the underlying Animators that run the property animations. |
ViewPropertyAnimatorCompat
|
setStartDelay(long value)
Sets the startDelay for the underlying animator that animates the requested properties. |
ViewPropertyAnimatorCompat
|
setUpdateListener(ViewPropertyAnimatorUpdateListener listener)
Sets a listener for update events in the underlying Animator that runs the property animations. |
void
|
start()
Starts the currently pending property animations immediately. |
ViewPropertyAnimatorCompat
|
translationX(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
translationXBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
translationY(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
translationYBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
translationZ(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
translationZBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
withEndAction(Runnable runnable)
Specifies an action to take place when the next animation ends. |
ViewPropertyAnimatorCompat
|
withLayer()
The View associated with this ViewPropertyAnimator will have its
|
ViewPropertyAnimatorCompat
|
withStartAction(Runnable runnable)
Specifies an action to take place when the next animation runs. |
ViewPropertyAnimatorCompat
|
x(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
xBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
y(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
yBy(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
z(float value)
This method will cause the View's |
ViewPropertyAnimatorCompat
|
zBy(float value)
This method will cause the View's |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Public methods
alpha
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
alphaBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
cancel
void cancel ()
Cancels all property animations that are currently running or pending.
getDuration
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.
Returns | |
---|---|
long |
The duration of animations, in milliseconds. |
See also:
getInterpolator
Interpolator getInterpolator ()
Returns the timing interpolator that this animation uses.
Returns | |
---|---|
Interpolator |
The timing interpolator for this animation. |
getStartDelay
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.
Returns | |
---|---|
long |
The startDelay of animations, in milliseconds. |
See also:
rotation
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
rotationBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
rotationX
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
rotationXBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
rotationY
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
rotationYBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
scaleX
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
scaleXBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
scaleY
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
scaleYBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
setDuration
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.
Parameters | |
---|---|
value |
long : The length of ensuing property animations, in milliseconds. The value
cannot be negative. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
setInterpolator
ViewPropertyAnimatorCompat setInterpolator (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.
Parameters | |
---|---|
value |
Interpolator : The TimeInterpolator to be used for ensuing property animations. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
setListener
ViewPropertyAnimatorCompat setListener (ViewPropertyAnimatorListener listener)
Sets a listener for events in the underlying Animators that run the property animations.
Parameters | |
---|---|
listener |
ViewPropertyAnimatorListener : The listener to be called with AnimatorListener events. A value of
null removes any existing listener. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
setStartDelay
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.
Parameters | |
---|---|
value |
long : The delay of ensuing property animations, in milliseconds. The value
cannot be negative. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
setUpdateListener
ViewPropertyAnimatorCompat setUpdateListener (ViewPropertyAnimatorUpdateListener listener)
Sets a listener for update events in the underlying Animator that runs the property animations.
Prior to API 19, this method will do nothing.
Parameters | |
---|---|
listener |
ViewPropertyAnimatorUpdateListener : The listener to be called with update events. A value of
null removes any existing listener. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
start
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.
translationX
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
translationXBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
translationY
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
translationYBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
translationZ
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
translationZBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
withEndAction
ViewPropertyAnimatorCompat withEndAction (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(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);
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(View)
method.
Parameters | |
---|---|
runnable |
Runnable : The action to run when the next animation ends. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
withLayer
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(int, android.graphics.Paint)
) will result in some
inconsistency, including having the layer type restored to its pre-withLayer()
value when the animation ends.
For API 14 and 15, this method will run by setting
a listener on the ViewPropertyAnimatorCompat object, setting a hardware layer in
the listener's onAnimationStart(View)
method,
and then restoring the orignal layer type in the listener's
onAnimationEnd(View)
method.
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
withStartAction
ViewPropertyAnimatorCompat withStartAction (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(Runnable)
, is intended to help facilitate
choreographing ViewPropertyAnimator animations with other animations or actions
in the application.
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 onAnimationStart(View)
method.
Parameters | |
---|---|
runnable |
Runnable : The action to run when the next animation starts. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
x
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
xBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
y
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.
Parameters | |
---|---|
value |
float : The value to be animated to. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
yBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
z
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
zBy
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.
Parameters | |
---|---|
value |
float : The amount to be animated by, as an offset from the current value. |
Returns | |
---|---|
ViewPropertyAnimatorCompat |
This object, allowing calls to methods in this class to be chained. |
Annotations
Interfaces
- ActionProvider.VisibilityListener
- AsyncLayoutInflater.OnInflateFinishedListener
- LayoutInflaterFactory
- MenuItemCompat.OnActionExpandListener
- NestedScrollingChild
- NestedScrollingChild2
- NestedScrollingParent
- NestedScrollingParent2
- OnApplyWindowInsetsListener
- ScrollingView
- TintableBackgroundView
- ViewPager.OnAdapterChangeListener
- ViewPager.OnPageChangeListener
- ViewPager.PageTransformer
- ViewPropertyAnimatorListener
- ViewPropertyAnimatorUpdateListener
Classes
- AbsSavedState
- AccessibilityDelegateCompat
- ActionProvider
- AsyncLayoutInflater
- GestureDetectorCompat
- GravityCompat
- InputDeviceCompat
- LayoutInflaterCompat
- MarginLayoutParamsCompat
- MenuCompat
- MenuItemCompat
- MotionEventCompat
- NestedScrollingChildHelper
- NestedScrollingParentHelper
- PagerAdapter
- PagerTabStrip
- PagerTitleStrip
- PointerIconCompat
- ScaleGestureDetectorCompat
- VelocityTrackerCompat
- ViewCompat
- ViewConfigurationCompat
- ViewGroupCompat
- ViewPager
- ViewPager.LayoutParams
- ViewPager.SavedState
- ViewPager.SimpleOnPageChangeListener
- ViewParentCompat
- ViewPropertyAnimatorCompat
- ViewPropertyAnimatorListenerAdapter
- WindowCompat
- WindowInsetsCompat