eu.davidea.flexibleadapter

Class AnimatorAdapter

java.lang.Object

RecyclerView.Adapter

eu.davidea.flexibleadapter.SelectableAdapter

eu.davidea.flexibleadapter.AnimatorAdapter

All Implemented Interfaces:

FastScroller.AdapterInterface, FastScroller.BubbleTextCreator, FastScroller.OnScrollStateChangeListener

Direct Known Subclasses:

FlexibleAdapter

public abstract class AnimatorAdapter
extends SelectableAdapter

This class is responsible to animate items. Bounded items are animated initially and also when user starts to scroll the list.

Animations can be customized for each items applying different logic based on item position and beyond.

This class is extended by FlexibleAdapter.

Since:

10/01/2016 Created
30/01/2016 Class now extends SelectableAdapter
13/09/2016 animateView(RecyclerView.ViewHolder, int) is now automatically called
07/12/2017 Reverse scrolling is independent from Forward scrolling

See Also:

FlexibleAdapter, SelectableAdapter

Nested Class Summary

Nested classes/interfaces inherited from class eu.davidea.flexibleadapter.SelectableAdapter

SelectableAdapter.Mode

Field Summary

Fields inherited from class eu.davidea.flexibleadapter.SelectableAdapter

isFastScroll, mFastScrollerDelegate, mLastItemInActionMode, mRecyclerView, mSelectAll

Method Summary

Modifier and Type	Method and Description
protected void	animateView(RecyclerView.ViewHolder holder, int position) Performs checks to scroll animate the itemView and in case, it animates the view.
boolean	isAnimationOnForwardScrollingEnabled()
boolean	isAnimationOnReverseScrollingEnabled()
boolean	isOnlyEntryAnimation()
abstract boolean	isScrollableHeaderOrFooter(int position) Checks if at the provided position, the item is a Header or Footer.
AnimatorAdapter	setAnimationDelay(long delay) Sets the step delay between an animation and the next to be added to the initial delay.
AnimatorAdapter	setAnimationDuration(long duration) Sets the duration of the animation for ALL items.
AnimatorAdapter	setAnimationEntryStep(boolean entryStep) If initial loading animation should use step delay between an item animation and the next.
AnimatorAdapter	setAnimationInitialDelay(long initialDelay) Sets the initial delay for the first item animation.
AnimatorAdapter	setAnimationInterpolator(android.view.animation.Interpolator interpolator) Sets a custom interpolator for ALL items.
AnimatorAdapter	setAnimationOnForwardScrolling(boolean enabled) Enables/Disables item animation while forward scrolling and on loading.
AnimatorAdapter	setAnimationOnReverseScrolling(boolean enabled) Enables/Disables reverse scrolling animation.
AnimatorAdapter	setOnlyEntryAnimation(boolean enabled) Performs only entry animation during the initial loading.

Methods inherited from class eu.davidea.flexibleadapter.SelectableAdapter

addSelection, clearSelection, enableLogs, getAllBoundViewHolders, getFastScroller, getFlexibleLayoutManager, getMode, getRecyclerView, getSelectedItemCount, getSelectedPositions, getSelectedPositionsAsSet, isFastScrollerEnabled, isLastItemInActionMode, isSelectable, isSelectAll, isSelected, onAttachedToRecyclerView, onBindViewHolder, onCreateBubbleText, onDetachedFromRecyclerView, onFastScrollerStateChange, onRestoreInstanceState, onSaveInstanceState, onViewRecycled, removeSelection, selectAll, setFastScroller, setFlexibleLayoutManager, setMode, swapSelection, toggleFastScroller, toggleSelection, useTag

Methods inherited from class java.lang.Object

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

Method Detail

setAnimationInitialDelay

public AnimatorAdapter setAnimationInitialDelay(long initialDelay)

Sets the initial delay for the first item animation.

Default value is 0ms.

Parameters:

initialDelay - any non negative delay

Returns:

this AnimatorAdapter, so the call can be chained

Since:

5.0.0-b1

setAnimationDelay

public AnimatorAdapter setAnimationDelay(long delay)

Sets the step delay between an animation and the next to be added to the initial delay.

The delay is added on top of the previous delay.

Default value is 100ms.

