com.globusltd.recyclerview.choice

Class NoneChoiceMode

java.lang.Object

com.globusltd.recyclerview.choice.NoneChoiceMode

All Implemented Interfaces:

ChoiceMode

public final class NoneChoiceMode
extends Object
implements ChoiceMode

ChoiceMode that does not have any choice behavior. It is a default adapter's choice mode.

Constructor Summary

Constructors

Constructor and Description
NoneChoiceMode()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoneChoiceMode

public NoneChoiceMode()

Method Detail

requiresStableIds

public boolean requiresStableIds()

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

Specified by:

requiresStableIds in interface ChoiceMode

Returns:

whether stable item ids should be required.

requiresLongpress

public boolean requiresLongpress()

Returns whether long press is required by this choice mode.

Specified by:

requiresLongpress in interface ChoiceMode

Returns:

whether long press should be required.

isActivated

public boolean isActivated()

Returns true if choice mode is active.

Specified by:

isActivated in interface ChoiceMode

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.

Specified by:

getCheckedItemCount in interface ChoiceMode

Returns:

The number of items currently selected

isItemChecked

public boolean isItemChecked(long itemId)

Returns the checked state of the specified position.

Specified by:

isItemChecked in interface ChoiceMode

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.

Specified by:

setItemChecked in interface ChoiceMode

Parameters:

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

checked - The new checked state for the item.

clearChoices

public void clearChoices()

Clears any checked items.

Specified by:

clearChoices in interface ChoiceMode

onClick

public boolean onClick(long itemId)

Dispatches click on a specific item.

Specified by:

onClick in interface ChoiceMode

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.

Specified by:

onLongClick in interface ChoiceMode

Parameters:

itemId - The item id which has been clicked.

Returns:

true if click is handled by choice mode.

registerChoiceModeObserver

public 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 ChoiceMode.unregisterChoiceModeObserver(ChoiceModeObserver) unregistering} those observers when finished.

Specified by:

registerChoiceModeObserver in interface ChoiceMode

Parameters:

observer - Observer to register.

See Also:

ChoiceMode.unregisterChoiceModeObserver(ChoiceModeObserver)

unregisterChoiceModeObserver

public 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.

Specified by:

unregisterChoiceModeObserver in interface ChoiceMode

Parameters:

observer - Observer to unregister.

See Also:

ChoiceMode.registerChoiceModeObserver(ChoiceModeObserver)