com.mikepenz.fastadapter.select

Class SelectExtension<Item extends IItem>

java.lang.Object

com.mikepenz.fastadapter.select.SelectExtension<Item>

All Implemented Interfaces:

IAdapterExtension<Item>

public class SelectExtension<Item extends IItem>
extends java.lang.Object
implements IAdapterExtension<Item>

Created by mikepenz on 04/06/2017.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BUNDLE_SELECTIONS

Constructor Summary

Constructors

Constructor and Description
SelectExtension()

Method Summary

Modifier and Type	Method and Description
java.util.List<Item>	deleteAllSelectedItems() deletes all current selected items
void	deselect() deselects all selections
void	deselect(int position) deselects an item and removes its position in the selections list
void	deselect(int position, java.util.Iterator<java.lang.Integer> entries) deselects an item and removes its position in the selections list also takes an iterator to remove items from the map
void	deselect(Item item) deselect's a provided item, this won't notify the adapter
void	deselect(Item item, int position, java.util.Iterator<java.lang.Integer> entries) deselects an item and removes its position in the selections list also takes an iterator to remove items from the map
void	deselect(java.lang.Iterable<java.lang.Integer> positions) deselects all items at the positions in the iteratable
void	deselectByIdentifier(long identifier) selects an item by it's identifier
void	deselectByIdentifiers(java.util.Set<java.lang.Long> identifiers)
void	deselectByItems(java.util.Set<Item> items)
java.util.Set<Item>	getSelectedItems()
java.util.Set<java.lang.Integer>	getSelections()
IAdapterExtension<Item>	init(FastAdapter<Item> fastAdapter)
boolean	isSelectable()
void	notifyAdapterDataSetChanged()
void	notifyAdapterItemMoved(int fromPosition, int toPosition)
void	notifyAdapterItemRangeChanged(int position, int itemCount, java.lang.Object payload)
void	notifyAdapterItemRangeInserted(int position, int itemCount)
void	notifyAdapterItemRangeRemoved(int position, int itemCount)
boolean	onClick(android.view.View v, int pos, FastAdapter<Item> fastAdapter, Item item)
boolean	onLongClick(android.view.View v, int pos, FastAdapter<Item> fastAdapter, Item item)
boolean	onTouch(android.view.View v, android.view.MotionEvent event, int position, FastAdapter<Item> fastAdapter, Item item)
void	performFiltering(java.lang.CharSequence constraint)
void	saveInstanceState(android.os.Bundle savedInstanceState, java.lang.String prefix)
void	select() select all items
void	select(boolean considerSelectableFlag) select all items
void	select(IAdapter<Item> adapter, Item item, int position, boolean fireEvent, boolean considerSelectableFlag) selects an item and remembers its position in the selections list
void	select(int position) selects an item and remembers its position in the selections list
void	select(int position, boolean fireEvent) selects an item and remembers its position in the selections list
void	select(int position, boolean fireEvent, boolean considerSelectableFlag) selects an item and remembers its position in the selections list
void	select(Item item, boolean considerSelectableFlag) select's a provided item, this won't notify the adapter
void	select(java.lang.Iterable<java.lang.Integer> positions) selects all items at the positions in the iteratable
void	selectByIdentifier(long identifier, boolean fireEvent, boolean considerSelectableFlag) selects an item by it's identifier
void	selectByIdentifiers(java.util.Set<java.lang.Long> identifiers, boolean fireEvent, boolean considerSelectableFlag)
void	set(java.util.List<Item> items, boolean resetFilter)
void	toggleSelection(int position) toggles the selection of the item at the given position
SelectExtension<Item>	withAllowDeselection(boolean allowDeselection) If false, a user can't deselect an item via click (you can still do this programmatically)
SelectExtension<Item>	withMultiSelect(boolean multiSelect) Enable this if you want multiSelection possible in the list
void	withSavedInstanceState(android.os.Bundle savedInstanceState, java.lang.String prefix)
SelectExtension<Item>	withSelectable(boolean selectable) set if no item is selectable
SelectExtension<Item>	withSelectionListener(ISelectionListener<Item> selectionListener) set a listener that get's notified whenever an item is selected or deselected
SelectExtension<Item>	withSelectOnLongClick(boolean selectOnLongClick) Disable this if you want the selection on a single tap
SelectExtension<Item>	withSelectWithItemUpdate(boolean selectWithItemUpdate) select between the different selection behaviors.

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_SELECTIONS

protected static final java.lang.String BUNDLE_SELECTIONS

