com.globusltd.recyclerview.choice

Class SingleChoiceMode

java.lang.Object

com.globusltd.recyclerview.choice.ObservableChoiceMode

com.globusltd.recyclerview.choice.SingleChoiceMode

All Implemented Interfaces:

ChoiceMode

@MainThread
public class SingleChoiceMode
extends ObservableChoiceMode

ChoiceMode that allows up to one choice.

Constructor Summary

Constructors

Constructor and Description
SingleChoiceMode()
SingleChoiceMode(Bundle savedInstanceState)

Method Summary

Modifier and Type	Method and Description
void	clearChoices() Clears any checked items.
long	getCheckedItem() Returns an identifier of checked item or RecyclerView#NO_ID if no item is checked.
int	getCheckedItemCount() Returns the number of items currently selected.
boolean	isActivated() Returns true if choice mode is active.
boolean	isItemChecked(long itemId) Returns the checked state of the specified position.
boolean	onClick(long itemId) Dispatches click on a specific item.
boolean	onLongClick(long itemId) Dispatches long click on a specific item.
void	onSaveInstanceState(Bundle outState) Call this method to retrieve per-instance state before UI component being killed so that the state can be restored via constructor.
boolean	requiresLongpress() Returns whether long press is required by this choice mode.
boolean	requiresStableIds() Returns whether stable item ids are required by this choice mode.
void	setChoiceModeListener(SimpleChoiceModeListener listener) Sets single choice mode callback.
void	setItemChecked(long itemId, boolean checked) Sets the checked state of the specified position.

Methods inherited from class com.globusltd.recyclerview.choice.ObservableChoiceMode

isAttached, notifyAllItemsCheckedChanged, notifyItemCheckedChanged, registerChoiceModeObserver, unregisterChoiceModeObserver

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleChoiceMode

public SingleChoiceMode()

SingleChoiceMode

public SingleChoiceMode(@Nullable
                        Bundle savedInstanceState)

Method Detail

setChoiceModeListener

public void setChoiceModeListener(@Nullable
                                  SimpleChoiceModeListener listener)

Sets single choice mode callback.

requiresStableIds

public boolean requiresStableIds()

Returns whether stable item ids are required by this choice mode.

Returns:

whether stable item ids should be required.

requiresLongpress

public boolean requiresLongpress()

Returns whether long press is required by this choice mode.

Returns:

whether long press should be required.

isActivated

public boolean isActivated()

Returns true if choice mode is active.

getCheckedItemCount

public int getCheckedItemCount()

Returns the number of items currently selected.

To determine the specific items that are currently selected, use one of the getChecked* methods.

Returns:

The number of items currently selected

isItemChecked

public boolean isItemChecked(long itemId)

Returns the checked state of the specified position.

Parameters:

itemId - The item whose checked state to return.

Returns:

The item's checked state or false.

setItemChecked

public void setItemChecked(long itemId,
                           boolean checked)

Sets the checked state of the specified position.

Parameters:

itemId - The item id whose checked state is to be checked.

checked - The new checked state for the item.

getCheckedItem

public long getCheckedItem()

Returns an identifier of checked item or RecyclerView#NO_ID if no item is checked.

clearChoices

public void clearChoices()

Clears any checked items.

onClick

public boolean onClick(long itemId)

Dispatches click on a specific item.

Parameters:

itemId - The item id which has been clicked.

Returns:

true if click is handled by choice mode.

onLongClick

public boolean onLongClick(long itemId)

Dispatches long click on a specific item.

Parameters:

itemId - The item id which has been clicked.

Returns:

true if click is handled by choice mode.

onSaveInstanceState

public void onSaveInstanceState(@NonNull
                                Bundle outState)

Call this method to retrieve per-instance state before UI component being killed so that the state can be restored via constructor.

Parameters:

outState - Bundle in which to place your saved state.