universum.studios.android.recycler.helper

Class ItemSwipeHelper.Interactor

java.lang.Object

androidx.recyclerview.widget.ItemTouchHelper.Callback

universum.studios.android.recycler.helper.RecyclerViewItemHelper.ItemInteractor

universum.studios.android.recycler.helper.ItemSwipeHelper.Interactor

Enclosing class:

ItemSwipeHelper

public static final class ItemSwipeHelper.Interactor
extends RecyclerViewItemHelper.ItemInteractor

A ItemInteractor implementation used by ItemSwipeHelper to handle swipe gesture related callbacks and to delegate swipe events to the view holder that is being swiped.

Since:

1.0

Author:

Martin Albedinsky

Field Summary

Fields inherited from class androidx.recyclerview.widget.ItemTouchHelper.Callback

DEFAULT_DRAG_ANIMATION_DURATION, DEFAULT_SWIPE_ANIMATION_DURATION

Method Summary

Modifier and Type	Method and Description
void	addOnSwipeListener(ItemSwipeHelper.OnSwipeListener listener) Registers a callback to be invoked whenever swipe gesture is started, finished or canceled for a specific RecyclerView.ViewHolder instance.
protected boolean	canAttachAdapter(androidx.recyclerview.widget.RecyclerView.Adapter adapter) Called by the parent helper to check if the given adapter may be attached to this interactor instance.
void	clearView(androidx.recyclerview.widget.RecyclerView recyclerView, androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder)
int	getMovementFlags(androidx.recyclerview.widget.RecyclerView recyclerView, androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder)
float	getSwipeThreshold() Returns the fraction that the user should move the holder's View to be considered as swiped.
float	getSwipeThreshold(androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder)
boolean	isActive() Returns boolean flag indicating whether this interactor is currently active.
boolean	isItemViewSwipeEnabled()
protected void	onAdapterAttached(androidx.recyclerview.widget.RecyclerView.Adapter adapter) Invoked whenever a new adapter is attached to this interactor instance.
protected void	onAdapterDetached(androidx.recyclerview.widget.RecyclerView.Adapter adapter) Invoked before a new adapter is attached to this interactor instance if there is already previous adapter attached.
boolean	onMove(androidx.recyclerview.widget.RecyclerView recyclerView, androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder, androidx.recyclerview.widget.RecyclerView.ViewHolder target)
void	onSelectedChanged(androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder, int actionState)
void	onSwiped(androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder, int direction)
void	removeOnSwipeListener(ItemSwipeHelper.OnSwipeListener listener) Removes the given swipe listener from the registered listeners.
void	setEnabled(boolean enabled) Sets a boolean flag indicating whether this interactor should be enabled or not.
void	setItemViewSwipeEnabled(boolean enabled) Sets a boolean flag indicating whether the swipe should be started whenever an active pointer is swiped over an item view or not.
void	setSwipeThreshold(float threshold) Sets a fraction that the user should move the holder's View to be considered as swiped.
protected boolean	shouldHandleInteraction(androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder) Checks whether this interactor should handle interaction for the specified viewHolder due to received callback from the parent helper.

Methods inherited from class universum.studios.android.recycler.helper.RecyclerViewItemHelper.ItemInteractor

isEnabled, onAttachedToHelper, onChildDraw, onChildDrawOver, shouldHandleInteraction

Methods inherited from class androidx.recyclerview.widget.ItemTouchHelper.Callback

canDropOver, chooseDropTarget, convertToAbsoluteDirection, convertToRelativeDirection, getAnimationDuration, getBoundingBoxMargin, getDefaultUIUtil, getMoveThreshold, getSwipeEscapeVelocity, getSwipeVelocityThreshold, interpolateOutOfBoundsScroll, isLongPressDragEnabled, makeFlag, makeMovementFlags, onMoved

Methods inherited from class java.lang.Object

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

Method Detail

setItemViewSwipeEnabled

public void setItemViewSwipeEnabled(boolean enabled)

Sets a boolean flag indicating whether the swipe should be started whenever an active pointer is swiped over an item view or not.

If disabled, a swipe for a particular view holder needs to be started via ItemTouchHelper.startSwipe(RecyclerView.ViewHolder) manually.

Default value: true

Parameters:

enabled - True to enable automatic swipe, false to disable it.

See Also:

isItemViewSwipeEnabled()

isItemViewSwipeEnabled

public boolean isItemViewSwipeEnabled()

Overrides:

isItemViewSwipeEnabled in class androidx.recyclerview.widget.ItemTouchHelper.Callback

setSwipeThreshold

public void setSwipeThreshold(float threshold)

Sets a fraction that the user should move the holder's View to be considered as swiped.

Default value: ItemSwipeHelper.SWIPE_THRESHOLD

Parameters:

threshold - The desired threshold from the range [0.0, 1.0].

See Also:

getSwipeThreshold(), ItemSwipeHelper.Callback#getSwipeThreshold(RecyclerView.ViewHolder)

getSwipeThreshold

public float getSwipeThreshold()

Returns the fraction that the user should move the holder's View to be considered as swiped.

Returns:

The swipe threshold from the range [0.0, 1.0].

See Also:

setSwipeThreshold(float)

getSwipeThreshold

public float getSwipeThreshold(@NonNull
                               androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder)

Overrides:

getSwipeThreshold in class androidx.recyclerview.widget.ItemTouchHelper.Callback

addOnSwipeListener

public void addOnSwipeListener(@NonNull
                               ItemSwipeHelper.OnSwipeListener listener)

