com.globusltd.recyclerview.choice

Class ObservableChoiceMode

java.lang.Object

com.globusltd.recyclerview.choice.ObservableChoiceMode

All Implemented Interfaces:

ChoiceMode

Direct Known Subclasses:

MultipleChoiceMode, MultipleModalChoiceMode, SingleChoiceMode, SingleModalChoiceMode

@MainThread
public abstract class ObservableChoiceMode
extends Object
implements ChoiceMode

Base class for any choice mode. Class is designed for handle notification events to the visible view holders.

Constructor Summary

Constructors

Constructor and Description
ObservableChoiceMode()

Method Summary

Modifier and Type	Method and Description
boolean	isAttached() Returns true when choice mode is attached to adapter and RecyclerView.
void	notifyAllItemsCheckedChanged(boolean fromUser) Notifies the registered observers that the selection of the all items in the choice mode have been changed.
void	notifyItemCheckedChanged(long itemId, boolean fromUser) Notifies the registered observers that the selection of the item in the choice mode have been changed.
void	registerChoiceModeObserver(ChoiceModeObserver observer) Register a new observer to listen for selection changes.
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

Methods inherited from interface com.globusltd.recyclerview.choice.ChoiceMode

clearChoices, getCheckedItemCount, isActivated, isItemChecked, onClick, onLongClick, requiresLongpress, requiresStableIds, setItemChecked

Constructor Detail

ObservableChoiceMode

public ObservableChoiceMode()

Method Detail

isAttached

public final boolean isAttached()

Returns true when choice mode is attached to adapter and RecyclerView.

Returns:

true when choice mode is attached to adapter and RecyclerView, false otherwise.

registerChoiceModeObserver

@CallSuper
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

@CallSuper
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)

notifyItemCheckedChanged

public void notifyItemCheckedChanged(long itemId,
                                     boolean fromUser)

Notifies the registered observers that the selection of the item in the choice mode have been changed. Note that method can be called multiple times.

Parameters:

itemId - The item's id or RecyclerView#NO_ID.

fromUser - true if the checked state change was initiated by the user.

notifyAllItemsCheckedChanged

public void notifyAllItemsCheckedChanged(boolean fromUser)

Notifies the registered observers that the selection of the all items in the choice mode have been changed.

Parameters:

fromUser - true if the checked state change was initiated by the user.