universum.studios.android.recycler.helper

Interface ItemSwipeHelper.OnSwipeListener

Enclosing class:

ItemSwipeHelper

public static interface ItemSwipeHelper.OnSwipeListener

Listener which may be used to receive callbacks about started, finished or canceled swipe gesture for a specific RecyclerView.ViewHolder instance.

Since:

1.0

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
void	onSwipeCanceled(ItemSwipeHelper swipeHelper, RecyclerView.ViewHolder viewHolder) Invoked whenever swipe gesture is canceled for the given viewHolder.
void	onSwipeFinished(ItemSwipeHelper swipeHelper, RecyclerView.ViewHolder viewHolder, int direction) Invoked whenever swipe gesture is finished for the given viewHolder.
void	onSwipeStarted(ItemSwipeHelper swipeHelper, RecyclerView.ViewHolder viewHolder) Invoked whenever swipe gesture is started for the given viewHolder.

Method Detail

onSwipeStarted

void onSwipeStarted(@NonNull
                    ItemSwipeHelper swipeHelper,
                    @NonNull
                    RecyclerView.ViewHolder viewHolder)

Invoked whenever swipe gesture is started for the given viewHolder.

Parameters:

swipeHelper - The item helper controlling the swipe gesture for the view holder.

viewHolder - The view holder for which has been the swipe gesture started.

See Also:

onSwipeFinished(ItemSwipeHelper, RecyclerView.ViewHolder, int)

onSwipeFinished

void onSwipeFinished(@NonNull
                     ItemSwipeHelper swipeHelper,
                     @NonNull
                     RecyclerView.ViewHolder viewHolder,
                     int direction)

Invoked whenever swipe gesture is finished for the given viewHolder.

Parameters:

swipeHelper - The item helper controlling the swipe gesture for the view holder.

viewHolder - The view holder for which has been the swipe gesture finished.

direction - The direction in which has been the swipe gesture finished. One of directions defined by @Direction annotation.

See Also:

onSwipeStarted(ItemSwipeHelper, RecyclerView.ViewHolder)

onSwipeCanceled

void onSwipeCanceled(@NonNull
                     ItemSwipeHelper swipeHelper,
                     @NonNull
                     RecyclerView.ViewHolder viewHolder)

Invoked whenever swipe gesture is canceled for the given viewHolder.

Parameters:

swipeHelper - The item helper controlling the swipe gesture for the view holder.

viewHolder - The view holder for which has been the swipe gesture canceled.