Skip to content

Most visited

Recently visited

navigation

ObjectAnimator

public final class ObjectAnimator
extends ValueAnimator

java.lang.Object
   ↳ android.animation.Animator
     ↳ android.animation.ValueAnimator
       ↳ android.animation.ObjectAnimator


This subclass of ValueAnimator provides support for animating properties on target objects. The constructors of this class take parameters to define the target object that will be animated as well as the name of the property that will be animated. Appropriate set/get functions are then determined internally and the animation will call these functions as necessary to animate the property.

Animators can be created from either code or resource files, as shown here:

<objectAnimator xmlns:android="http://schemas.android.com/apk/res/android"
    android:duration="1000"
    android:valueTo="200"
    android:valueType="floatType"
    android:propertyName="y"
    android:repeatCount="1"
    android:repeatMode="reverse"/>

When using resource files, it is possible to use PropertyValuesHolder and Keyframe to create more complex animations. Using PropertyValuesHolders allows animators to animate several properties in parallel, as shown in this sample:

<objectAnimator xmlns:android="http://schemas.android.com/apk/res/android"
                android:duration="1000"
                android:repeatCount="1"
                android:repeatMode="reverse">
    <propertyValuesHolder android:propertyName="x" android:valueTo="400"/>
    <propertyValuesHolder android:propertyName="y" android:valueTo="200"/>
</objectAnimator>

Using Keyframes allows animations to follow more complex paths from the start to the end values. Note that you can specify explicit fractional values (from 0 to 1) for each keyframe to determine when, in the overall duration, the animation should arrive at that value. Alternatively, you can leave the fractions off and the keyframes will be equally distributed within the total duration. Also, a keyframe with no value will derive its value from the target object when the animator starts, just like animators with only one value specified. In addition, an optional interpolator can be specified. The interpolator will be applied on the interval between the keyframe that the interpolator is set on and the previous keyframe. When no interpolator is supplied, the default AccelerateDecelerateInterpolator will be used.

<propertyValuesHolder android:propertyName="x" >
    <keyframe android:fraction="0" android:value="800" />
    <keyframe android:fraction=".2"
              android:interpolator="@android:anim/accelerate_interpolator"
              android:value="1000" />
    <keyframe android:fraction="1"
              android:interpolator="@android:anim/accelerate_interpolator"
              android:value="400" />
</propertyValuesHolder>
<propertyValuesHolder android:propertyName="y" >
    <keyframe/>
    <keyframe android:fraction=".2"
              android:interpolator="@android:anim/accelerate_interpolator"
              android:value="300"/>
    <keyframe android:interpolator="@android:anim/accelerate_interpolator"
              android:value="1000" />
</propertyValuesHolder>

Developer Guides

For more information about animating with ObjectAnimator, read the Property Animation developer guide.

See also:

Summary

Inherited constants

From class android.animation.ValueAnimator
From class android.animation.Animator

Public constructors

ObjectAnimator()

Creates a new ObjectAnimator object.

Public methods

ObjectAnimator clone()

Creates and returns a copy of this object.

String getPropertyName()

Gets the name of the property that will be animated.

Object getTarget()

The target object whose property will be animated by this animation

static ObjectAnimator ofArgb(Object target, String propertyName, int... values)

Constructs and returns an ObjectAnimator that animates between color values.

static <T> ObjectAnimator ofArgb(T target, Property<T, Integer> property, int... values)

Constructs and returns an ObjectAnimator that animates between color values.

