NineOldAndroids

• noaAnimatorSet

  Methods:

  • Cancel
    Cancels the animation. Unlike End(), Cancel() causes the animation to stop in its tracks, sending a Cancel event to its listeners, followed by an End event. This method must be called on the thread that is running the animation. Note that canceling a AnimatorSet also cancels all of the animations that it is responsible for.
  • End
    Ends the animation. This causes the animation to assign the end value of the property being animated, then sending the End event to its listeners. This method must be called on the thread that is running the animation. Note that ending a AnimatorSet also ends all of the animations that it is responsible for.
  • INTERPOLATOR_ACCELERATE As AccelerateInterpolator
  • INTERPOLATOR_ACCELERATE_DECELERATE As AccelerateDecelerateInterpolator
  • INTERPOLATOR_ANTICIPATE As AnticipateInterpolator
  • INTERPOLATOR_ANTICIPATE_OVERSHOOT As AnticipateOvershootInterpolator
  • INTERPOLATOR_BOUNCE As BounceInterpolator
  • INTERPOLATOR_CYCLE (cycles As Float) As CycleInterpolator
  • INTERPOLATOR_DECELERATE As DecelerateInterpolator
  • INTERPOLATOR_LINEAR As LinearInterpolator
  • INTERPOLATOR_OVERSHOOT As OvershootInterpolator
  • Play (anim As Object) As Builder
    This method creates a Builder object, which is used to set up playing constraints. This initial play() method tells the Builder the animation that is the dependency for the succeeding commands to the Builder. For example, calling play(a1).with(a2) sets up the AnimatorSet to play a1 and a2 at the same time, play(a1).before(a2) sets up the AnimatorSet to play a1 first, followed by a2, and play(a1).after(a2) sets up the AnimatorSet to play a2 first, followed by a1. Note that play() is the only way to tell the Builder the animation upon which the dependency is created, so successive calls to the various functions in Builder will all refer to the initial parameter supplied in play() as the dependency of the other animations. For example, calling play(a1).before(a2).before(a3) will play both a2 and a3 when a1 ends; it does not set up a dependency between a2 and a3.
  • PlaySequentially (items() As Object)
    Sets up this AnimatorSet to play each of the supplied animations when the previous animation ends. items: The animations that will be started one after another.
  • PlayTogether (items() As Object)
    Sets up this AnimatorSet to play all of the supplied animations at the same time. items: The animations that will be started simultaneously.
  • 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 sending a Start event to 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. Starting this AnimatorSet will, in turn, start the animations for which it is responsible. The details of when exactly those animations are started depends on the dependency relationships that have been set up between the animations.
  • isRunning As Boolean
    Returns true if any of the child animations of this AnimatorSet have been started and have not yet ended.
  • isStarted As Boolean
    Returns whether this Animator has been started and not yet ended. This state is a superset of the state of isRunning(), because an Animator with a nonzero startDelay will return true for isStarted() during the delay phase, whereas isRunning() will return true only after the delay phase is complete.
  • setDuration (duration As Long) As AnimatorSet
    Sets the length of each of the current child animations of this AnimatorSet. By default, each child animation will use its own duration. If the duration is set on the AnimatorSet, then each child animation inherits this duration. duration: The length of the animation, in milliseconds, of each of the child animations of this AnimatorSet.
  • 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
    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.

  Properties:

  • ChildAnimations As List [read only]
    Returns the current list of child Animator objects controlled by this AnimatorSet. This is a copy of the internal list; modifications to the returned list will not affect the AnimatorSet, although changes to the underlying Animator objects will affect those objects being managed by the AnimatorSet.
  • Duration As Long [read only]
    Gets the length of each of the child animations of this AnimatorSet. This value may be less than 0, which indicates that no duration has been set on this AnimatorSet and each of the child animations will use their own duration.
  • Interpolator As Object [write only]
    Sets the time interpolator for all current child animations of this AnimatorSet.
  • StartDelay As Long
    The amount of time, in milliseconds, to delay starting the animation after Start is called.
  • Target As Object [write only]
    Sets the target object for all current child animations of this AnimatorSet that take targets (ObjectAnimator and AnimatorSet).

