java.lang.Object | |
↳ | android.view.animation.LayoutAnimationController |
Known Direct Subclasses |
A layout animation controller is used to animated a layout's, or a view
group's, children. Each child uses the same animation but for every one of
them, the animation starts at a different time. A layout animation controller
is used by ViewGroup
to compute the delay by which each
child's animation start must be offset. The delay is computed by using
characteristics of each child, like its index in the view group.
This standard implementation computes the delay by multiplying a fixed
amount of miliseconds by the index of the child in its parent view group.
Subclasses are supposed to override
getDelayForView(android.view.View)
to implement a different way
of computing the delay. For instance, a
GridLayoutAnimationController
will compute the
delay based on the column and row indices of the child in its parent view
group.
Information used to compute the animation delay of each child are stored
in an instance of
LayoutAnimationController.AnimationParameters
,
itself stored in the ViewGroup.LayoutParams
of the view.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
LayoutAnimationController.AnimationParameters | The set of parameters that has to be attached to each view contained in the view group animated by the layout animation controller. |
XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
android:animation | setAnimation(Animation) | Animation to use on each child. | |||||||||
android:animationOrder | setOrder(int) | The order in which the animations will be started. | |||||||||
android:delay | Fraction of the animation duration used to delay the beginning of the animation of each child. | ||||||||||
android:interpolator | setInterpolator(Context,int) | Interpolator used to interpolate the delay between the start of each animation. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | ORDER_NORMAL | Distributes the animation delays in the order in which view were added to their view group. | |||||||||
int | ORDER_RANDOM | Randomly distributes the animation delays. | |||||||||
int | ORDER_REVERSE | Distributes the animation delays in the reverse order in which view were added to their view group. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
mAnimation | The animation applied on each child of the view group on which this layout animation controller is set. | ||||||||||
mInterpolator | The interpolator used to interpolate the delays. | ||||||||||
mRandomizer | The randomizer used when the order is set to random. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new layout animation controller from external resources.
| |||||||||||
Creates a new layout animation controller with a delay of 50%
and the specified animation.
| |||||||||||
Creates a new layout animation controller with the specified delay
and the specified animation.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the animation applied to each child of the view group on which
this controller is set.
| |||||||||||
Returns the animation to be applied to the specified view.
| |||||||||||
Returns the delay by which the children's animation are offset.
| |||||||||||
Returns the interpolator used to interpolate the delays between the
children.
| |||||||||||
Returns the order used to compute the delay of each child's animation.
| |||||||||||
Indicates whether the layout animation is over or not.
| |||||||||||
Sets the animation to be run on each child of the view group on which
this layout animation controller is .
| |||||||||||
Sets the animation to be run on each child of the view group on which
this layout animation controller is .
| |||||||||||
Sets the delay, as a fraction of the animation duration, by which the
children's animations are offset.
| |||||||||||
Sets the interpolator used to interpolate the delays between the
children.
| |||||||||||
Sets the interpolator used to interpolate the delays between the
children.
| |||||||||||
Sets the order used to compute the delay of each child's animation.
| |||||||||||
Starts the animation.
| |||||||||||
Indicates whether two children's animations will overlap.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the amount of milliseconds by which the specified view's
animation must be delayed or offset.
| |||||||||||
Transforms the index stored in
LayoutAnimationController.AnimationParameters
by the order returned by getOrder() . |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Animation to use on each child.
Must be a reference to another resource, in the form "@[+][package:]type:name
"
or to a theme attribute in the form "?[package:][type:]name
".
This corresponds to the global attribute
resource symbol animation
.
The order in which the animations will be started.
Must be one of the following constant values.
Constant | Value | Description |
---|---|---|
normal | 0 | Animations are started in the natural order. |
reverse | 1 | Animations are started in the reverse order. |
random | 2 | Animations are started randomly. |
This corresponds to the global attribute
resource symbol animationOrder
.
Fraction of the animation duration used to delay the beginning of the animation of each child.
May be a floating point value, such as "1.2
".
May be a fractional value, which is a floating point number appended with either % or %p, such as "14.5%
".
The % suffix always means a percentage of the base size; the optional %p suffix provides a size relative to
some parent container.
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol delay
.
Interpolator used to interpolate the delay between the start of each animation.
Must be a reference to another resource, in the form "@[+][package:]type:name
"
or to a theme attribute in the form "?[package:][type:]name
".
This corresponds to the global attribute
resource symbol interpolator
.
Distributes the animation delays in the order in which view were added to their view group.
Randomly distributes the animation delays.
Distributes the animation delays in the reverse order in which view were added to their view group.
The animation applied on each child of the view group on which this layout animation controller is set.
The interpolator used to interpolate the delays.
The randomizer used when the order is set to random. Subclasses should use this object to avoid creating their own.
Creates a new layout animation controller from external resources.
context | the Context the view group is running in, through which it can access the resources |
---|---|
attrs | the attributes of the XML tag that is inflating the layout animation controller |
Creates a new layout animation controller with a delay of 50% and the specified animation.
animation | the animation to use on each child of the view group |
---|
Creates a new layout animation controller with the specified delay and the specified animation.
animation | the animation to use on each child of the view group |
---|---|
delay | the delay by which each child's animation must be offset |
Returns the animation applied to each child of the view group on which this controller is set.
Animation
instanceReturns the animation to be applied to the specified view. The returned
animation is delayed by an offset computed according to the information
provided by
LayoutAnimationController.AnimationParameters
.
This method is called by view groups to obtain the animation to set on
a specific child.
view | the view to animate |
---|
getDelayForView(android.view.View)
Returns the delay by which the children's animation are offset. The delay is expressed as a fraction of the animation duration.
Returns the interpolator used to interpolate the delays between the children.
Interpolator
Returns the order used to compute the delay of each child's animation.
ORDER_NORMAL
, ORDER_REVERSE
or
{@link #ORDER_RANDOM)Indicates whether the layout animation is over or not. A layout animation is considered done when the animation with the longest delay is done.
Sets the animation to be run on each child of the view group on which this layout animation controller is .
context | the context from which the animation must be inflated |
---|---|
resourceID | the resource identifier of the animation |
Sets the animation to be run on each child of the view group on which this layout animation controller is .
animation | the animation to run on each child of the view group |
---|
Sets the delay, as a fraction of the animation duration, by which the children's animations are offset. The general formula is:
child animation delay = child index * delay * animation duration
delay | a fraction of the animation duration |
---|
Sets the interpolator used to interpolate the delays between the children.
interpolator | the interpolator |
---|
Sets the interpolator used to interpolate the delays between the children.
context | the context from which the interpolator must be inflated |
---|---|
resourceID | the resource identifier of the interpolator |
Sets the order used to compute the delay of each child's animation.
order | one of ORDER_NORMAL , ORDER_REVERSE or
ORDER_RANDOM |
---|
Indicates whether two children's animations will overlap. Animations overlap when the delay is lower than 100% (or 1.0).
Returns the amount of milliseconds by which the specified view's
animation must be delayed or offset. Subclasses should override this
method to return a suitable value.
This implementation returns child animation delay
milliseconds where:
child animation delay = child index * delayThe index is retrieved from the
LayoutAnimationController.AnimationParameters
found in the view's ViewGroup.LayoutParams
.view | the view for which to obtain the animation's delay |
---|
Transforms the index stored in
LayoutAnimationController.AnimationParameters
by the order returned by getOrder()
. Subclasses should override
this method to provide additional support for other types of ordering.
This method should be invoked by
getDelayForView(android.view.View)
prior to any computation.
params | the animation parameters containing the index |
---|