com.globusltd.recyclerview.choice

Interface ChoiceMode

All Known Implementing Classes:

MultipleChoiceMode, MultipleModalChoiceMode, NoneChoiceMode, ObservableChoiceMode, SingleChoiceMode, SingleModalChoiceMode

@MainThread
public interface ChoiceMode

Interface describes choice mode.

Method Summary

Modifier and Type	Method and Description
void	clearChoices() Clears any checked items.
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	registerChoiceModeObserver(ChoiceModeObserver observer) Register a new observer to listen for selection changes.
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	setItemChecked(long itemId, boolean checked) Sets the checked state of the specified position.
void	unregisterChoiceModeObserver(ChoiceModeObserver observer) Unregister an observer currently listening for selection changes.

Method Detail

requiresStableIds

boolean requiresStableIds()

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

Returns:

whether stable item ids should be required.

requiresLongpress

boolean requiresLongpress()

Returns whether long press is required by this choice mode.

Returns:

whether long press should be required.

isActivated

boolean isActivated()

Returns true if choice mode is active.

getCheckedItemCount

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

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

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.

clearChoices

void clearChoices()

Clears any checked items.

onClick

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

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.

registerChoiceModeObserver

void registerChoiceModeObserver(@NonNull
                                ChoiceModeObserver observer)

Register a new observer to listen for selection changes.

The choice mode may publish a variety of events describing selection changes.

Components registering observers with a choice mode are responsible for unregisterChoiceModeObserver(ChoiceModeObserver) unregistering} those observers when finished.

Parameters:

observer - Observer to register.

See Also:

unregisterChoiceModeObserver(ChoiceModeObserver)

unregisterChoiceModeObserver

void unregisterChoiceModeObserver(@NonNull
                                  ChoiceModeObserver observer)

Unregister an observer currently listening for selection changes.

The unregistered observer will no longer receive events about changes to the choice mode.

Parameters:

observer - Observer to unregister.

See Also:

registerChoiceModeObserver(ChoiceModeObserver)