• noaColorARGBEvaluator

  Methods:

  • evaluate (fraction As Float, startValue As Object, endValue As Object) As Object
    This function returns the calculated in-between value for a color given integers that represent the start and end values in the four bytes of the 32-bit int. Each channel is separately linearly interpolated and the resulting calculated values are recombined into the return value. fraction: The fraction from the starting to the ending values. startValue: A 32-bit int value representing colors in the separate bytes of the parameter. endValue: A 32-bit int value representing colors in the separate bytes of the parameter. Returns a value that is calculated to be the linearly interpolated result, derived by separating the start and end values into separate color channels and interpolating each one separately, recombining the resulting values in the same way.

• noaFloatEvaluator

  Methods:

  • evaluate (fraction As Float, startValue As Number, endValue As Number) As Float
    This function returns the result of linearly interpolating the start and end values, with fraction representing the proportion between the start and end values. The calculation is a simple parametric calculation: result = x0 + t * (v1 - v0), where x0 is startValue, x1 is endValue, and t is fraction. fraction: The fraction from the starting to the ending values startValue: The start value; should be of type float endValue: The end value; should be of type float Returns a linear interpolation between the start and end values, given the fraction parameter.

• noaIntEvaluator

  Methods:

  • evaluate (fraction As Float, startValue As Integer, endValue As Integer) As Integer
    This function returns the result of linearly interpolating the start and end values, with fraction representing the proportion between the start and end values. The calculation is a simple parametric calculation: result = x0 + t * (v1 - v0), where x0 is startValue, x1 is endValue, and t is fraction. fraction: The fraction from the starting to the ending values startValue: The start value; should be of type int endValue: The end value; should be of type int Returns a linear interpolation between the start and end values, given the fraction parameter.

