public
class
AnimationSet
extends Animation
java.lang.Object | ||
↳ | android.view.animation.Animation | |
↳ | android.view.animation.AnimationSet |
Represents a group of Animations that should be played together. The transformation of each individual animation are composed together into a single transform. If AnimationSet sets any properties that its children also set (for example, duration or fillBefore), the values of AnimationSet override the child values.
The way that AnimationSet inherits behavior from Animation is important to understand. Some of the Animation attributes applied to AnimationSet affect the AnimationSet itself, some are pushed down to the children, and some are ignored, as follows:
ICE_CREAM_SANDWICH
,
the behavior of these properties is the same in XML resources and at runtime (prior to that
release, the values set in XML were ignored for AnimationSet). That is, calling
setDuration(500)
on an AnimationSet has the same effect as declaring
android:duration="500"
in an XML resource for an AnimationSet object.
Inherited XML attributes | |
---|---|
From
class
android.view.animation.Animation
|
Inherited constants |
---|
From
class
android.view.animation.Animation
|
Public constructors | |
---|---|
AnimationSet(Context context, AttributeSet attrs)
Constructor used when an AnimationSet is loaded from a resource. |
|
AnimationSet(boolean shareInterpolator)
Constructor to use when building an AnimationSet from code |
Public methods | |
---|---|
void
|
addAnimation(Animation a)
Add a child animation to this animation set. |
long
|
computeDurationHint()
The duration hint of an animation set is the maximum of the duration hints of all of its component animations. |
List<Animation>
|
getAnimations()
|
long
|
getDuration()
The duration of an AnimationSet is defined to be the duration of the longest child animation. |
long
|
getStartTime()
When this animation should start. |
boolean
|
getTransformation(long currentTime, Transformation t)
The transformation of an animation set is the concatenation of all of its component animations. |
void
|
initialize(int width, int height, int parentWidth, int parentHeight)
Initialize this animation with the dimensions of the object being animated as well as the objects parents. |
void
|
reset()
Reset the initialization state of this animation. |
void
|
restrictDuration(long durationMillis)
Ensure that the duration that this animation will run is not longer than durationMillis. |
void
|
scaleCurrentDuration(float scale)
How much to scale the duration by. |
void
|
setDuration(long durationMillis)
Sets the duration of every child animation. |
void
|
setFillAfter(boolean fillAfter)
If fillAfter is true, the transformation that this animation performed will persist when it is finished. |
void
|
setFillBefore(boolean fillBefore)
If fillBefore is true, this animation will apply its transformation before the start time of the animation. |
void
|
setRepeatMode(int repeatMode)
Defines what this animation should do when it reaches the end. |
void
|
setStartOffset(long startOffset)
When this animation should start relative to the start time. |
void
|
setStartTime(long startTimeMillis)
Sets the start time of this animation and all child animations |
boolean
|
willChangeBounds()
Indicates whether or not this animation will affect the bounds of the animated view. |
boolean
|
willChangeTransformationMatrix()
Indicates whether or not this animation will affect the transformation matrix. |
Protected methods | |
---|---|
AnimationSet
|
clone()
Creates and returns a copy of this object. |
Inherited methods | |
---|---|
From
class
android.view.animation.Animation
| |
From
class
java.lang.Object
|
AnimationSet (Context context, AttributeSet attrs)
Constructor used when an AnimationSet is loaded from a resource.
Parameters | |
---|---|
context |
Context :
Application context to use |
attrs |
AttributeSet :
Attribute set from which to read values
|
AnimationSet (boolean shareInterpolator)
Constructor to use when building an AnimationSet from code
Parameters | |
---|---|
shareInterpolator |
boolean :
Pass true if all of the animations in this set
should use the interpolator associated with this AnimationSet.
Pass false if each animation should use its own interpolator.
|
void addAnimation (Animation a)
Add a child animation to this animation set. The transforms of the child animations are applied in the order that they were added
Parameters | |
---|---|
a |
Animation :
Animation to add.
|
long computeDurationHint ()
The duration hint of an animation set is the maximum of the duration hints of all of its component animations.
Returns | |
---|---|
long |
See also:
List<Animation> getAnimations ()
Returns | |
---|---|
List<Animation> |
All the child animations in this AnimationSet. Note that this may include other AnimationSets, which are not expanded. |
long getDuration ()
The duration of an AnimationSet is defined to be the duration of the longest child animation.
Returns | |
---|---|
long |
the duration in milliseconds of the animation |
See also:
long getStartTime ()
When this animation should start. If the animation has not startet yet,
this method might return START_ON_FIRST_FRAME
.
Returns | |
---|---|
long |
the time in milliseconds when the animation should start or
START_ON_FIRST_FRAME
|
boolean getTransformation (long currentTime, Transformation t)
The transformation of an animation set is the concatenation of all of its component animations.
Parameters | |
---|---|
currentTime |
long :
Where we are in the animation. This is wall clock time. |
t |
Transformation :
A transformation object that is provided by the
caller and will be filled in by the animation. |
Returns | |
---|---|
boolean |
True if the animation is still running |
See also:
void initialize (int width, int height, int parentWidth, int parentHeight)
Initialize this animation with the dimensions of the object being animated as well as the objects parents. (This is to support animation sizes being specified relative to these dimensions.)
Objects that interpret Animations should call this method when
the sizes of the object being animated and its parent are known, and
before calling getTransformation(long, Transformation)
.
Parameters | |
---|---|
width |
int :
Width of the object being animated |
height |
int :
Height of the object being animated |
parentWidth |
int :
Width of the animated object's parent |
parentHeight |
int :
Height of the animated object's parent
|
See also:
void restrictDuration (long durationMillis)
Ensure that the duration that this animation will run is not longer than durationMillis. In addition to adjusting the duration itself, this ensures that the repeat count also will not make it run longer than the given time.
Parameters | |
---|---|
durationMillis |
long :
The maximum duration the animation is allowed
to run.
|
void scaleCurrentDuration (float scale)
How much to scale the duration by.
Parameters | |
---|---|
scale |
float :
The amount to scale the duration.
|
See also:
void setDuration (long durationMillis)
Sets the duration of every child animation.
Parameters | |
---|---|
durationMillis |
long :
the duration of the animation, in milliseconds, for
every child in this set
|
void setFillAfter (boolean fillAfter)
If fillAfter is true, the transformation that this animation performed
will persist when it is finished. Defaults to false if not set.
Note that this applies to individual animations and when using an AnimationSet
to chain
animations.
Parameters | |
---|---|
fillAfter |
boolean :
true if the animation should apply its transformation after it ends |
void setFillBefore (boolean fillBefore)
If fillBefore is true, this animation will apply its transformation
before the start time of the animation. Defaults to true if
setFillEnabled(boolean)
is not set to true.
Note that this applies when using an AnimationSet
to chain
animations. The transformation is not applied before the AnimationSet
itself starts.
Parameters | |
---|---|
fillBefore |
boolean :
true if the animation should apply its transformation before it starts |
void setRepeatMode (int repeatMode)
Defines what this animation should do when it reaches the end. This
setting is applied only when the repeat count is either greater than
0 or INFINITE
. Defaults to RESTART
.
Parameters | |
---|---|
repeatMode |
int :
RESTART or REVERSE |
void setStartOffset (long startOffset)
When this animation should start relative to the start time. This is most
useful when composing complex animations using an AnimationSet
where some of the animations components start at different times.
Parameters | |
---|---|
startOffset |
long :
When this Animation should start, in milliseconds from
the start time of the root AnimationSet. |
void setStartTime (long startTimeMillis)
Sets the start time of this animation and all child animations
Parameters | |
---|---|
startTimeMillis |
long :
the start time in milliseconds
|
See also:
boolean willChangeBounds ()
Indicates whether or not this animation will affect the bounds of the animated view. For instance, a fade animation will not affect the bounds whereas a 200% scale animation will.
Returns | |
---|---|
boolean |
true if this animation will change the view's bounds |
boolean willChangeTransformationMatrix ()
Indicates whether or not this animation will affect the transformation matrix. For instance, a fade animation will not affect the matrix whereas a scale animation will.
Returns | |
---|---|
boolean |
true if this animation will change the transformation matrix |
AnimationSet 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:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
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 | |
---|---|
AnimationSet |
a clone of this instance. |
Throws | |
---|---|
CloneNotSupportedException |