static ObjectAnimator ofFloat(Object target, String xPropertyName, String yPropertyName, Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties.

static <T> ObjectAnimator ofFloat(T target, Property<T, Float> property, float... values)

Constructs and returns an ObjectAnimator that animates between float values.

static <T> ObjectAnimator ofFloat(T target, Property<T, Float> xProperty, Property<T, Float> yProperty, Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties.

static ObjectAnimator ofFloat(Object target, String propertyName, float... values)

Constructs and returns an ObjectAnimator that animates between float values.

static <T> ObjectAnimator ofInt(T target, Property<T, Integer> xProperty, Property<T, Integer> yProperty, Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties.

static <T> ObjectAnimator ofInt(T target, Property<T, Integer> property, int... values)

Constructs and returns an ObjectAnimator that animates between int values.

static ObjectAnimator ofInt(Object target, String propertyName, int... values)

Constructs and returns an ObjectAnimator that animates between int values.

static ObjectAnimator ofInt(Object target, String xPropertyName, String yPropertyName, Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties.

static ObjectAnimator ofMultiFloat(Object target, String propertyName, float[][] values)

Constructs and returns an ObjectAnimator that animates over float values for a multiple parameters setter.

static ObjectAnimator ofMultiFloat(Object target, String propertyName, Path path)

Constructs and returns an ObjectAnimator that animates the target using a multi-float setter along the given Path.

static <T> ObjectAnimator ofMultiFloat(Object target, String propertyName, TypeConverter<T, float[]> converter, TypeEvaluator<T> evaluator, T... values)

Constructs and returns an ObjectAnimator that animates over values for a multiple float parameters setter.

static ObjectAnimator ofMultiInt(Object target, String propertyName, int[][] values)

Constructs and returns an ObjectAnimator that animates over int values for a multiple parameters setter.

static ObjectAnimator ofMultiInt(Object target, String propertyName, Path path)

Constructs and returns an ObjectAnimator that animates the target using a multi-int setter along the given Path.

static <T> ObjectAnimator ofMultiInt(Object target, String propertyName, TypeConverter<T, int[]> converter, TypeEvaluator<T> evaluator, T... values)

Constructs and returns an ObjectAnimator that animates over values for a multiple int parameters setter.

static <T, V> ObjectAnimator ofObject(T target, Property<T, V> property, TypeEvaluator<V> evaluator, V... values)

Constructs and returns an ObjectAnimator that animates between Object values.

static ObjectAnimator ofObject(Object target, String propertyName, TypeConverter<PointF, ?> converter, Path path)

Constructs and returns an ObjectAnimator that animates a property along a Path.

static <T, V> ObjectAnimator ofObject(T target, Property<T, V> property, TypeConverter<PointF, V> converter, Path path)

Constructs and returns an ObjectAnimator that animates a property along a Path.

static <T, V, P> ObjectAnimator ofObject(T target, Property<T, P> property, TypeConverter<V, P> converter, TypeEvaluator<V> evaluator, V... values)

Constructs and returns an ObjectAnimator that animates between Object values.

static ObjectAnimator ofObject(Object target, String propertyName, TypeEvaluator evaluator, Object... values)

Constructs and returns an ObjectAnimator that animates between Object values.

static ObjectAnimator ofPropertyValuesHolder(Object target, PropertyValuesHolder... values)

Constructs and returns an ObjectAnimator that animates between the sets of values specified in PropertyValueHolder objects.

void setAutoCancel(boolean cancel)

autoCancel controls whether an ObjectAnimator will be canceled automatically when any other ObjectAnimator with the same target and properties is started.

ObjectAnimator setDuration(long duration)

Sets the length of the animation.

void setFloatValues(float... values)

Sets float values that will be animated between.

void setIntValues(int... values)

Sets int values that will be animated between.

void setObjectValues(Object... values)

Sets the values to animate between for this animation.

void setProperty(Property property)

Sets the property that will be animated.

void setPropertyName(String propertyName)

Sets the name of the property that will be animated.

void setTarget(Object target)

Sets the target object whose property will be animated by this animation.

void setupEndValues()

This method tells the object to use appropriate information to extract ending values for the animation.

void setupStartValues()

This method tells the object to use appropriate information to extract starting values for the animation.

void start()

Starts this animation.

String toString()

Returns a string representation of the object.

Inherited methods

From class android.animation.ValueAnimator
From class android.animation.Animator
From class java.lang.Object

Public constructors

ObjectAnimator

Added in API level 11
ObjectAnimator ()

Creates a new ObjectAnimator object. This default constructor is primarily for use internally; the other constructors which take parameters are more generally useful.

Public methods

clone

Added in API level 11
ObjectAnimator clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x
will be true, and that the expression:
 x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
 x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Returns
ObjectAnimator a clone of this instance.

getPropertyName

Added in API level 11
String getPropertyName ()

Gets the name of the property that will be animated. This name will be used to derive a setter function that will be called to set animated values. For example, a property name of foo will result in a call to the function setFoo() on the target object. If either valueFrom or valueTo is null, then a getter function will also be derived and called.

If this animator was created with a Property object instead of the string name of a property, then this method will return the name of that Property object instead. If this animator was created with one or more PropertyValuesHolder objects, then this method will return the name of that object (if there was just one) or a comma-separated list of all of the names (if there are more than one).

Returns
String

getTarget

Added in API level 11
Object getTarget ()

The target object whose property will be animated by this animation

Returns
Object The object being animated

ofArgb

Added in API level 21
ObjectAnimator ofArgb (Object target, 
                String propertyName, 
                int... values)

Constructs and returns an ObjectAnimator that animates between color values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target Object: The object whose property is to be animated. This object should have a public method on it called setName(), where name is the value of the propertyName parameter.
propertyName String: The name of the property being animated.
values int: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofArgb

Added in API level 21
ObjectAnimator ofArgb (T target, 
                Property<T, Integer> property, 
                int... values)

Constructs and returns an ObjectAnimator that animates between color values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target T: The object whose property is to be animated.
property Property: The property being animated.
values int: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofFloat

Added in API level 21
ObjectAnimator ofFloat (Object target, 
                String xPropertyName, 
                String yPropertyName, 
                Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are floats that are set to separate properties designated by xPropertyName and yPropertyName.

Parameters
target Object: The object whose properties are to be animated. This object should have public methods on it called setNameX() and setNameY, where nameX and nameY are the value of the xPropertyName and yPropertyName parameters, respectively.
xPropertyName String: The name of the property for the x coordinate being animated.
yPropertyName String: The name of the property for the y coordinate being animated.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofFloat

Added in API level 14
ObjectAnimator ofFloat (T target, 
                Property<T, Float> property, 
                float... values)

Constructs and returns an ObjectAnimator that animates between float values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target T: The object whose property is to be animated.
property Property: The property being animated.
values float: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofFloat

Added in API level 21
ObjectAnimator ofFloat (T target, 
                Property<T, Float> xProperty, 
                Property<T, Float> yProperty, 
                Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are floats that are set to separate properties, xProperty and yProperty.

Parameters
target T: The object whose properties are to be animated.
xProperty Property: The property for the x coordinate being animated.
yProperty Property: The property for the y coordinate being animated.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofFloat

Added in API level 11
ObjectAnimator ofFloat (Object target, 
                String propertyName, 
                float... values)

Constructs and returns an ObjectAnimator that animates between float values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target Object: The object whose property is to be animated. This object should have a public method on it called setName(), where name is the value of the propertyName parameter.
propertyName String: The name of the property being animated.
values float: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofInt

Added in API level 21
ObjectAnimator ofInt (T target, 
                Property<T, Integer> xProperty, 
                Property<T, Integer> yProperty, 
                Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are integers that are set to separate properties, xProperty and yProperty.

Parameters
target T: The object whose properties are to be animated.
xProperty Property: The property for the x coordinate being animated.
yProperty Property: The property for the y coordinate being animated.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofInt

Added in API level 14
ObjectAnimator ofInt (T target, 
                Property<T, Integer> property, 
                int... values)

Constructs and returns an ObjectAnimator that animates between int values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target T: The object whose property is to be animated.
property Property: The property being animated.
values int: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofInt

Added in API level 11
ObjectAnimator ofInt (Object target, 
                String propertyName, 
                int... values)

Constructs and returns an ObjectAnimator that animates between int values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target Object: The object whose property is to be animated. This object should have a public method on it called setName(), where name is the value of the propertyName parameter.
propertyName String: The name of the property being animated.
values int: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofInt

Added in API level 21
ObjectAnimator ofInt (Object target, 
                String xPropertyName, 
                String yPropertyName, 
                Path path)

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are integers that are set to separate properties designated by xPropertyName and yPropertyName.

Parameters
target Object: The object whose properties are to be animated. This object should have public methods on it called setNameX() and setNameY, where nameX and nameY are the value of xPropertyName and yPropertyName parameters, respectively.
xPropertyName String: The name of the property for the x coordinate being animated.
yPropertyName String: The name of the property for the y coordinate being animated.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofMultiFloat

Added in API level 21
ObjectAnimator ofMultiFloat (Object target, 
                String propertyName, 
                float[][] values)

Constructs and returns an ObjectAnimator that animates over float values for a multiple parameters setter. Only public methods that take only float parameters are supported. Each float[] contains a complete set of parameters to the setter method. At least two float[] values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target Object: The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.
propertyName String: The name of the property being animated or the name of the setter method.
values float: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofMultiFloat

Added in API level 21
ObjectAnimator ofMultiFloat (Object target, 
                String propertyName, 
                Path path)

Constructs and returns an ObjectAnimator that animates the target using a multi-float setter along the given Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are float x and y coordinates used in the first and second parameter of the setter, respectively.

Parameters
target Object: The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.
propertyName String: The name of the property being animated or the name of the setter method.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofMultiFloat

Added in API level 21
ObjectAnimator ofMultiFloat (Object target, 
                String propertyName, 
                TypeConverter<T, float[]> converter, 
                TypeEvaluator<T> evaluator, 
                T... values)

Constructs and returns an ObjectAnimator that animates over values for a multiple float parameters setter. Only public methods that take only float parameters are supported.

At least two values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target Object: The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.
propertyName String: The name of the property being animated or the name of the setter method.
converter TypeConverter: Converts T objects into float parameters for the multi-value setter.
evaluator TypeEvaluator: A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.
values T: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofMultiInt

Added in API level 21
ObjectAnimator ofMultiInt (Object target, 
                String propertyName, 
                int[][] values)

Constructs and returns an ObjectAnimator that animates over int values for a multiple parameters setter. Only public methods that take only int parameters are supported. Each int[] contains a complete set of parameters to the setter method. At least two int[] values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target Object: The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.
propertyName String: The name of the property being animated or the name of the setter method.
values int: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofMultiInt

Added in API level 21
ObjectAnimator ofMultiInt (Object target, 
                String propertyName, 
                Path path)

Constructs and returns an ObjectAnimator that animates the target using a multi-int setter along the given Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are integer x and y coordinates used in the first and second parameter of the setter, respectively.

Parameters
target Object: The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.
propertyName String: The name of the property being animated or the name of the setter method.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofMultiInt

Added in API level 21
ObjectAnimator ofMultiInt (Object target, 
                String propertyName, 
                TypeConverter<T, int[]> converter, 
                TypeEvaluator<T> evaluator, 
                T... values)

Constructs and returns an ObjectAnimator that animates over values for a multiple int parameters setter. Only public methods that take only int parameters are supported.

At least two values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target Object: The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.
propertyName String: The name of the property being animated or the name of the setter method.
converter TypeConverter: Converts T objects into int parameters for the multi-value setter.
evaluator TypeEvaluator: A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.
values T: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofObject

Added in API level 14
ObjectAnimator ofObject (T target, 
                Property<T, V> property, 
                TypeEvaluator<V> evaluator, 
                V... values)

Constructs and returns an ObjectAnimator that animates between Object values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Note: The values are stored as references to the original objects, which means that changes to those objects after this method is called will affect the values on the animator. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

Parameters
target T: The object whose property is to be animated.
property Property: The property being animated.
evaluator TypeEvaluator: A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.
values V: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofObject

Added in API level 21
ObjectAnimator ofObject (Object target, 
                String propertyName, 
                TypeConverter<PointF, ?> converter, 
                Path path)

Constructs and returns an ObjectAnimator that animates a property along a Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. This variant animates the coordinates in a PointF to follow the Path. If the Property associated with propertyName uses a type other than PointF, converter can be used to change from PointF to the type associated with the Property.

Parameters
target Object: The object whose property is to be animated. This object should have a public method on it called setName(), where name is the value of the propertyName parameter.
propertyName String: The name of the property being animated.
converter TypeConverter: Converts a PointF to the type associated with the setter. May be null if conversion is unnecessary.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofObject

Added in API level 21
ObjectAnimator ofObject (T target, 
                Property<T, V> property, 
                TypeConverter<PointF, V> converter, 
                Path path)

Constructs and returns an ObjectAnimator that animates a property along a Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. This variant animates the coordinates in a PointF to follow the Path. If property uses a type other than PointF, converter can be used to change from PointF to the type associated with the Property.

The PointF passed to converter or property, if converter is null, is reused on each animation frame and should not be stored by the setter or TypeConverter.

Parameters
target T: The object whose property is to be animated.
property Property: The property being animated. Should not be null.
converter TypeConverter: Converts a PointF to the type associated with the setter. May be null if conversion is unnecessary.
path Path: The Path to animate values along.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate along path.

ofObject

Added in API level 21
ObjectAnimator ofObject (T target, 
                Property<T, P> property, 
                TypeConverter<V, P> converter, 
                TypeEvaluator<V> evaluator, 
                V... values)

Constructs and returns an ObjectAnimator that animates between Object values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation). This variant supplies a TypeConverter to convert from the animated values to the type of the property. If only one value is supplied, the TypeConverter must be a BidirectionalTypeConverter to retrieve the current value.

Note: The values are stored as references to the original objects, which means that changes to those objects after this method is called will affect the values on the animator. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

Parameters
target T: The object whose property is to be animated.
property Property: The property being animated.
converter TypeConverter: Converts the animated object to the Property type.
evaluator TypeEvaluator: A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.
values V: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofObject

Added in API level 11
ObjectAnimator ofObject (Object target, 
                String propertyName, 
                TypeEvaluator evaluator, 
                Object... values)

Constructs and returns an ObjectAnimator that animates between Object values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start() is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Note: The values are stored as references to the original objects, which means that changes to those objects after this method is called will affect the values on the animator. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

Parameters
target Object: The object whose property is to be animated. This object should have a public method on it called setName(), where name is the value of the propertyName parameter.
propertyName String: The name of the property being animated.
evaluator TypeEvaluator: A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.
values Object: A set of values that the animation will animate between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

ofPropertyValuesHolder

Added in API level 11
ObjectAnimator ofPropertyValuesHolder (Object target, 
                PropertyValuesHolder... values)

Constructs and returns an ObjectAnimator that animates between the sets of values specified in PropertyValueHolder objects. This variant should be used when animating several properties at once with the same ObjectAnimator, since PropertyValuesHolder allows you to associate a set of animation values with a property name.

Parameters
target Object: The object whose property is to be animated. Depending on how the PropertyValuesObjects were constructed, the target object should either have the Property objects used to construct the PropertyValuesHolder objects or (if the PropertyValuesHOlder objects were created with property names) the target object should have public methods on it called setName(), where name is the name of the property passed in as the propertyName parameter for each of the PropertyValuesHolder objects.
values PropertyValuesHolder: A set of PropertyValuesHolder objects whose values will be animated between over time.
Returns
ObjectAnimator An ObjectAnimator object that is set up to animate between the given values.

setAutoCancel

Added in API level 18
void setAutoCancel (boolean cancel)

autoCancel controls whether an ObjectAnimator will be canceled automatically when any other ObjectAnimator with the same target and properties is started. Setting this flag may make it easier to run different animators on the same target object without having to keep track of whether there are conflicting animators that need to be manually canceled. Canceling animators must have the same exact set of target properties, in the same order.

Parameters
cancel boolean: Whether future ObjectAnimators with the same target and properties as this ObjectAnimator will cause this ObjectAnimator to be canceled.

setDuration

Added in API level 11
ObjectAnimator setDuration (long duration)

Sets the length of the animation. The default duration is 300 milliseconds.

Parameters
duration long: The length of the animation, in milliseconds.
Returns
ObjectAnimator ObjectAnimator The object called with setDuration(). This return value makes it easier to compose statements together that construct and then set the duration, as in ObjectAnimator.ofInt(target, propertyName, 0, 10).setDuration(500).start().

setFloatValues

Added in API level 11
void setFloatValues (float... values)

Sets float values that will be animated between. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

If there are already multiple sets of values defined for this ValueAnimator via more than one PropertyValuesHolder object, this method will set the values for the first of those objects.

Parameters
values float: A set of values that the animation will animate between over time.

setIntValues

Added in API level 11
void setIntValues (int... values)

Sets int values that will be animated between. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

If there are already multiple sets of values defined for this ValueAnimator via more than one PropertyValuesHolder object, this method will set the values for the first of those objects.

Parameters
values int: A set of values that the animation will animate between over time.

setObjectValues

Added in API level 11
void setObjectValues (Object... values)

Sets the values to animate between for this animation. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

Note: The Object values are stored as references to the original objects, which means that changes to those objects after this method is called will affect the values on the animator. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

If there are already multiple sets of values defined for this ValueAnimator via more than one PropertyValuesHolder object, this method will set the values for the first of those objects.

There should be a TypeEvaluator set on the ValueAnimator that knows how to interpolate between these value objects. ValueAnimator only knows how to interpolate between the primitive types specified in the other setValues() methods.

Parameters
values Object: The set of values to animate between.

setProperty

Added in API level 14
void setProperty (Property property)

Sets the property that will be animated. Property objects will take precedence over properties specified by the setPropertyName(String) method. Animations should be set up to use one or the other, not both.

Parameters
property Property: The property being animated. Should not be null.

setPropertyName

Added in API level 11
void setPropertyName (String propertyName)

Sets the name of the property that will be animated. This name is used to derive a setter function that will be called to set animated values. For example, a property name of foo will result in a call to the function setFoo() on the target object. If either valueFrom or valueTo is null, then a getter function will also be derived and called.

For best performance of the mechanism that calls the setter function determined by the name of the property being animated, use float or int typed values, and make the setter function for those properties have a void return value. This will cause the code to take an optimized path for these constrained circumstances. Other property types and return types will work, but will have more overhead in processing the requests due to normal reflection mechanisms.

Note that the setter function derived from this property name must take the same parameter type as the valueFrom and valueTo properties, otherwise the call to the setter function will fail.

If this ObjectAnimator has been set up to animate several properties together, using more than one PropertyValuesHolder objects, then setting the propertyName simply sets the propertyName in the first of those PropertyValuesHolder objects.

Parameters
propertyName String: The name of the property being animated. Should not be null.

setTarget

Added in API level 11
void setTarget (Object target)

Sets the target object whose property will be animated by this animation. Not all subclasses operate on target objects (for example, ValueAnimator, but this method is on the superclass for the convenience of dealing generically with those subclasses that do handle targets.

Note: The target is stored as a weak reference internally to avoid leaking resources by having animators directly reference old targets. Therefore, you should ensure that animator targets always have a hard reference elsewhere.

Parameters
target Object: The object being animated

setupEndValues

Added in API level 11
void setupEndValues ()

This method tells the object to use appropriate information to extract ending values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.

setupStartValues

Added in API level 11
void setupStartValues ()

This method tells the object to use appropriate information to extract starting values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.

start

Added in API level 11
void start ()

Starts this animation. If the animation has a nonzero startDelay, the animation will start running after that delay elapses. A non-delayed animation will have its initial value(s) set immediately, followed by calls to onAnimationStart(Animator) for any listeners of this animator.

The animation started by calling this method will be run on the thread that called this method. This thread should have a Looper on it (a runtime exception will be thrown if this is not the case). Also, if the animation will animate properties of objects in the view hierarchy, then the calling thread should be the UI thread for that view hierarchy.

toString

Added in API level 11
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.