• noaObjectAnimator

  Events:

  • Cancel
  • End
  • Repeat
  • Start
  • Update

  Fields:

  • PROPERTY_ALPHA As String
  • PROPERTY_PIVOT_X As String
  • PROPERTY_PIVOT_Y As String
  • PROPERTY_ROTATION As String
  • PROPERTY_ROTATION_X As String
  • PROPERTY_ROTATION_Y As String
  • PROPERTY_SCALE_X As String
  • PROPERTY_SCALE_Y As String
  • PROPERTY_SCROLL_X As String
  • PROPERTY_SCROLL_Y As String
  • PROPERTY_TRANSLATION_X As String
  • PROPERTY_TRANSLATION_Y As String
  • PROPERTY_X As String
  • PROPERTY_Y As String
  • REPEATCOUNT_INFINITE As Int
    This value used used with the RepeatCount property to repeat the animation indefinitely.
  • REPEATMODE_RESTART As Int
    When the animation reaches the end and RepeatCount is INFINITE or a positive value, the animation restarts from the beginning.
  • REPEATMODE_REVERSE As Int
    When the animation reaches the end and RepeatCount is INFINITE or a positive value, the animation reverses direction on every iteration.

  Methods:

  • Cancel
    Cancels the animation. Unlike End(), Cancel() causes the animation to stop in its tracks, sending a Cancel event to its listeners, followed by an End event. This method must be called on the thread that is running the animation.
  • End
    Ends the animation. This causes the animation to assign the end value of the property being animated, then sending the End event to its listeners. This method must be called on the thread that is running the animation.
  • INTERPOLATOR_ACCELERATE As AccelerateInterpolator
  • INTERPOLATOR_ACCELERATE_DECELERATE As AccelerateDecelerateInterpolator
  • INTERPOLATOR_ANTICIPATE As AnticipateInterpolator
  • INTERPOLATOR_ANTICIPATE_OVERSHOOT As AnticipateOvershootInterpolator
  • INTERPOLATOR_BOUNCE As BounceInterpolator
  • INTERPOLATOR_CYCLE (cycles As Float) As CycleInterpolator
  • INTERPOLATOR_DECELERATE As DecelerateInterpolator
  • INTERPOLATOR_LINEAR As LinearInterpolator
  • INTERPOLATOR_OVERSHOOT As OvershootInterpolator
  • InitializeFloat (target As Object, propertyName As String, StartValue As Float, EndValue As Float, EventPrefix As String) As ObjectAnimator
    Initializes an ObjectAnimator that animates between float values. target: The object whose property is to be animated. propertyName: The name of the property being animated. values: A set of values that the animation will animate between over time.
  • InitializeInt (target As Object, propertyName As String, StartValue As Int, EndValue As Int, EventPrefix As String) As ObjectAnimator
    Initializes an ObjectAnimator that animates between int values. target: The object whose property is to be animated. propertyName: The name of the property being animated. values: A set of values that the animation will animate between over time.
  • InitializeObject (target As Object, propertyName As String, evaluator As TypeEvaluator, StartValue As Object, EndValue As Object, EventPrefix As String) As ObjectAnimator
    Initializes an ObjectAnimator that animates between object values. Since ObjectAnimator does not know how to animate between arbitrary Objects, this method also takes a TypeEvaluator object that the ObjectAnimator will use to perform that interpolation. 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.
  • Reverse
    Plays the Animator in reverse. If the animation is already running, it will stop itself and play backwards from the point reached when reverse was called. If the animation is not currently running, then it will start from the end and play backwards. This behavior is only set for the current animation; future playing of the animation will use the default behavior of playing forward.
  • 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 sending a Start event to 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. Calls to Start after the first are ignored. If you want to restart the animation, call Cancel or End before.
  • Values As List
    Returns the values that this Animator animates between.
  • isRunning As Boolean
    Returns whether this Animator is currently running (having been started and gone past any initial startDelay period and not yet ended).
  • isStarted As Boolean
    Returns whether this Animator has been started and not yet ended. This state is a superset of the state of isRunning(), because an Animator with a nonzero startDelay will return true for isStarted() during the delay phase, whereas isRunning() will return true only after the delay phase is complete.
  • setDuration (duration As Long) As ObjectAnimator
    Sets the length of the animation. The default duration is 300 milliseconds.
  • 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
    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.
  • toString As String

  Properties:

  • AnimatedFraction As Float [read only]
    Returns the current animation fraction, which is the elapsed/interpolated fraction used in the most recent frame update on the animation.
  • AnimatedValue As Object [read only]
    The most recent value calculated by this Animator when there is just one property being animated. This value is only sensible while the animation is running. The main purpose for this read-only property is to retrieve the value from the Animator in the Update event handler, which is called during each animation frame, immediately after the value is calculated.
  • CurrentPlayTime As Long
    Gets the current position of the animation in time, which is equal to the current time minus the time that the animation started. An animation that is not yet started will return a value of zero.
  • Duration As Long [read only]
    Gets the length of the animation. The default duration is 300 milliseconds.
  • Evaluator As TypeEvaluator [write only]
    The type evaluator to be used when calculating the animated values of this animation. The system will automatically assign a float or int evaluator based on the type of StartValue and EndValue in Initialize. But if these values are not one of these primitive types, or if different evaluation is desired (such as is necessary with int values that represent colors), a custom evaluator needs to be assigned. For example, when running an animation on color values, the noaColorARGBEvaluator should be used to get correct RGB color interpolation.
  • FloatValues() As Float [write only]
  • FrameDelay As Long
    The amount of time, in milliseconds, between each frame of the animation. This is a requested time that the animation will attempt to honor, but the actual delay between frames may be different, depending on system load and capabilities. NOTE: the same delay is applied to all animations, since they are all run off of a single timing loop.
  • IntValues() As Int [write only]
  • Interpolator As Interpolator
    Gets or sets the time interpolator that this Animator uses. The interpolator determines whether the animation runs with linear or non-linear motion, such as acceleration and deceleration. The default value is AccelerateDecelerateInterpolator.
  • ObjectValues() As Object [write only]
  • PropertyName As String
    Gets or sets 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. 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.
  • RepeatCount As Int
    Defines how many times the animation should repeat. The default value is 0.
  • RepeatMode As Int
    Defines what this animation should do when it reaches the end.
  • StartDelay As Long
    The amount of time, in milliseconds, to delay starting the animation after Start() is called.
  • Target As Object
    The target object whose property will be animated by this animation

