com.nineoldandroids.animation
Class ObjectAnimator

java.lang.Object
  com.nineoldandroids.animation.Animator
      com.nineoldandroids.animation.ValueAnimator
          com.nineoldandroids.animation.ObjectAnimator

All Implemented Interfaces:

Cloneable

public final class ObjectAnimator
extends ValueAnimator

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.

See Also:

setPropertyName(String)

Nested Class Summary

Nested classes/interfaces inherited from class com.nineoldandroids.animation.ValueAnimator

ValueAnimator.AnimatorUpdateListener

Nested classes/interfaces inherited from class com.nineoldandroids.animation.Animator

Animator.AnimatorListener

Field Summary

Fields inherited from class com.nineoldandroids.animation.ValueAnimator

INFINITE, RESTART, REVERSE

Constructor Summary

ObjectAnimator()
Creates a new ObjectAnimator object.

Method Summary

ObjectAnimator	clone()
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	ofFloat(Object target, String propertyName, float... values) Constructs and returns an ObjectAnimator that animates between float values.
static <T> ObjectAnimator	ofFloat(T target, Property<T,Float> property, float... values) Constructs and returns an ObjectAnimator that animates between float values.
static ObjectAnimator	ofInt(Object target, String propertyName, int... values) Constructs and returns an ObjectAnimator that animates between int values.
static <T> ObjectAnimator	ofInt(T target, Property<T,Integer> property, int... values) Constructs and returns an ObjectAnimator that animates between int values.
static ObjectAnimator	ofObject(Object target, String propertyName, TypeEvaluator evaluator, Object... values) Constructs and returns an ObjectAnimator that animates between Object values.
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	ofPropertyValuesHolder(Object target, PropertyValuesHolder... values) Constructs and returns an ObjectAnimator that animates between the sets of values specified in PropertyValueHolder objects.
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()

Methods inherited from class com.nineoldandroids.animation.ValueAnimator

addUpdateListener, cancel, clearAllAnimations, end, getAnimatedFraction, getAnimatedValue, getAnimatedValue, getCurrentAnimationsCount, getCurrentPlayTime, getDuration, getFrameDelay, getInterpolator, getRepeatCount, getRepeatMode, getStartDelay, getValues, isRunning, isStarted, ofFloat, ofInt, ofObject, ofPropertyValuesHolder, removeAllUpdateListeners, removeUpdateListener, reverse, setCurrentPlayTime, setEvaluator, setFrameDelay, setInterpolator, setRepeatCount, setRepeatMode, setStartDelay, setValues

Methods inherited from class com.nineoldandroids.animation.Animator

addListener, getListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectAnimator

public ObjectAnimator()

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

Method Detail

setPropertyName

public 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 - The name of the property being animated. Should not be null.

setProperty

public 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 - The property being animated. Should not be null.

getPropertyName

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

ofInt

public static 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. Two values imply a 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 - 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 - The name of the property being animated.

values - A set of values that the animation will animate between over time.

Returns:

An ObjectAnimator object that is set up to animate between the given values.

ofInt

public static <T> 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. Two values imply a 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 - The object whose property is to be animated.

property - The property being animated.

values - A set of values that the animation will animate between over time.

Returns:

An ObjectAnimator object that is set up to animate between the given values.

ofFloat

public static 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. Two values imply a 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 - 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 - The name of the property being animated.

values - A set of values that the animation will animate between over time.

Returns:

An ObjectAnimator object that is set up to animate between the given values.

ofFloat

public static <T> 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. Two values imply a 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 - The object whose property is to be animated.

property - The property being animated.

values - A set of values that the animation will animate between over time.

Returns:

An ObjectAnimator object that is set up to animate between the given values.

ofObject

public static 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. Two values imply a 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 - 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 - The name of the property being animated.

evaluator - 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 - A set of values that the animation will animate between over time.

Returns:

An ObjectAnimator object that is set up to animate between the given values.

ofObject

public 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. A single value implies that that value is the one being animated to. Two values imply a 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 - The object whose property is to be animated.

property - The property being animated.

evaluator - 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 - A set of values that the animation will animate between over time.

Returns:

An ObjectAnimator object that is set up to animate between the given values.

ofPropertyValuesHolder

public static 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 - 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 - A set of PropertyValuesHolder objects whose values will be animated between over time.

Returns:

An ObjectAnimator object that is set up to animate between the given values.

setIntValues

public void setIntValues(int... values)

Description copied from class: ValueAnimator

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.

Overrides:

setIntValues in class ValueAnimator

Parameters:

values - A set of values that the animation will animate between over time.

setFloatValues

public void setFloatValues(float... values)

Description copied from class: ValueAnimator

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.

Overrides:

setFloatValues in class ValueAnimator

Parameters:

values - A set of values that the animation will animate between over time.

setObjectValues

public void setObjectValues(Object... values)

Description copied from class: ValueAnimator

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.

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.

Overrides:

setObjectValues in class ValueAnimator

Parameters:

values - The set of values to animate between.

start

public void start()

Description copied from class: Animator

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 Animator.AnimatorListener.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.

Overrides:

start in class ValueAnimator

setDuration

public ObjectAnimator setDuration(long duration)

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

Overrides:

setDuration in class ValueAnimator

Parameters:

duration - The length of the animation, in milliseconds.

Returns:

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().

getTarget

public Object getTarget()

The target object whose property will be animated by this animation

Returns:

The object being animated

setTarget

public void setTarget(Object target)

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

Overrides:

setTarget in class Animator

Parameters:

target - The object being animated

setupStartValues

public void setupStartValues()

Description copied from class: Animator

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. An ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.

Overrides:

setupStartValues in class Animator

setupEndValues

public void setupEndValues()

Description copied from class: Animator

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. An ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.

Overrides:

setupEndValues in class Animator

clone

public ObjectAnimator clone()

Overrides:

clone in class ValueAnimator

toString

public String toString()

Overrides:

toString in class ValueAnimator