eu.davidea.viewholders

Interface AnimatedViewHolder

public interface AnimatedViewHolder

Interface for itemView addition/removal animation.

Used by FlexibleItemAnimator when notify events occur. If any of these methods are implemented, the ItemAnimator extending FlexibleItemAnimator is skipped in favour of this ViewHolder implementation.

Since:

26/08/2016 Created

Method Summary

Modifier and Type	Method and Description
boolean	animateAddImpl(ViewPropertyAnimatorListener listener, long addDuration, int index) Animates this ViewHolder with this specific Add Animation.
boolean	animateRemoveImpl(ViewPropertyAnimatorListener listener, long removeDuration, int index) Animates this ViewHolder with this specific Remove Animation.
boolean	preAnimateAddImpl() Prepares the View for Add Animation.
boolean	preAnimateRemoveImpl() Prepares the View for Remove Animation.

Method Detail

preAnimateAddImpl

boolean preAnimateAddImpl()

Prepares the View for Add Animation. If this method is implemented and returns true, then this method is performed against FlexibleItemAnimator#preAnimateAddImpl(RecyclerView.ViewHolder) which will be ignored.

Default value is false.

Returns:

true to confirm the execution of animateAddImpl(ViewPropertyAnimatorListener, long, int), of this class, false to use generic animation for all types of View.

Since:

5.0.0-b8

preAnimateRemoveImpl

boolean preAnimateRemoveImpl()

Prepares the View for Remove Animation. If this method is implemented and returns true, then this method is performed against FlexibleItemAnimator#preAnimateRemoveImpl(RecyclerView.ViewHolder) which will be ignored.

Default value is false.

Returns:

true to confirm the execution of animateRemoveImpl(ViewPropertyAnimatorListener, long, int), of this class, false to use generic animation for all types of View.

Since:

5.0.0-b8

animateAddImpl

boolean animateAddImpl(ViewPropertyAnimatorListener listener,
                       long addDuration,
                       int index)

Animates this ViewHolder with this specific Add Animation.

By returning true this ViewHolder will perform customized animation, while by returning false generic animation is applied also for this ViewHolder.

Parameters:

listener - should assign to ViewCompat.animate().setListener(listener)

addDuration - duration of add animation

index - order of execution, starts with 0

Returns:

true to animate with this implementation, false to use the generic animation.

Since:

5.0.0-b8

animateRemoveImpl

boolean animateRemoveImpl(ViewPropertyAnimatorListener listener,
                          long removeDuration,
                          int index)

Animates this ViewHolder with this specific Remove Animation.

By returning true this ViewHolder will perform customized animation, while by returning false generic animation is applied also for this ViewHolder.

Parameters:

listener - should assign to ViewCompat.animate().setListener(listener)

removeDuration - duration of remove animation

index - order of execution, starts with 0 @return true to animate with this implementation, false to use the generic animation.

Since:

5.0.0-b8