• noaTimeAnimator

  Events:

  • Cancel
  • End
  • Start
  • TimeUpdate (TotalTime As Long, DeltaTime As Long)

  Methods:

  • Cancel
    Cancels this Animator.
  • End
    Ends this Animator.
  • Initialize (EventPrefix As String) As noaTimeAnimator
    Initializes a TimeAnimator. There is no duration, interpolation, or object value-setting with this Animator. Instead, it is simply started, after which it proceeds to send out events on every animation frame to its TimeUpdate listener, with information about the total elapsed time, and the elapsed time since the previous animation frame.
  • Start
    Starts this Animator. Calls to Start after the first are ignored. If you want to restart the animation, call Cancel or End before.
  • isRunning As Boolean
    Returns whether this Animator is currently running (having been started and gone past any initial startDelay period and not yet ended).
  • isStarted As Boolean
    Returns whether this Animator has been started and not yet ended.

  Properties:

  • FrameDelay As Long
    The amount of time, in milliseconds, between each frame of the animation. This is a requested time that the animation will attempt to honor, but the actual delay between frames may be different, depending on system load and capabilities. NOTE: the same delay is applied to all animations, since they are all run off of a single timing loop.
  • StartDelay As Long
    The amount of time, in milliseconds, to delay starting the animation after Start() is called.

• noaValueAnimator

  Events:

  • Cancel
  • End
  • Repeat
  • Start
  • Update

  Fields:

  • REPEATCOUNT_INFINITE As Int
    This value used used with the RepeatCount property to repeat the animation indefinitely.
  • REPEATMODE_RESTART As Int
    When the animation reaches the end and RepeatCount is INFINITE or a positive value, the animation restarts from the beginning.
  • REPEATMODE_REVERSE As Int
    When the animation reaches the end and RepeatCount is INFINITE or a positive value, the animation reverses direction on every iteration.

  Methods:

  • Cancel
    Cancels the animation. Unlike End(), Cancel() causes the animation to stop in its tracks, sending a Cancel event to its listeners, followed by an End event. This method must be called on the thread that is running the animation.
  • End
    Ends the animation. This causes the animation to assign the end value of the property being animated, then sending the End event to its listeners. This method must be called on the thread that is running the animation.
  • INTERPOLATOR_ACCELERATE As AccelerateInterpolator
  • INTERPOLATOR_ACCELERATE_DECELERATE As AccelerateDecelerateInterpolator
  • INTERPOLATOR_ANTICIPATE As AnticipateInterpolator
  • INTERPOLATOR_ANTICIPATE_OVERSHOOT As AnticipateOvershootInterpolator
  • INTERPOLATOR_BOUNCE As BounceInterpolator
  • INTERPOLATOR_CYCLE (cycles As Float) As CycleInterpolator
  • INTERPOLATOR_DECELERATE As DecelerateInterpolator
  • INTERPOLATOR_LINEAR As LinearInterpolator
  • INTERPOLATOR_OVERSHOOT As OvershootInterpolator
  • InitializeFloat (StartValue As Float, EndValue As Float, EventPrefix As String) As ValueAnimator
    Initializes a ValueAnimator that animates between float values.
  • InitializeInt (StartValue As Int, EndValue As Int, EventPrefix As String) As ValueAnimator
    Initializes a ValueAnimator that animates between int values.
  • InitializeObject (evaluator As TypeEvaluator, StartValue As Object, EndValue As Object, EventPrefix As String) As ValueAnimator
    Initializes a ValueAnimator that animates between object values. Since ValueAnimator does not know how to animate between arbitrary Objects, this method also takes a TypeEvaluator object that the ValueAnimator will use to perform that interpolation.
  • Reverse
    Plays the Animator in reverse. If the animation is already running, it will stop itself and play backwards from the point reached when reverse was called. If the animation is not currently running, then it will start from the end and play backwards. This behavior is only set for the current animation; future playing of the animation will use the default behavior of playing forward.
  • 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 sending a Start event to 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. Calls to Start after the first are ignored. If you want to restart the animation, call Cancel or End before.
  • Values As List
    Returns the values that this Animator animates between.
  • isRunning As Boolean
    Returns whether this Animator is currently running (having been started and gone past any initial startDelay period and not yet ended).
  • isStarted As Boolean
    Returns whether this Animator has been started and not yet ended. This state is a superset of the state of isRunning(), because an Animator with a nonzero startDelay will return true for isStarted() during the delay phase, whereas isRunning() will return true only after the delay phase is complete.
  • setDuration (duration As Long) As ValueAnimator
    Sets the length of the animation. The default duration is 300 milliseconds.
  • 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
    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.
  • toString As String

  Properties:

  • AnimatedFraction As Float [read only]
    Returns the current animation fraction, which is the elapsed/interpolated fraction used in the most recent frame update on the animation.
  • AnimatedValue As Object [read only]
    The most recent value calculated by this Animator when there is just one property being animated. This value is only sensible while the animation is running. The main purpose for this read-only property is to retrieve the value from the Animator in the Update event handler, which is called during each animation frame, immediately after the value is calculated.
  • CurrentPlayTime As Long
    Gets the current position of the animation in time, which is equal to the current time minus the time that the animation started. An animation that is not yet started will return a value of zero.
  • Duration As Long [read only]
    Gets the length of the animation. The default duration is 300 milliseconds.
  • Evaluator As TypeEvaluator [write only]
    The type evaluator to be used when calculating the animated values of this animation. The system will automatically assign a float or int evaluator based on the type of StartValue and EndValue in Initialize. But if these values are not one of these primitive types, or if different evaluation is desired (such as is necessary with int values that represent colors), a custom evaluator needs to be assigned. For example, when running an animation on color values, the noaColorARGBEvaluator should be used to get correct RGB color interpolation.
  • FloatValues() As Float [write only]
    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.
  • FrameDelay As Long
    The amount of time, in milliseconds, between each frame of the animation. This is a requested time that the animation will attempt to honor, but the actual delay between frames may be different, depending on system load and capabilities. NOTE: the same delay is applied to all animations, since they are all run off of a single timing loop.
  • IntValues() As Int [write only]
    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.
  • Interpolator As Interpolator
    Gets or sets the time interpolator that this Animator uses. The interpolator determines whether the animation runs with linear or non-linear motion, such as acceleration and deceleration. The default value is AccelerateDecelerateInterpolator.
  • ObjectValues() As Object [write only]
    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. 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.
  • RepeatCount As Int
    Defines how many times the animation should repeat. The default value is 0.
  • RepeatMode As Int
    Defines what this animation should do when it reaches the end.
  • StartDelay As Long
    The amount of time, in milliseconds, to delay starting the animation after Start() is called.

