universum.studios.android.widget.adapter.module

Class AlphabeticHeaders

java.lang.Object

universum.studios.android.widget.adapter.module.AdapterModule

universum.studios.android.widget.adapter.module.HeadersModule<HeadersModule.SimpleHeader>

universum.studios.android.widget.adapter.module.AlphabeticHeaders

public class AlphabeticHeaders
extends HeadersModule<HeadersModule.SimpleHeader>

A HeadersModule implementation which may be used to provide set of alphabetic headers for data set of a specific adapter to which is this module attached.

Alphabetic headers are generated whenever one of fromAlphabeticList(List) and fromAlphabeticCursor(Cursor) methods is called.

Note, that this module assumes, that the data set to be processed is already ordered alphabetically.

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AlphabeticHeaders.AlphabeticItem Required interface for item of which data set can be processed via fromAlphabeticList(List) or fromAlphabeticCursor(Cursor).

Nested classes/interfaces inherited from class universum.studios.android.widget.adapter.module.HeadersModule

HeadersModule.Header, HeadersModule.SimpleHeader

Nested classes/interfaces inherited from class universum.studios.android.widget.adapter.module.AdapterModule

AdapterModule.ModuleAdapter

Constructor Summary

Constructors

Constructor and Description
AlphabeticHeaders()

Method Summary

Modifier and Type	Method and Description
void	clearHeaders() Clears the current headers data set of this module.
<C extends Cursor & AlphabeticHeaders.AlphabeticItem> void	fromAlphabeticCursor(C cursor) Like fromAlphabeticList(List) for the given cursor of which content will be iterated to obtain the item names.
<Item extends AlphabeticHeaders.AlphabeticItem> void	fromAlphabeticList(List<Item> list) Processes the given list of alphabetic items.
protected void	onProcessAlphabeticItem(AlphabeticHeaders.AlphabeticItem item, int position) Invoked to process the given alphabetic item and to create header item from it.

Methods inherited from class universum.studios.android.widget.adapter.module.HeadersModule

addHeader, bindViewHolder, correctPosition, createView, createViewHolder, getHeader, getHeaders, getHeadersCountBeforePosition, getHeaderStyleAttr, isEmpty, isHeaderAt, removeHeaderAt, setHeaderStyleAttr, size

Methods inherited from class universum.studios.android.widget.adapter.module.AdapterModule

assertAttachedToAdapterOrThrow, attachToAdapter, isAdapterNotificationEnabled, notifyAdapter, onAttachedToAdapter, requiresStateSaving, setAdapterNotificationEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

AlphabeticHeaders

public AlphabeticHeaders()

Method Detail

fromAlphabeticCursor

public <C extends Cursor & AlphabeticHeaders.AlphabeticItem> void fromAlphabeticCursor(@NonNull
                                                                                       C cursor)

Like fromAlphabeticList(List) for the given cursor of which content will be iterated to obtain the item names.

Type Parameters:

C - Type of the alphabetic cursor.

Parameters:

cursor - The desired cursor with content for alphabetic items to process.

fromAlphabeticList

public <Item extends AlphabeticHeaders.AlphabeticItem> void fromAlphabeticList(@NonNull
                                                                               List<Item> list)

Processes the given list of alphabetic items. Entire list will be iterated and for each of its items will be checked the first char of name provided via @link AlphabeticHeaders.AlphabeticItem#getText()}, so created headers data set will contain all different first characters found at the first positions of the obtained item names.

Also, the adapter, to which is this module attached, will be notified about occurred data set change via AdapterModule.notifyAdapter().

Note, that items in the given list should be already alphabetically sorted, otherwise the resulting headers data set may contain duplicates.

Type Parameters:

Item - Type of the alphabetic items in the list.

Parameters:

list - The desired list of alphabetic items to process.

See Also:

fromAlphabeticCursor(Cursor)

clearHeaders

public void clearHeaders()

Description copied from class: HeadersModule

Clears the current headers data set of this module.

Overrides:

clearHeaders in class HeadersModule<HeadersModule.SimpleHeader>

onProcessAlphabeticItem

protected final void onProcessAlphabeticItem(@NonNull
                                             AlphabeticHeaders.AlphabeticItem item,
                                             int position)

Invoked to process the given alphabetic item and to create header item from it.

Parameters:

item - An alphabetic item to process.

position - The position at which should be header presented within the headers data set.