See Also:

Constant Field Values

Constructor Detail

SelectExtension

public SelectExtension()

Method Detail

withSelectWithItemUpdate

public SelectExtension<Item> withSelectWithItemUpdate(boolean selectWithItemUpdate)

select between the different selection behaviors. there are now 2 different variants of selection. you can toggle this via `withSelectWithItemUpdate(boolean)` (where false == default - variant 1) 1.) direct selection via the view "selected" state, we also make sure we do not animate here so no notifyItemChanged is called if we repeatly press the same item 2.) we select the items via a notifyItemChanged. this will allow custom selected logics within your views (isSelected() - do something...) and it will also animate the change via the provided itemAnimator. because of the animation of the itemAnimator the selection will have a small delay (time of animating)

Parameters:

selectWithItemUpdate - true if notifyItemChanged should be called upon select

Returns:

this

withMultiSelect

public SelectExtension<Item> withMultiSelect(boolean multiSelect)

Enable this if you want multiSelection possible in the list

Parameters:

multiSelect - true to enable multiSelect

Returns:

this

withSelectOnLongClick

public SelectExtension<Item> withSelectOnLongClick(boolean selectOnLongClick)

Disable this if you want the selection on a single tap

Parameters:

selectOnLongClick - false to do select via single click

Returns:

this

withAllowDeselection

public SelectExtension<Item> withAllowDeselection(boolean allowDeselection)

If false, a user can't deselect an item via click (you can still do this programmatically)

Parameters:

allowDeselection - true if a user can deselect an already selected item via click

Returns:

this

withSelectable

public SelectExtension<Item> withSelectable(boolean selectable)

set if no item is selectable

Parameters:

selectable - true if items are selectable

Returns:

this

isSelectable

public boolean isSelectable()

Returns:

if items are selectable

withSelectionListener

public SelectExtension<Item> withSelectionListener(ISelectionListener<Item> selectionListener)

set a listener that get's notified whenever an item is selected or deselected

Parameters:

selectionListener - the listener that will be notified about selection changes

Returns:

this

init

public IAdapterExtension<Item> init(FastAdapter<Item> fastAdapter)

Specified by:

init in interface IAdapterExtension<Item extends IItem>

withSavedInstanceState

public void withSavedInstanceState(android.os.Bundle savedInstanceState,
                                   java.lang.String prefix)

Specified by:

withSavedInstanceState in interface IAdapterExtension<Item extends IItem>

saveInstanceState

public void saveInstanceState(android.os.Bundle savedInstanceState,
                              java.lang.String prefix)

Specified by:

saveInstanceState in interface IAdapterExtension<Item extends IItem>

onClick

public boolean onClick(android.view.View v,
                       int pos,
                       FastAdapter<Item> fastAdapter,
                       Item item)

Specified by:

onClick in interface IAdapterExtension<Item extends IItem>

onLongClick

public boolean onLongClick(android.view.View v,
                           int pos,
                           FastAdapter<Item> fastAdapter,
                           Item item)

Specified by:

onLongClick in interface IAdapterExtension<Item extends IItem>

onTouch

public boolean onTouch(android.view.View v,
                       android.view.MotionEvent event,
                       int position,
                       FastAdapter<Item> fastAdapter,
                       Item item)

Specified by:

onTouch in interface IAdapterExtension<Item extends IItem>

notifyAdapterDataSetChanged

public void notifyAdapterDataSetChanged()

Specified by:

notifyAdapterDataSetChanged in interface IAdapterExtension<Item extends IItem>

notifyAdapterItemRangeInserted

public void notifyAdapterItemRangeInserted(int position,
                                           int itemCount)

Specified by:

notifyAdapterItemRangeInserted in interface IAdapterExtension<Item extends IItem>

notifyAdapterItemRangeRemoved

public void notifyAdapterItemRangeRemoved(int position,
                                          int itemCount)

Specified by:

notifyAdapterItemRangeRemoved in interface IAdapterExtension<Item extends IItem>

notifyAdapterItemMoved

public void notifyAdapterItemMoved(int fromPosition,
                                   int toPosition)

Specified by:

notifyAdapterItemMoved in interface IAdapterExtension<Item extends IItem>

notifyAdapterItemRangeChanged

public void notifyAdapterItemRangeChanged(int position,
                                          int itemCount,
                                          java.lang.Object payload)

Specified by:

notifyAdapterItemRangeChanged in interface IAdapterExtension<Item extends IItem>

set