Parameters:

delay - any positive delay

Returns:

this AnimatorAdapter, so the call can be chained

Since:

5.0.0-b1

setAnimationEntryStep

public AnimatorAdapter setAnimationEntryStep(boolean entryStep)

If initial loading animation should use step delay between an item animation and the next. When false, all items are animated with no delay.

Better to disable when using Grid layouts.

Default value is true.

Parameters:

entryStep - true to enable step delay, false otherwise

Returns:

this AnimatorAdapter, so the call can be chained since 5.0.0-b8

setAnimationDuration

public AnimatorAdapter setAnimationDuration(long duration)

Sets the duration of the animation for ALL items.

Default value is 300ms.

Parameters:

duration - any positive time

Returns:

this AnimatorAdapter, so the call can be chained

Since:

5.0.0-b1

setAnimationInterpolator

public AnimatorAdapter setAnimationInterpolator(android.view.animation.Interpolator interpolator)

Sets a custom interpolator for ALL items.

Default value is LinearInterpolator.

Parameters:

interpolator - any valid non null interpolator

Returns:

this AnimatorAdapter, so the call can be chained

setAnimationOnForwardScrolling

public AnimatorAdapter setAnimationOnForwardScrolling(boolean enabled)

Enables/Disables item animation while forward scrolling and on loading.
Enabling forward scrolling will disable onlyEntryAnimation.
Forward scrolling is independent from reverse scrolling.

Default value is false.

Note: Loading animation can only be performed if the Adapter is initialized with some items using the constructor.

Parameters:

enabled - true to enable item animation on forward scrolling, false to disable.

Returns:

this AnimatorAdapter, so the call can be chained

Since:

5.0.0-b1

See Also:

setOnlyEntryAnimation(boolean), setAnimationOnReverseScrolling(boolean)

isAnimationOnForwardScrollingEnabled

public boolean isAnimationOnForwardScrollingEnabled()

Returns:

true if items are animated when forward scrolling, false only forward

Since:

5.0.0-b1

setAnimationOnReverseScrolling

public AnimatorAdapter setAnimationOnReverseScrolling(boolean enabled)

Enables/Disables reverse scrolling animation.
Reverse scrolling is independent from forward scrolling.

Default value is false (only forward).

Parameters:

enabled - true to enable item animation on reverse scrolling, false to disable.

Returns:

this AnimatorAdapter, so the call can be chained

Since:

5.0.0-b1

See Also:

setOnlyEntryAnimation(boolean), setAnimationOnForwardScrolling(boolean)

isAnimationOnReverseScrollingEnabled

public boolean isAnimationOnReverseScrollingEnabled()

Returns:

true if items are animated when reverse scrolling, false only forward

Since:

5.0.0-b1

setOnlyEntryAnimation

public AnimatorAdapter setOnlyEntryAnimation(boolean enabled)

Performs only entry animation during the initial loading. Stops the animation after the last visible item in the RecyclerView has been animated.

Note: Loading animation can only be performed if the Adapter is initialized with some items using the Constructor.

Default value is false.

Parameters:

enabled - true to perform only entry animation, false otherwise

Returns:

this AnimatorAdapter, so the call can be chained

Since:

5.0.0-b8

See Also:

setAnimationOnForwardScrolling(boolean)

isOnlyEntryAnimation

public boolean isOnlyEntryAnimation()

Returns:

true if the scrolling animation will occur only at startup until the screen is filled with the items, false animation will be performed when scrolling too.

Since:

5.0.0-b8

isScrollableHeaderOrFooter

public abstract boolean isScrollableHeaderOrFooter(int position)

Checks if at the provided position, the item is a Header or Footer.

Parameters:

position - the position to check

Returns:

true if it's a scrollable item

Since:

5.0.0-rc1

animateView

protected final void animateView(RecyclerView.ViewHolder holder,
                                 int position)

Performs checks to scroll animate the itemView and in case, it animates the view.

Note: If you have to change at runtime the LayoutManager and add Scrollable Headers too, consider to add them in post, using a delay >= 0, otherwise scroll animations on all items will not start correctly.

Parameters:

holder - the ViewHolder just bound

position - the current item position

Since:

5.0.0-b1