com.globusltd.recyclerview.choice

Class SingleModalChoiceMode

java.lang.Object

com.globusltd.recyclerview.choice.ObservableChoiceMode

com.globusltd.recyclerview.choice.SingleModalChoiceMode

All Implemented Interfaces:

ChoiceMode

public class SingleModalChoiceMode
extends ObservableChoiceMode

ChoiceMode that allows up to one choice in a modal selection mode.

Constructor Summary

Constructors

Constructor and Description
SingleModalChoiceMode(ActionModeCompat actionModeCompat, ModalChoiceModeListener listener)
SingleModalChoiceMode(ActionModeCompat actionModeCompat, ModalChoiceModeListener listener, Bundle savedInstanceState)

Method Summary

Modifier and Type	Method and Description
void	clearChoices() Clears any checked items.
void	finish() Finish and close this action mode.
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.
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	setFinishActionModeOnClearEnabled(boolean enabled) Allows action mode be opened when no items are checked.
void	setItemChecked(long itemId, boolean checked) Sets the checked state of the specified position.
void	setStartOnSingleTapEnabled(boolean enabled) Allows to start modal choice on single tap.
void	unregisterChoiceModeObserver(ChoiceModeObserver observer) Unregister an observer currently listening for selection changes.

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

isAttached, notifyAllItemsCheckedChanged, notifyItemCheckedChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleModalChoiceMode

public SingleModalChoiceMode(@NonNull
                             ActionModeCompat actionModeCompat,
                             @NonNull
                             ModalChoiceModeListener listener)

SingleModalChoiceMode

public SingleModalChoiceMode(@NonNull
                             ActionModeCompat actionModeCompat,
                             @NonNull
                             ModalChoiceModeListener listener,
                             @Nullable
                             Bundle savedInstanceState)

Method Detail

setStartOnSingleTapEnabled

public void setStartOnSingleTapEnabled(boolean enabled)

Allows to start modal choice on single tap. By default long tap is required.

setFinishActionModeOnClearEnabled

public void setFinishActionModeOnClearEnabled(boolean enabled)

Allows action mode be opened when no items are checked. By default is enabled.

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)

Description copied from interface: ChoiceMode

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)

Description copied from interface: ChoiceMode

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

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

Overrides:

registerChoiceModeObserver in class ObservableChoiceMode

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

Overrides:

unregisterChoiceModeObserver in class ObservableChoiceMode

Parameters:

observer - Observer to unregister.

See Also:

ChoiceMode.registerChoiceModeObserver(ChoiceModeObserver)

finish

public void finish()

Finish and close this action mode. The action mode's ModalChoiceModeListener will have its ModalChoiceModeListener#onDestroyActionMode(ActionMode) method called.

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.