com.globusltd.recyclerview.view

Class ChoiceModeHelper<E>

java.lang.Object

com.globusltd.recyclerview.RecyclerViewOwner

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

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

@MainThread
public class ChoiceModeHelper<E>
extends ItemClickHelper<E>

This is an utility class to add choice mode support to RecyclerView.

Nested Class Summary

Nested classes/interfaces inherited from class com.globusltd.recyclerview.view.ItemClickHelper

ItemClickHelper.Callback<E>

Constructor Summary

Constructors

Constructor and Description
ChoiceModeHelper(ItemClickHelper.Callback<E> callback)
ChoiceModeHelper(ItemClickHelper.Callback<E> callback, ChoiceMode choiceMode)

Method Summary

Modifier and Type	Method and Description
protected boolean	isLongPressEnabled()
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	setChoiceMode(ChoiceMode choiceMode) Sets a ChoiceMode implementation to handle selected items.

Methods inherited from class com.globusltd.recyclerview.view.ItemClickHelper

notifyLongpressEnabledChanged, setOnItemClickListener, setOnItemLongClickListener

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

ChoiceModeHelper

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

ChoiceModeHelper

public ChoiceModeHelper(@NonNull
                        ItemClickHelper.Callback<E> callback,
                        @NonNull
                        ChoiceMode choiceMode)

Method Detail

setChoiceMode

public void setChoiceMode(@NonNull
                          ChoiceMode choiceMode)

Sets a ChoiceMode implementation to handle selected items.

Parameters:

choiceMode - ChoiceMode implementation.

onAttachedToRecyclerView

protected void onAttachedToRecyclerView(@NonNull
                                        RecyclerView recyclerView)

Called by RecyclerViewOwner when RecyclerView is attached.

Overrides:

onAttachedToRecyclerView in class ItemClickHelper<E>

Parameters:

recyclerView - The RecyclerView instance.

See Also:

RecyclerViewOwner.onDetachedFromRecyclerView(RecyclerView)

onDetachedFromRecyclerView

protected void onDetachedFromRecyclerView(@NonNull
                                          RecyclerView recyclerView)

Called by RecyclerViewOwner when RecyclerView is detached.

Overrides:

onDetachedFromRecyclerView in class ItemClickHelper<E>

Parameters:

recyclerView - The RecyclerView instance.

See Also:

RecyclerViewOwner.onAttachedToRecyclerView(RecyclerView)

isLongPressEnabled

protected boolean isLongPressEnabled()

Overrides:

isLongPressEnabled in class ItemClickHelper<E>

Returns:

true if longpress is enabled, else false.

performClick

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

Overrides:

performClick in class ItemClickHelper<E>

performLongPress

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

Overrides:

performLongPress in class ItemClickHelper<E>