LayoutAnimationController

Kotlin |Java

open class LayoutAnimationController

kotlin.Any
↳	android.view.animation.LayoutAnimationController

Known Direct Subclasses

GridLayoutAnimationController

A layout animation controller is used to animated a grid layout's children.

A layout animation controller is used to animate the children of a layout or a view group. 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 android.view.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 android.view.animation.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 android.view.animation.LayoutAnimationController.AnimationParameters, itself stored in the android.view.ViewGroup.LayoutParams of the view.

Summary

Nested classes
open	`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`	Animation to use on each child.
`android:animationOrder`	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`	Interpolator used to interpolate the delay between the start of each animation.

Constants
static Int	`ORDER_NORMAL` Distributes the animation delays in the order in which view were added to their view group.
static Int	`ORDER_RANDOM` Randomly distributes the animation delays.
static Int	`ORDER_REVERSE` Distributes the animation delays in the reverse order in which view were added to their view group.

Public constructors
`LayoutAnimationController(context: Context!, attrs: AttributeSet!)` Creates a new layout animation controller from external resources.
`LayoutAnimationController(animation: Animation!)` Creates a new layout animation controller with a delay of 50% and the specified animation.
`LayoutAnimationController(animation: Animation!, delay: Float)` Creates a new layout animation controller with the specified delay and the specified animation.

Public methods
open Animation!	`getAnimation()` Returns the animation applied to each child of the view group on which this controller is set.
Animation!	`getAnimationForView(view: View!)` Returns the animation to be applied to the specified view.
open Float	`getDelay()` Returns the delay by which the children's animation are offset.
open Interpolator!	`getInterpolator()` Returns the interpolator used to interpolate the delays between the children.
open Int	`getOrder()` Returns the order used to compute the delay of each child's animation.
open Boolean	`isDone()` Indicates whether the layout animation is over or not.
open Unit	`setAnimation(context: Context!, resourceID: Int)` Sets the animation to be run on each child of the view group on which this layout animation controller is .
open Unit	`setAnimation(animation: Animation!)` Sets the animation to be run on each child of the view group on which this layout animation controller is .
open Unit	`setDelay(delay: Float)` Sets the delay, as a fraction of the animation duration, by which the children's animations are offset.
open Unit	`setInterpolator(context: Context!, resourceID: Int)` Sets the interpolator used to interpolate the delays between the children.
open Unit	`setInterpolator(interpolator: Interpolator!)` Sets the interpolator used to interpolate the delays between the children.
open Unit	`setOrder(order: Int)` Sets the order used to compute the delay of each child's animation.
open Unit	`start()` Starts the animation.
open Boolean	`willOverlap()` Indicates whether two children's animations will overlap.

Protected methods
open Long	`getDelayForView(view: View!)` Returns the amount of milliseconds by which the specified view's animation must be delayed or offset.
open Int	`getTransformedIndex(params: LayoutAnimationController.AnimationParameters!)` Transforms the index stored in `android.view.animation.LayoutAnimationController.AnimationParameters` by the order returned by `getOrder()`.

Properties
Animation!	`mAnimation` The animation applied on each child of the view group on which this layout animation controller is set.
Interpolator!	`mInterpolator` The interpolator used to interpolate the delays.
Random!	`mRandomizer` The randomizer used when the order is set to random.

XML attributes

android:animation

android:animation

Animation to use on each child.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:animationOrder

android:animationOrder

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.
random	2	Animations are started randomly.
reverse	1	Animations are started in the reverse order.

android:delay

android:delay

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.

android:interpolator

android:interpolator

Interpolator used to interpolate the delay between the start of each animation.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

Parameters
`context`	Context!: the Context the view group is running in, through which it can access the resources
`attrs`	AttributeSet!: the attributes of the XML tag that is inflating the layout animation controller

Parameters
`animation`	Animation!: the animation to use on each child of the view group
`delay`	Float: the delay by which each child's animation must be offset

Parameters
`context`	Context!: the context from which the animation must be inflated
`resourceID`	Int: the resource identifier of the animation

Parameters
`context`	Context!: the context from which the interpolator must be inflated
`resourceID`	Int: the resource identifier of the interpolator

LayoutAnimationController

Summary

XML attributes

android:animation

android:animationOrder

android:delay

android:interpolator

Constants

ORDER_NORMAL

ORDER_RANDOM

ORDER_REVERSE

Public constructors