public void set(java.util.List<Item> items,
                boolean resetFilter)

Specified by:

set in interface IAdapterExtension<Item extends IItem>

performFiltering

public void performFiltering(java.lang.CharSequence constraint)

Specified by:

performFiltering in interface IAdapterExtension<Item extends IItem>

getSelections

public java.util.Set<java.lang.Integer> getSelections()

Returns:

a set with the global positions of all selected items (which are currently in the list (includes expanded expandable items))

getSelectedItems

public java.util.Set<Item> getSelectedItems()

Returns:

a set with all items which are currently selected (includes subitems)

toggleSelection

public void toggleSelection(int position)

toggles the selection of the item at the given position

Parameters:

position - the global position

select

public void select()

select all items

select

public void select(boolean considerSelectableFlag)

select all items

Parameters:

considerSelectableFlag - true if the select method should not select an item if its not selectable

select

public void select(Item item,
                   boolean considerSelectableFlag)

select's a provided item, this won't notify the adapter

Parameters:

item - the item to select

considerSelectableFlag - true if the select method should not select an item if its not selectable

select

public void select(java.lang.Iterable<java.lang.Integer> positions)

selects all items at the positions in the iteratable

Parameters:

positions - the global positions to select

select

public void select(int position)

selects an item and remembers its position in the selections list

Parameters:

position - the global position

select

public void select(int position,
                   boolean fireEvent)

selects an item and remembers its position in the selections list

Parameters:

position - the global position

fireEvent - true if the onClick listener should be called

select

public void select(int position,
                   boolean fireEvent,
                   boolean considerSelectableFlag)

selects an item and remembers its position in the selections list

Parameters:

position - the global position

fireEvent - true if the onClick listener should be called

considerSelectableFlag - true if the select method should not select an item if its not selectable

select

public void select(IAdapter<Item> adapter,
                   Item item,
                   int position,
                   boolean fireEvent,
                   boolean considerSelectableFlag)

selects an item and remembers its position in the selections list

Parameters:

adapter - adapter holding this item (or it's parent)

item - the item to select

position - the global position (or < 0 if the item is not displayed)

fireEvent - true if the onClick listener should be called

considerSelectableFlag - true if the select method should not select an item if its not selectable

selectByIdentifier

public void selectByIdentifier(long identifier,
                               boolean fireEvent,
                               boolean considerSelectableFlag)

selects an item by it's identifier

Parameters:

identifier - the identifier of the item to select

fireEvent - true if the onClick listener should be called

considerSelectableFlag - true if the select method should not select an item if its not selectable

selectByIdentifiers

public void selectByIdentifiers(java.util.Set<java.lang.Long> identifiers,
                                boolean fireEvent,
                                boolean considerSelectableFlag)

Parameters:

identifiers - the set of identifiers to select

fireEvent - true if the onClick listener should be called

considerSelectableFlag - true if the select method should not select an item if its not selectable

deselect

public void deselect()

deselects all selections

deselect

public void deselect(Item item)

deselect's a provided item, this won't notify the adapter

Parameters:

item - the item to select

deselect

public void deselect(java.lang.Iterable<java.lang.Integer> positions)

deselects all items at the positions in the iteratable

Parameters:

positions - the global positions to deselect

deselect

public void deselect(int position)

deselects an item and removes its position in the selections list

Parameters:

position - the global position

deselect

public void deselect(int position,
                     java.util.Iterator<java.lang.Integer> entries)

deselects an item and removes its position in the selections list also takes an iterator to remove items from the map

Parameters:

position - the global position

entries - the iterator which is used to deselect all

deselect

public void deselect(Item item,
                     int position,
                     java.util.Iterator<java.lang.Integer> entries)

deselects an item and removes its position in the selections list also takes an iterator to remove items from the map

Parameters:

item - the item to deselected

position - the global position (or < 0 if the item is not displayed)

entries - the iterator which is used to deselect all

deselectByIdentifier

public void deselectByIdentifier(long identifier)

selects an item by it's identifier

Parameters:

identifier - the identifier of the item to deselect

deselectByIdentifiers

public void deselectByIdentifiers(java.util.Set<java.lang.Long> identifiers)

Parameters:

identifiers - the set of identifiers to deselect

deselectByItems

public void deselectByItems(java.util.Set<Item> items)

Parameters:

items - the set of items to deselect. They require a identifier.

deleteAllSelectedItems

public java.util.List<Item> deleteAllSelectedItems()

deletes all current selected items

Returns:

a list of the IItem elements which were deleted