eu.davidea.flexibleadapter.common

Class FlexibleItemAnimator

java.lang.Object

SimpleItemAnimator

eu.davidea.flexibleadapter.common.FlexibleItemAnimator

public class FlexibleItemAnimator
extends SimpleItemAnimator

This implementation of RecyclerView.ItemAnimator provides basic animations on remove, add, and move events that happen to the items in a RecyclerView. RecyclerView uses a DefaultItemAnimator by default.

Since:

5.0.0-b1 Creation in main package
17/12/2017 Moved into UI package

See Also:

RecyclerView#setItemAnimator(RecyclerView.ItemAnimator)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FlexibleItemAnimator.DefaultAddVpaListener
protected class	FlexibleItemAnimator.DefaultRemoveVpaListener

Field Summary

Fields

Modifier and Type	Field and Description
protected android.view.animation.Interpolator	mInterpolator

Constructor Summary

Constructors

Constructor and Description
FlexibleItemAnimator()

Method Summary

Modifier and Type	Method and Description
boolean	animateAdd(ViewHolder holder)
protected void	animateAddImpl(ViewHolder holder, int index) Performs the Add Animation of this ViewHolder.
boolean	animateChange(ViewHolder oldHolder, ViewHolder newHolder, int fromX, int fromY, int toX, int toY)
boolean	animateMove(ViewHolder holder, int fromX, int fromY, int toX, int toY)
boolean	animateRemove(ViewHolder holder)
protected void	animateRemoveImpl(ViewHolder holder, int index) Performs the Remove Animation of this ViewHolder.
boolean	canReuseUpdatedViewHolder(ViewHolder viewHolder, java.util.List<java.lang.Object> payloads) If the payload list is not empty, DefaultItemAnimator returns true.
void	endAnimation(ViewHolder item)
void	endAnimations()
boolean	isRunning()
protected boolean	preAnimateAddImpl(ViewHolder holder) Prepares the View for Add Animation.
protected boolean	preAnimateRemoveImpl(ViewHolder holder) Prepares the View for Remove Animation.
void	runPendingAnimations()
void	setInterpolator(android.view.animation.Interpolator mInterpolator)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mInterpolator

protected android.view.animation.Interpolator mInterpolator

Constructor Detail

FlexibleItemAnimator

public FlexibleItemAnimator()

Method Detail

setInterpolator

public void setInterpolator(android.view.animation.Interpolator mInterpolator)

runPendingAnimations

public final void runPendingAnimations()

preAnimateRemoveImpl

protected boolean preAnimateRemoveImpl(ViewHolder holder)

Prepares the View for Remove Animation.

- If AnimatedViewHolder#preAnimateRemoveImpl() is implemented and returns true, then ViewHolder has precedence and the implementation of this method is ignored;
- If not, the implementation of this method is therefore performed.

Default value is true.

Parameters:

holder - the ViewHolder

Returns:

true if a later call to runPendingAnimations() is requested, false otherwise.

animateRemoveImpl

protected void animateRemoveImpl(ViewHolder holder,
                                 int index)

Performs the Remove Animation of this ViewHolder.

- If AnimatedViewHolder#animateRemoveImpl(ViewPropertyAnimatorListener, long, int) is implemented and returns true, then ViewHolder has precedence and the implementation of this method is ignored;
- If not, the implementation of this method is therefore performed.

Parameters:

holder - the ViewHolder

index - the progressive order of execution

animateRemove

public final boolean animateRemove(ViewHolder holder)

preAnimateAddImpl

protected boolean preAnimateAddImpl(ViewHolder holder)

Prepares the View for Add Animation.

- If AnimatedViewHolder#preAnimateAddImpl() is implemented and returns true, then ViewHolder has precedence and the implementation of this method is ignored;
- If not, the implementation of this method is therefore performed.

Default value is true.

Parameters:

holder - the ViewHolder

Returns:

true if a later call to runPendingAnimations() is requested, false otherwise.

animateAddImpl

protected void animateAddImpl(ViewHolder holder,
                              int index)

Performs the Add Animation of this ViewHolder.

- If AnimatedViewHolder#animateAddImpl(ViewPropertyAnimatorListener, long, int) is implemented and returns true, then ViewHolder has precedence and the implementation of this method is ignored;
- If not, the implementation of this method is therefore performed.

Parameters:

holder - the ViewHolder

index - the progressive order of execution

animateAdd

public final boolean animateAdd(ViewHolder holder)

animateMove

public final boolean animateMove(ViewHolder holder,
                                 int fromX,
                                 int fromY,
                                 int toX,
                                 int toY)

animateChange

public boolean animateChange(ViewHolder oldHolder,
                             ViewHolder newHolder,
                             int fromX,
                             int fromY,
                             int toX,
                             int toY)

endAnimation

public void endAnimation(ViewHolder item)

isRunning

public boolean isRunning()

endAnimations

public void endAnimations()

canReuseUpdatedViewHolder

public boolean canReuseUpdatedViewHolder(ViewHolder viewHolder,
                                         java.util.List<java.lang.Object> payloads)

If the payload list is not empty, DefaultItemAnimator returns true. When this is the case:

• If you override animateChange(), both ViewHolder arguments will be the same instance.
• If you are not overriding animateChange(), then DefaultItemAnimator will call animateMove() and run a move animation instead.