GridLayoutAnimationController

Kotlin |Java

open class GridLayoutAnimationController : LayoutAnimationController

kotlin.Any
↳	android.view.animation.LayoutAnimationController
	↳	android.view.animation.GridLayoutAnimationController

A layout animation controller is used to animated a grid layout's children. While LayoutAnimationController relies only on the index of the child in the view group to compute the animation delay, this class uses both the X and Y coordinates of the child within a grid. In addition, the animation direction can be controlled. The default direction is DIRECTION_LEFT_TO_RIGHT | DIRECTION_TOP_TO_BOTTOM. You can also set the animation priority to columns or rows. The default priority is none. Information used to compute the animation delay of each child are stored in an instance of android.view.animation.GridLayoutAnimationController.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 grid layout animation controller.

XML attributes
`android:columnDelay`	Fraction of the animation duration used to delay the beginning of the animation of each column.
`android:direction`	Direction of the animation in the grid.
`android:directionPriority`	Priority of the rows and columns.
`android:rowDelay`	Fraction of the animation duration used to delay the beginning of the animation of each row.

Inherited XML attributes

From class LayoutAnimationController

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

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

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

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

Constants
static Int	`DIRECTION_BOTTOM_TO_TOP` Animates the children starting from the bottom of the grid to the top.
static Int	`DIRECTION_HORIZONTAL_MASK` Bitmask used to retrieve the horizontal component of the direction.
static Int	`DIRECTION_LEFT_TO_RIGHT` Animates the children starting from the left of the grid to the right.
static Int	`DIRECTION_RIGHT_TO_LEFT` Animates the children starting from the right of the grid to the left.
static Int	`DIRECTION_TOP_TO_BOTTOM` Animates the children starting from the top of the grid to the bottom.
static Int	`DIRECTION_VERTICAL_MASK` Bitmask used to retrieve the vertical component of the direction.
static Int	`PRIORITY_COLUMN` Columns are animated first.
static Int	`PRIORITY_NONE` Rows and columns are animated at the same time.
static Int	`PRIORITY_ROW` Rows are animated first.

Inherited constants

From class LayoutAnimationController

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.

Public constructors
`GridLayoutAnimationController(context: Context!, attrs: AttributeSet!)` Creates a new grid layout animation controller from external resources.
`GridLayoutAnimationController(animation: Animation!)` Creates a new layout animation controller with a delay of 50% for both rows and columns and the specified animation.
`GridLayoutAnimationController(animation: Animation!, columnDelay: Float, rowDelay: Float)` Creates a new layout animation controller with the specified delays and the specified animation.

Public methods
open Float	`getColumnDelay()` Returns the delay by which the children's animation are offset from one column to the other.
open Int	`getDirection()` Returns the direction of the animation.
open Int	`getDirectionPriority()` Returns the direction priority for the animation.
open Float	`getRowDelay()` Returns the delay by which the children's animation are offset from one row to the other.
open Unit	`setColumnDelay(columnDelay: Float)` Sets the delay, as a fraction of the animation duration, by which the children's animations are offset from one column to the other.
open Unit	`setDirection(direction: Int)` Sets the direction of the animation.
open Unit	`setDirectionPriority(directionPriority: Int)` Specifies the direction priority of the animation.
open Unit	`setRowDelay(rowDelay: Float)` Sets the delay, as a fraction of the animation duration, by which the children's animations are offset from one row to the other.
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.

Inherited functions

From class LayoutAnimationController

`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. The returned animation is delayed by an offset computed according to the information provided by `android.view.animation.LayoutAnimationController.AnimationParameters`. This method is called by view groups to obtain the animation to set on a specific child.
`Float`	`getDelay()` Returns the delay by which the children's animation are offset. The delay is expressed as a fraction of the animation duration.
`Interpolator!`	`getInterpolator()` Returns the interpolator used to interpolate the delays between the children.
`Int`	`getOrder()` Returns the order used to compute the delay of each child's animation.
`Int`	`getTransformedIndex(params: LayoutAnimationController.AnimationParameters!)` Transforms the index stored in `android.view.animation.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.
`Boolean`	`isDone()` Indicates whether the layout animation is over or not. A layout animation is considered done when the animation with the longest delay is done.
`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 .
`Unit`	`setAnimation(animation: Animation!)` Sets the animation to be run on each child of the view group on which this layout animation controller is .
`Unit`	`setDelay(delay: Float)` 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
`Unit`	`setInterpolator(context: Context!, resourceID: Int)` Sets the interpolator used to interpolate the delays between the children.
`Unit`	`setInterpolator(interpolator: Interpolator!)` Sets the interpolator used to interpolate the delays between the children.
`Unit`	`setOrder(order: Int)` Sets the order used to compute the delay of each child's animation.
`Unit`	`start()` Starts the animation.

Inherited properties

From class LayoutAnimationController

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. Subclasses should use this object to avoid creating their own.

XML attributes

android:columnDelay

android:columnDelay

Fraction of the animation duration used to delay the beginning of the animation of each column.

May be a floating point value, such as "1.2".

android:direction

android:direction

Direction of the animation in the grid.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
bottom_to_top	2	Animates rows from bottom to top.
left_to_right	0	Animates columns from left to right.
right_to_left	1	Animates columns from right to left.
top_to_bottom	0	Animates rows from top to bottom.

android:directionPriority

android:directionPriority

Priority of the rows and columns. When the priority is none, both rows and columns have the same priority. When the priority is column, the animations will be applied on the columns first. The same goes for rows.

Must be one of the following constant values.

Constant	Value	Description
column	1	Columns are animated first.
none	0	Rows and columns are animated at the same time.
row	2	Rows are animated first.

android:rowDelay

android:rowDelay

Fraction of the animation duration used to delay the beginning of the animation of each row.

May be a floating point value, such as "1.2".

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
`columnDelay`	Float: the delay by which each column animation must be offset
`rowDelay`	Float: the delay by which each row animation must be offset

GridLayoutAnimationController

Summary

XML attributes

android:columnDelay

android:direction

android:directionPriority

android:rowDelay

Constants

DIRECTION_BOTTOM_TO_TOP

DIRECTION_HORIZONTAL_MASK

DIRECTION_LEFT_TO_RIGHT

DIRECTION_RIGHT_TO_LEFT

DIRECTION_TOP_TO_BOTTOM

DIRECTION_VERTICAL_MASK

PRIORITY_COLUMN

PRIORITY_NONE

PRIORITY_ROW

Public constructors