Registers a callback to be invoked whenever swipe gesture is started, finished or canceled for a specific RecyclerView.ViewHolder instance.

Parameters:

listener - The desired listener callback to add.

See Also:

#removeOnSwipeListener(OnSwipeListener)

removeOnSwipeListener

public void removeOnSwipeListener(@NonNull
                                  ItemSwipeHelper.OnSwipeListener listener)

Removes the given swipe listener from the registered listeners.

Parameters:

listener - The desired listener to remove.

See Also:

#addOnSwipeListener(OnSwipeListener)

canAttachAdapter

protected boolean canAttachAdapter(@NonNull
                                   androidx.recyclerview.widget.RecyclerView.Adapter adapter)

Description copied from class: RecyclerViewItemHelper.ItemInteractor

Called by the parent helper to check if the given adapter may be attached to this interactor instance.

If this method returns true, RecyclerViewItemHelper.ItemInteractor.onAdapterAttached(RecyclerView.Adapter) will follow. If this interactor has attached any previous adapter, such adapter will be detached via RecyclerViewItemHelper.ItemInteractor.onAdapterDetached(RecyclerView.Adapter) before the new one is attached.

Specified by:

canAttachAdapter in class RecyclerViewItemHelper.ItemInteractor

Parameters:

adapter - The adapter to be checked if it may be attached.

Returns:

True if the parent helper may attach the adapter to this interactor, false otherwise.

onAdapterAttached

protected void onAdapterAttached(@NonNull
                                 androidx.recyclerview.widget.RecyclerView.Adapter adapter)

Description copied from class: RecyclerViewItemHelper.ItemInteractor

Invoked whenever a new adapter is attached to this interactor instance.

This method is called as result of call to RecyclerViewItemHelper.attachToRecyclerView(RecyclerView) for the parent helper.

Overrides:

onAdapterAttached in class RecyclerViewItemHelper.ItemInteractor

Parameters:

adapter - The adapter of the associated RecyclerView to which is the parent helper attached.

See Also:

RecyclerViewItemHelper.ItemInteractor.onAdapterDetached(RecyclerView.Adapter)

onAdapterDetached

protected void onAdapterDetached(@NonNull
                                 androidx.recyclerview.widget.RecyclerView.Adapter adapter)

Description copied from class: RecyclerViewItemHelper.ItemInteractor

Invoked before a new adapter is attached to this interactor instance if there is already previous adapter attached.

Overrides:

onAdapterDetached in class RecyclerViewItemHelper.ItemInteractor

Parameters:

adapter - The previous adapter that has been detached from this interactor.

See Also:

RecyclerViewItemHelper.ItemInteractor.onAdapterAttached(RecyclerView.Adapter)

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: RecyclerViewItemHelper.ItemInteractor

Sets a boolean flag indicating whether this interactor should be enabled or not.

Overrides:

setEnabled in class RecyclerViewItemHelper.ItemInteractor

Parameters:

enabled - True to enable this interactor, false otherwise.

See Also:

RecyclerViewItemHelper.ItemInteractor.isEnabled()

isActive

public boolean isActive()

Description copied from class: RecyclerViewItemHelper.ItemInteractor

Returns boolean flag indicating whether this interactor is currently active.

Specified by:

isActive in class RecyclerViewItemHelper.ItemInteractor

Returns:

True if this interactor performs some interaction logic at this time, false otherwise.

getMovementFlags

public int getMovementFlags(@NonNull
                            androidx.recyclerview.widget.RecyclerView recyclerView,
                            @NonNull
                            androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder)

Specified by:

getMovementFlags in class androidx.recyclerview.widget.ItemTouchHelper.Callback

onSelectedChanged

public void onSelectedChanged(@Nullable
                              androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder,
                              int actionState)

Overrides:

onSelectedChanged in class androidx.recyclerview.widget.ItemTouchHelper.Callback

onMove

public boolean onMove(@NonNull
                      androidx.recyclerview.widget.RecyclerView recyclerView,
                      @NonNull
                      androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder,
                      @NonNull
                      androidx.recyclerview.widget.RecyclerView.ViewHolder target)

Specified by:

onMove in class androidx.recyclerview.widget.ItemTouchHelper.Callback

onSwiped

public void onSwiped(@NonNull
                     androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder,
                     int direction)

Specified by:

onSwiped in class androidx.recyclerview.widget.ItemTouchHelper.Callback

clearView

public void clearView(@NonNull
                      androidx.recyclerview.widget.RecyclerView recyclerView,
                      @NonNull
                      androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder)

Overrides:

clearView in class androidx.recyclerview.widget.ItemTouchHelper.Callback

shouldHandleInteraction

protected boolean shouldHandleInteraction(@Nullable
                                          androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder)

Description copied from class: RecyclerViewItemHelper.ItemInteractor

Checks whether this interactor should handle interaction for the specified viewHolder due to received callback from the parent helper.

This implementation only extends RecyclerViewItemHelper.ItemInteractor.shouldHandleInteraction() in a way that the view holder is checked if it is not null and has valid adapter position. Inheritance hierarchies are allowed to override this behaviour as desired.

Overrides:

shouldHandleInteraction in class RecyclerViewItemHelper.ItemInteractor

Parameters:

viewHolder - The desired view holder to be checked.

Returns:

True if RecyclerViewItemHelper.ItemInteractor.shouldHandleInteraction() returns true, view holder is not null and has valid (not RecyclerView.NO_POSITION) adapter position, false otherwise.