• noaViewHelper

  Methods:

  • getAlpha (view As View) As Float
  • getPivotX (view As View) As Float
  • getPivotY (view As View) As Float
  • getRotation (view As View) As Float
  • getRotationX (view As View) As Float
  • getRotationY (view As View) As Float
  • getScaleX (view As View) As Float
  • getScaleY (view As View) As Float
  • getScrollX (view As View) As Float
  • getScrollY (view As View) As Float
  • getTranslationX (view As View) As Float
  • getTranslationY (view As View) As Float
  • getX (view As View) As Float
  • getY (view As View) As Float
  • setAlpha (view As View, alpha As Float)
  • setPivotX (view As View, pivotX As Float)
  • setPivotY (view As View, pivotY As Float)
  • setRotation (view As View, rotation As Float)
  • setRotationX (view As View, rotationX As Float)
  • setRotationY (view As View, rotationY As Float)
  • setScaleX (view As View, scaleX As Float)
  • setScaleY (view As View, scaleY As Float)
  • setScrollX (view As View, scrollX As Int)
  • setScrollY (view As View, scrollY As Int)
  • setTranslationX (view As View, translationX As Float)
  • setTranslationY (view As View, translationY As Float)
  • setX (view As View, x As Float)
  • setY (view As View, y As Float)

• Author: Jake Wharton, The Android Open Source Project, F. Leneuf-Magaud

• Version: 0.93