universum.studios.android.recycler.helper

Class RecyclerViewItemHelper<I extends RecyclerViewItemHelper.ItemInteractor>

java.lang.Object

android.support.v7.widget.RecyclerView.ItemDecoration

android.support.v7.widget.helper.ItemTouchHelper

universum.studios.android.recycler.helper.RecyclerViewItemHelper<I>

Type Parameters:

I - Type of the item interactor that will be used by this helper.

All Implemented Interfaces:

RecyclerView.OnChildAttachStateChangeListener

Direct Known Subclasses:

ItemDragHelper, ItemSwipeHelper

public abstract class RecyclerViewItemHelper<I extends RecyclerViewItemHelper.ItemInteractor>
extends ItemTouchHelper

An ItemTouchHelper implementation that is used as base class by all item helpers from the Recycler library and is also encouraged to be used as base class by custom helper implementations.

Since:

1.0

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecyclerViewItemHelper.Direction Defines an annotation for determining supported directions by ItemTouchHelper API.
static interface	RecyclerViewItemHelper.Interaction Defines an annotation for determining available interaction states for ItemTouchHelper API.
static interface	RecyclerViewItemHelper.InteractiveViewHolder Required interface for ViewHolders with which may user interact via a concrete RecyclerViewItemHelper implementation.
static class	RecyclerViewItemHelper.ItemInteractor A ItemTouchHelper.Callback implementation which should be used as base class for all interactors used by RecyclerViewItemHelper implementations.
static interface	RecyclerViewItemHelper.Movement Defines an annotation for determining supported movement flags by ItemTouchHelper API.

Nested classes/interfaces inherited from class android.support.v7.widget.helper.ItemTouchHelper

ItemTouchHelper.Callback, ItemTouchHelper.SimpleCallback, ItemTouchHelper.ViewDropHandler

Field Summary

Fields inherited from class android.support.v7.widget.helper.ItemTouchHelper

ACTION_STATE_DRAG, ACTION_STATE_IDLE, ACTION_STATE_SWIPE, ANIMATION_TYPE_DRAG, ANIMATION_TYPE_SWIPE_CANCEL, ANIMATION_TYPE_SWIPE_SUCCESS, DOWN, END, LEFT, RIGHT, START, UP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecyclerViewItemHelper(I interactor) Creates a new instance of RecyclerViewItemHelper with the specified interactor.

Method Summary

Modifier and Type	Method and Description
void	attachToRecyclerView(RecyclerView recyclerView)
I	getInteractor() Returns the interactor instance used by this helper to support its specific feature for items of the RecyclerView to which is this helper instance attached.

Methods inherited from class android.support.v7.widget.helper.ItemTouchHelper

getItemOffsets, onChildViewAttachedToWindow, onChildViewDetachedFromWindow, onDraw, onDrawOver, startDrag, startSwipe

Methods inherited from class android.support.v7.widget.RecyclerView.ItemDecoration

getItemOffsets, onDraw, onDrawOver

Methods inherited from class java.lang.Object

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

Constructor Detail

RecyclerViewItemHelper

protected RecyclerViewItemHelper(@NonNull
                                 I interactor)

Creates a new instance of RecyclerViewItemHelper with the specified interactor.

Parameters:

interactor - The interactor that will be used by the new helper to support is specific feature.

Method Detail

getInteractor

@NonNull
public final I getInteractor()

Returns the interactor instance used by this helper to support its specific feature for items of the RecyclerView to which is this helper instance attached.

The returned interactor may be used to configure the provided feature.

Returns:

This helper's interactor.

attachToRecyclerView

public void attachToRecyclerView(@Nullable
                                 RecyclerView recyclerView)

Overrides:

attachToRecyclerView in class ItemTouchHelper