com.globusltd.recyclerview.view

Class ItemClickHelper<E>

java.lang.Object

com.globusltd.recyclerview.RecyclerViewOwner

com.globusltd.recyclerview.view.ItemClickHelper<E>

Direct Known Subclasses:

ChoiceModeHelper

@MainThread
public class ItemClickHelper<E>
extends RecyclerViewOwner

This is an utility class to add item click and item long click support to RecyclerView.

It works with a RecyclerView and a Callback class, which configures what type of interactions are enabled. In most situations it's better to make your adapter as Callback implementation.

Depending on which functionality you need, you should provide OnItemClickListener and / or OnItemLongClickListener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ItemClickHelper.Callback<E> This interface is the contract between ItemClickHelper and your application.

Constructor Summary

Constructors

Constructor and Description
ItemClickHelper(ItemClickHelper.Callback<E> callback)

Method Summary

Modifier and Type	Method and Description
protected boolean	isLongPressEnabled()
protected void	notifyLongpressEnabledChanged() Notify ItemClickHelper that long press enabled state has changed.
protected void	onAttachedToRecyclerView(RecyclerView recyclerView) Called by RecyclerViewOwner when RecyclerView is attached.
protected void	onDetachedFromRecyclerView(RecyclerView recyclerView) Called by RecyclerViewOwner when RecyclerView is detached.
protected boolean	performClick(RecyclerView.ViewHolder viewHolder, View view)
protected boolean	performLongPress(RecyclerView.ViewHolder viewHolder, View view)
void	setOnItemClickListener(OnItemClickListener<E> onItemClickListener) Register a callback to be invoked when view is clicked.
void	setOnItemLongClickListener(OnItemLongClickListener<E> onItemLongClickListener) Register a callback to be invoked when view is long clicked.

Methods inherited from class com.globusltd.recyclerview.RecyclerViewOwner

getRecyclerView, setRecyclerView

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemClickHelper

public ItemClickHelper(@NonNull
                       ItemClickHelper.Callback<E> callback)

Method Detail

setOnItemClickListener

public void setOnItemClickListener(@Nullable
                                   OnItemClickListener<E> onItemClickListener)

Register a callback to be invoked when view is clicked.

Parameters:

onItemClickListener - The callback that will run.

setOnItemLongClickListener

public void setOnItemLongClickListener(@Nullable
                                       OnItemLongClickListener<E> onItemLongClickListener)

Register a callback to be invoked when view is long clicked.

Parameters:

onItemLongClickListener - The callback that will run.

isLongPressEnabled

protected boolean isLongPressEnabled()

Returns:

true if longpress is enabled, else false.

notifyLongpressEnabledChanged

protected void notifyLongpressEnabledChanged()

Notify ItemClickHelper that long press enabled state has changed.

onAttachedToRecyclerView

@CallSuper
protected void onAttachedToRecyclerView(@NonNull
                                                    RecyclerView recyclerView)

Called by RecyclerViewOwner when RecyclerView is attached.

Specified by:

onAttachedToRecyclerView in class RecyclerViewOwner

Parameters:

recyclerView - The RecyclerView instance.

See Also:

RecyclerViewOwner.onDetachedFromRecyclerView(RecyclerView)

onDetachedFromRecyclerView

@CallSuper
protected void onDetachedFromRecyclerView(@NonNull
                                                      RecyclerView recyclerView)

Called by RecyclerViewOwner when RecyclerView is detached.

Specified by:

onDetachedFromRecyclerView in class RecyclerViewOwner

Parameters:

recyclerView - The RecyclerView instance.

See Also:

RecyclerViewOwner.onAttachedToRecyclerView(RecyclerView)

performClick

protected boolean performClick(@NonNull
                               RecyclerView.ViewHolder viewHolder,
                               @NonNull
                               View view)

performLongPress

protected boolean performLongPress(@NonNull
                                   RecyclerView.ViewHolder viewHolder,
                                   @NonNull
                                   View view)