mva2.adapter

Class ListSection<M>

java.lang.Object

mva2.adapter.Section

mva2.adapter.ListSection<M>

public class ListSection<M>
extends Section

Internally section uses DiffUtil to calculate the diff and calls the correct notify method.

Constructor Summary

Constructors

Constructor and Description
ListSection() No arg constructor for ListSection.
ListSection(PayloadProvider<M> payloadProvider) Constructor which initializes the ListSection with give PayloadProvider.

Method Summary

Modifier and Type	Method and Description
void	add(int index, M item) Inserts the specified element at the specified position in this data manger (optional operation).
void	add(M item) Appends the specified element to the end of ListSection.
boolean	addAll(java.util.Collection<? extends M> items) Appends all of the elements in the specified collection to the end of this ListSection, in the order that they are returned by the specified collection's iterator (optional operation).
boolean	addAll(int index, java.util.Collection<? extends M> items) Inserts all of the elements in the specified collection into this data manager at the specified position (optional operation).
void	clear() Removes all of the elements from this data manager (optional operation).
void	clearSelections() This method is used to clear the selected items in a ListSection
M	get(int index) Returns the element at the specified position in this list section.
java.util.List<M>	getData() Returns the data added to this section
java.util.List<M>	getSelectedItems() Returns the list of selected items
void	remove(int index) Removes the element at the specified position in this list (optional operation).
void	set(int index, M item) Replaces the element at the specified position in this data manager with the specified element (optional operation).
void	set(java.util.List<M> items) Replaces the data list in this data manager with the new list.
void	setDiffUtil(MvaDiffUtil<M> diffUtil) Sets the diffutil for this section.
void	setOnItemClickListener(OnItemClickListener<M> itemClickListener) Set the listener to get callback when an item is clicked inside the section.
void	setOnSelectionChangedListener(OnSelectionChangedListener<M> selectionChangedListener) Set listener to get callback when an item is selected or unselected
void	setPayloadProvider(PayloadProvider<M> payloadProvider) Set your own payload provider.
void	setSwipeToDismissListener(SwipeToDismissListener<M> swipeToDismissListener) Sets the SwipeToDismissListener
int	size() Removes all of the elements from this data manager (optional operation).

Methods inherited from class mva2.adapter.Section

addDecorator, addDecorator, hideSection, isSectionHidden, onChanged, onInserted, onMoved, onRemoved, removeAllDecorators, removeDecorator, removeDecorator, setExpansionMode, setSectionExpansionMode, setSelectionMode, setSpanCount, showSection

Methods inherited from class java.lang.Object

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

Constructor Detail

ListSection

public ListSection()

No arg constructor for ListSection. This initializes the list section with default PayloadProvider which checks the equality using Object.equals(object)

ListSection

public ListSection(PayloadProvider<M> payloadProvider)

Constructor which initializes the ListSection with give PayloadProvider.

Parameters:

payloadProvider - PayloadProvider to be used by the list section.

Method Detail

add

public void add(M item)

Appends the specified element to the end of ListSection. Also calls RecyclerView.ItemAnimator's add animation.

Parameters:

item - element to be appended to this list

Throws:

java.lang.UnsupportedOperationException - if the add operation is not supported by this ListSection

add

public void add(int index,
                M item)

Inserts the specified element at the specified position in this data manger (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices). Also calls RecyclerView.ItemAnimator's add animation.

Parameters:

index - index at which the specified element is to be inserted

item - element to be inserted

Throws:

java.lang.UnsupportedOperationException - if the add operation is not supported by this data manger

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

addAll

public boolean addAll(java.util.Collection<? extends M> items)

Appends all of the elements in the specified collection to the end of this ListSection, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty) Also calls RecyclerView.ItemAnimator's add animation.

Parameters:

items - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the addAll operation is not supported by this ListSection

See Also:

add(Object)

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends M> items)

Inserts all of the elements in the specified collection into this data manager at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. Also calls RecyclerView.ItemAnimator's add animation.

Parameters:

index - index at which to insert the first element from the specified collection

items - collection containing elements to be added to this list

Returns:

true if this data manager changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the addAll operation is not supported by this data manager

clear

public void clear()

Removes all of the elements from this data manager (optional operation). The data manager will be empty after this call returns. After the elements are removed RecyclerView.ItemAnimator's remove animation will be called.

clearSelections

public void clearSelections()

This method is used to clear the selected items in a ListSection

get

public M get(int index)

Returns the element at the specified position in this list section.

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list section

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

getData

public java.util.List<M> getData()

Returns the data added to this section

Returns:

List of models added to this section

getSelectedItems

public java.util.List<M> getSelectedItems()

Returns the list of selected items

Returns:

List of selected items or empty list if none was selected

remove

public void remove(int index)

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). If the element is removed RecyclerView.ItemAnimator's remove animation will be called.

Parameters:

index - the index of the element to be removed

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

set

public void set(java.util.List<M> items)

Replaces the data list in this data manager with the new list. Also calls necessary RecyclerView.ItemAnimator's animation with payload.

Parameters:

items - list to be stored in the data manager

set

public void set(int index,
                M item)

Replaces the element at the specified position in this data manager with the specified element (optional operation). Also calls necessary RecyclerView.ItemAnimator's animation with payload.

Parameters:

index - index of the element to replace

item - element to be stored at the specified position

Throws:

java.lang.UnsupportedOperationException - if the set operation is not supported by this data manager

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

setDiffUtil

public void setDiffUtil(MvaDiffUtil<M> diffUtil)

Sets the diffutil for this section. The default diffutil used in the adapter takes leverage of the payload provider of this section. If you want to customize the entire behaviour of calculating the diff, create your own implementation of MvaDiffUtil and set it here

Parameters:

diffUtil - DiffUtil to be used by the section

setOnItemClickListener

public void setOnItemClickListener(OnItemClickListener<M> itemClickListener)

Set the listener to get callback when an item is clicked inside the section. To invoke this listener, you need to call ItemViewHolder.onClick()

Parameters:

itemClickListener - Listener to be set

setOnSelectionChangedListener

public void setOnSelectionChangedListener(OnSelectionChangedListener<M> selectionChangedListener)

Set listener to get callback when an item is selected or unselected

Parameters:

selectionChangedListener - Listener to be set

setPayloadProvider

public void setPayloadProvider(PayloadProvider<M> payloadProvider)

Set your own payload provider. You can write your own implementation of the PayloadProvider and set it here.

Parameters:

payloadProvider - PayloadProvider to be set

setSwipeToDismissListener

public void setSwipeToDismissListener(SwipeToDismissListener<M> swipeToDismissListener)

Sets the SwipeToDismissListener

Parameters:

swipeToDismissListener - Listener to be set

See Also:

SwipeToDismissListener

size

public int size()

Removes all of the elements from this data manager (optional operation). The data manager will be empty after this call returns. After the elements are removed RecyclerView.ItemAnimator's remove animation will be called.