com.mikepenz.fastadapter.adapters

Class ItemFilter<Model,Item extends IItem>

java.lang.Object

android.widget.Filter

com.mikepenz.fastadapter.adapters.ItemFilter<Model,Item>

public class ItemFilter<Model,Item extends IItem>
extends android.widget.Filter

ItemFilter which extends the Filter api provided by Android This calls automatically all required methods, just overwrite the filterItems method

Nested Class Summary

Nested classes/interfaces inherited from class android.widget.Filter

android.widget.Filter.FilterListener, android.widget.Filter.FilterResults

Field Summary

Fields

Modifier and Type	Field and Description
protected ItemFilterListener<Item>	mItemFilterListener

Constructor Summary

Constructors

Constructor and Description
ItemFilter(ModelAdapter<?,Item> itemAdapter)

Method Summary

Modifier and Type	Method and Description
ModelAdapter<?,Item>	add(int position, Item... items) add an array of items at the given position within the existing items
ModelAdapter<?,Item>	add(int position, java.util.List<Item> items) add a list of items at the given position within the existing items
ModelAdapter<?,Item>	add(Item... items) add an array of items to the end of the existing items
ModelAdapter<?,Item>	add(java.util.List<Item> items) add a list of items to the end of the existing items will prior check if we are currently filtering
ModelAdapter<?,Item>	clear() removes all items of this adapter
int	getAdapterPosition(Item item) Searches for the given item and calculates its relative position
int	getAdapterPosition(long identifier) Searches for the given identifier and calculates its relative position
java.lang.CharSequence	getConstraint()
java.util.Set<Item>	getSelectedItems() helper method to get all selections from the ItemAdapter's original item list
java.util.Set<java.lang.Integer>	getSelections() helper method to get all selections from the ItemAdapter's original item list
ModelAdapter<?,Item>	move(int fromPosition, int toPosition) moves an item within the list from a position to a position
android.widget.Filter.FilterResults	performFiltering(java.lang.CharSequence constraint)
protected void	publishResults(java.lang.CharSequence constraint, android.widget.Filter.FilterResults results)
ModelAdapter<?,Item>	remove(int position) removes an item at the given position within the existing icons
ModelAdapter<?,Item>	removeRange(int position, int itemCount) removes a range of items starting with the given position within the existing icons
ModelAdapter<?,Item>	set(int position, Item item) sets an item at the given position, overwriting the previous item
ItemFilter<Model,Item>	withFilterPredicate(IItemAdapter.Predicate<Item> filterPredicate) define the predicate used to filter the list inside the ItemFilter
ItemFilter<Model,Item>	withItemFilterListener(ItemFilterListener<Item> listener)

Methods inherited from class android.widget.Filter

convertResultToString, filter, filter

Methods inherited from class java.lang.Object

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

Field Detail

mItemFilterListener

protected ItemFilterListener<Item extends IItem> mItemFilterListener

Constructor Detail

ItemFilter

public ItemFilter(ModelAdapter<?,Item> itemAdapter)

Method Detail

withItemFilterListener

public ItemFilter<Model,Item> withItemFilterListener(ItemFilterListener<Item> listener)

Parameters:

listener - which will be called after the items were filtered

Returns:

this

withFilterPredicate

public ItemFilter<Model,Item> withFilterPredicate(IItemAdapter.Predicate<Item> filterPredicate)

define the predicate used to filter the list inside the ItemFilter

Parameters:

filterPredicate - the predicate used to filter the list inside the ItemFilter

Returns:

this

performFiltering

public android.widget.Filter.FilterResults performFiltering(java.lang.CharSequence constraint)

Specified by:

performFiltering in class android.widget.Filter

getConstraint

public java.lang.CharSequence getConstraint()

publishResults

protected void publishResults(java.lang.CharSequence constraint,
                              android.widget.Filter.FilterResults results)

Specified by:

publishResults in class android.widget.Filter

getSelections

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

helper method to get all selections from the ItemAdapter's original item list

Returns:

a Set with the global positions of all selected Items

getSelectedItems

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

helper method to get all selections from the ItemAdapter's original item list

Returns:

a Set with the selected items out of all items in this itemAdapter (not the listed ones)

getAdapterPosition

public int getAdapterPosition(Item item)

Searches for the given item and calculates its relative position

Parameters:

item - the item which is searched for

Returns:

the relative position

getAdapterPosition

public int getAdapterPosition(long identifier)

Searches for the given identifier and calculates its relative position

Parameters:

identifier - the identifier of an item which is searched for

Returns:

the relative position

add

@SafeVarargs
public final ModelAdapter<?,Item> add(Item... items)

add an array of items to the end of the existing items

Parameters:

items - the items to add

add

public ModelAdapter<?,Item> add(java.util.List<Item> items)

add a list of items to the end of the existing items will prior check if we are currently filtering

Parameters:

items - the items to add

add

@SafeVarargs
public final ModelAdapter<?,Item> add(int position,
                                                   Item... items)

add an array of items at the given position within the existing items

Parameters:

position - the global position

items - the items to add

add

public ModelAdapter<?,Item> add(int position,
                                java.util.List<Item> items)

add a list of items at the given position within the existing items

Parameters:

position - the global position

items - the items to add

set

public ModelAdapter<?,Item> set(int position,
                                Item item)

sets an item at the given position, overwriting the previous item

Parameters:

position - the global position

item - the item to set

move

public ModelAdapter<?,Item> move(int fromPosition,
                                 int toPosition)

moves an item within the list from a position to a position

Parameters:

fromPosition - the position global from which we want to move

toPosition - the global position to which to move

Returns:

this

remove

public ModelAdapter<?,Item> remove(int position)

removes an item at the given position within the existing icons

Parameters:

position - the global position

removeRange

public ModelAdapter<?,Item> removeRange(int position,
                                        int itemCount)

removes a range of items starting with the given position within the existing icons

Parameters:

position - the global position

itemCount - the count of items which were removed

clear

public ModelAdapter<?,Item> clear()

removes all items of this adapter