universum.studios.android.recycler.helper

Class RecyclerViewItemHelper.ItemInteractor

java.lang.Object

androidx.recyclerview.widget.ItemTouchHelper.Callback

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

Direct Known Subclasses:

ItemDragHelper.Interactor, ItemSwipeHelper.Interactor

Enclosing class:

RecyclerViewItemHelper<I extends RecyclerViewItemHelper.ItemInteractor>

public abstract static class RecyclerViewItemHelper.ItemInteractor
extends androidx.recyclerview.widget.ItemTouchHelper.Callback

A ItemTouchHelper.Callback implementation which should be used as base class for all interactors used by RecyclerViewItemHelper implementations.

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

Constructor Summary

Constructors

Constructor and Description
ItemInteractor()

Method Summary

Modifier and Type	Method and Description
protected abstract 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.
abstract boolean	isActive() Returns boolean flag indicating whether this interactor is currently active.
boolean	isEnabled() Returns boolean flag indicating whether this interactor is enabled or not.
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.
protected void	onAttachedToHelper(RecyclerViewItemHelper helper) Invoked whenever attachToHelper(RecyclerViewItemHelper) is called for this interactor instance.
void	onChildDraw(android.graphics.Canvas canvas, androidx.recyclerview.widget.RecyclerView recyclerView, androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive)
void	onChildDrawOver(android.graphics.Canvas canvas, androidx.recyclerview.widget.RecyclerView recyclerView, androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive)
void	setEnabled(boolean enabled) Sets a boolean flag indicating whether this interactor should be enabled or not.
protected boolean	shouldHandleInteraction() Checks whether this interactor should handle interaction due to received callback from the parent helper.
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 androidx.recyclerview.widget.ItemTouchHelper.Callback

canDropOver, chooseDropTarget, clearView, convertToAbsoluteDirection, convertToRelativeDirection, getAnimationDuration, getBoundingBoxMargin, getDefaultUIUtil, getMovementFlags, getMoveThreshold, getSwipeEscapeVelocity, getSwipeThreshold, getSwipeVelocityThreshold, interpolateOutOfBoundsScroll, isItemViewSwipeEnabled, isLongPressDragEnabled, makeFlag, makeMovementFlags, onMove, onMoved, onSelectedChanged, onSwiped

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemInteractor

public ItemInteractor()

Method Detail

onAttachedToHelper

protected void onAttachedToHelper(@NonNull
                                  RecyclerViewItemHelper helper)

Invoked whenever attachToHelper(RecyclerViewItemHelper) is called for this interactor instance.

Parameters:

helper - The helper that will use this interactor to support its specific feature.

canAttachAdapter

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

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

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

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)

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.

Parameters:

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

See Also:

onAdapterDetached(RecyclerView.Adapter)

onAdapterDetached

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

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

Parameters:

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

See Also:

onAdapterAttached(RecyclerView.Adapter)

setEnabled

public void setEnabled(boolean enabled)

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

Parameters:

enabled - True to enable this interactor, false otherwise.

See Also:

isEnabled()

isEnabled

public boolean isEnabled()

Returns boolean flag indicating whether this interactor is enabled or not.

Returns:

True if this interactor is enabled, false otherwise.

See Also:

setEnabled(boolean)

isActive

public abstract boolean isActive()

Returns boolean flag indicating whether this interactor is currently active.

Returns:

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

shouldHandleInteraction

protected boolean shouldHandleInteraction(@Nullable
                                          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.

This implementation only extends 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.

Parameters:

viewHolder - The desired view holder to be checked.

Returns:

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

shouldHandleInteraction

protected boolean shouldHandleInteraction()

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

This implementation checks whether this interactor instance is enabled at this time and also has valid adapter attached. However inheritance hierarchies are allowed to override this behaviour as desired.

Returns:

True if interaction should be handled, false otherwise.

onChildDraw

public void onChildDraw(@NonNull
                        android.graphics.Canvas canvas,
                        @NonNull
                        androidx.recyclerview.widget.RecyclerView recyclerView,
                        @NonNull
                        androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder,
                        float dX,
                        float dY,
                        int actionState,
                        boolean isCurrentlyActive)

Overrides:

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

onChildDrawOver

public void onChildDrawOver(@NonNull
                            android.graphics.Canvas canvas,
                            @NonNull
                            androidx.recyclerview.widget.RecyclerView recyclerView,
                            @NonNull
                            androidx.recyclerview.widget.RecyclerView.ViewHolder viewHolder,
                            float dX,
                            float dY,
                            int actionState,
                            boolean isCurrentlyActive)

Overrides:

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