universum.studios.android.setting

Class SettingHeadersAdapter

java.lang.Object

android.widget.BaseAdapter

universum.studios.android.setting.SettingHeadersAdapter

All Implemented Interfaces:

android.widget.Adapter, android.widget.ListAdapter, android.widget.SpinnerAdapter

public class SettingHeadersAdapter
extends android.widget.BaseAdapter

A BaseAdapter implementation used to provide data set of Items for adapter view that displays a list of setting preferences in the context of SettingsBaseActivity.

This adapter uses the following view types to provide views for its data set of items:

• VIEW_TYPE_CATEGORY - view for the category header that has no fragment nor intent associated,
• VIEW_TYPE_CATEGORY_DIVIDER - view for divider between category headers,
• VIEW_TYPE_HEADER - view for the selectable header.

Data set of items with associated headers may be supplied via SettingHeadersAdapter(Context, List) constructor or changed via changeHeaders(List). A specific item at a desired position may be obtained via getItem(int) and its associated header via getItem(int).getHeader().

Since:

1.0

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SettingHeadersAdapter.CategoryDividerHolder A SettingHeadersAdapter.ViewHolder implementation for category divider view of SettingHeadersAdapter.
static class	SettingHeadersAdapter.CategoryHolder A SettingHeadersAdapter.ViewHolder implementation for category item view of SettingHeadersAdapter.
static class	SettingHeadersAdapter.HeaderHolder A SettingHeadersAdapter.ViewHolder implementation for header item view of SettingHeadersAdapter.
static class	SettingHeadersAdapter.Item Item class represents a data model for SettingHeadersAdapter.
static class	SettingHeadersAdapter.ViewHolder Base class for view holder implementations used in SettingHeadersAdapter.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_ID Constant that identifies invalid/unspecified id.
static int	NO_POSITION Constant that identifies invalid/unspecified position attached to a specified holder.
static int	VIEW_TYPE_CATEGORY View type for the category item.
static int	VIEW_TYPE_CATEGORY_DIVIDER View type for the category divider.
static int	VIEW_TYPE_HEADER View type for the header item.

Fields inherited from interface android.widget.Adapter

IGNORE_ITEM_VIEW_TYPE, NO_SELECTION

Constructor Summary

Constructors

Constructor and Description
SettingHeadersAdapter(android.content.Context context) Creates a new instance of SettingHeadersAdapter with empty data set.
SettingHeadersAdapter(android.content.Context context, List<android.preference.PreferenceActivity.Header> headers) Creates a new instance of SettingHeadersAdapter with the initial data set of headers.
SettingHeadersAdapter(android.content.Context context, android.preference.PreferenceActivity.Header[] headers) Same as SettingHeadersAdapter(Context, List) for array of headers.

Method Summary

Modifier and Type	Method and Description
void	changeHeaders(List<android.preference.PreferenceActivity.Header> headers) Same as swapHeaders(List) where the old headers are ignored.
int	getCount()
SettingHeadersAdapter.Item	getItem(int position)
long	getItemId(int position)
int	getItemViewType(int position)
android.view.View	getView(int position, android.view.View convertView, android.view.ViewGroup parent)
int	getViewTypeCount()
boolean	hasItemAt(int position) Returns a boolean flag indicating whether this data set has item that can provide data for the specified position or not.
boolean	hasStableIds()
android.view.View	inflateView(int resource, android.view.ViewGroup parent) Inflates a new view hierarchy from the given xml resource.
boolean	isCategoryAt(int position) Checks whether item at the specified position is a category.
boolean	isCategoryDividerAt(int position) Checks whether item at the specified position is a category divider.
boolean	isEnabled(int position)
boolean	isHeaderAt(int position) Checks whether item at the specified position is a header.
protected void	onBindViewHolder(SettingHeadersAdapter.ViewHolder viewHolder, int position) Invoked from getView(int, View, ViewGroup) in order to perform binding of the given viewHolder with data of the item from this adapter's data set at the specified position.
protected SettingHeadersAdapter.ViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType) Invoked from getView(int, View, ViewGroup) in order to create a view holder along with its corresponding item view for the specified viewType.
void	setUseVectorIcons(boolean useVectorIcons) Sets a boolean flag indicating whether this adapter should treat icon parameter specified via PreferenceActivity.Header#iconRes as resource of vector drawable or as resource of standard drawable.
List<android.preference.PreferenceActivity.Header>	swapHeaders(List<android.preference.PreferenceActivity.Header> headers) Swaps the current data set of this adapter for the given headers.

Methods inherited from class android.widget.BaseAdapter

areAllItemsEnabled, getAutofillOptions, getDropDownView, isEmpty, notifyDataSetChanged, notifyDataSetInvalidated, registerDataSetObserver, setAutofillOptions, unregisterDataSetObserver

Methods inherited from class java.lang.Object

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

Field Detail

NO_POSITION

public static final int NO_POSITION

Constant that identifies invalid/unspecified position attached to a specified holder.

See Also:

Constant Field Values

NO_ID

public static final long NO_ID

Constant that identifies invalid/unspecified id.

See Also:

Constant Field Values

VIEW_TYPE_CATEGORY

public static final int VIEW_TYPE_CATEGORY

View type for the category item.

See Also:

Constant Field Values

VIEW_TYPE_CATEGORY_DIVIDER

public static final int VIEW_TYPE_CATEGORY_DIVIDER

View type for the category divider.

See Also:

Constant Field Values

VIEW_TYPE_HEADER

public static final int VIEW_TYPE_HEADER

View type for the header item.

This is only view type that is by default enabled by this adapter.

See Also:

isEnabled(int), Constant Field Values

Constructor Detail

SettingHeadersAdapter

public SettingHeadersAdapter(@NonNull
                             android.content.Context context)

Creates a new instance of SettingHeadersAdapter with empty data set.

See Also:

SettingHeadersAdapter(Context, List)

SettingHeadersAdapter

public SettingHeadersAdapter(@NonNull
                             android.content.Context context,
                             @NonNull
                             android.preference.PreferenceActivity.Header[] headers)

Same as SettingHeadersAdapter(Context, List) for array of headers.

SettingHeadersAdapter

public SettingHeadersAdapter(@NonNull
                             android.content.Context context,
                             @NonNull
                             List<android.preference.PreferenceActivity.Header> headers)

Creates a new instance of SettingHeadersAdapter with the initial data set of headers.

Parameters:

context - Context in which will be the new adapter used.

headers - Initial data set of headers.

See Also:

changeHeaders(List)

Method Detail

setUseVectorIcons

public void setUseVectorIcons(boolean useVectorIcons)

Sets a boolean flag indicating whether this adapter should treat icon parameter specified via PreferenceActivity.Header#iconRes as resource of vector drawable or as resource of standard drawable.

Parameters:

useVectorIcons - True to apply icon resources of items as vector drawables, false as standard drawables.

changeHeaders

public void changeHeaders(@Nullable
                          List<android.preference.PreferenceActivity.Header> headers)

Same as swapHeaders(List) where the old headers are ignored.

swapHeaders

@Nullable
public List<android.preference.PreferenceActivity.Header> swapHeaders(@Nullable
                                                                                List<android.preference.PreferenceActivity.Header> headers)

Swaps the current data set of this adapter for the given headers.

Note, that as this adapter uses multiple view types to present its data set, the specified headers are transformed into data set of Items. A specific item at a desired position via getItem(int). Header associated with an item at a specific position may be obtained via getItem(int).getHeader().

Parameters:

headers - The headers for which to create a new data set. May be null to clear the current data set.

See Also:

changeHeaders(List)

getCount

public int getCount()

hasItemAt

public boolean hasItemAt(int position)

Returns a boolean flag indicating whether this data set has item that can provide data for the specified position or not.

Parameters:

position - The position of item to check.

Returns:

True if getItem(int) can be called 'safely', false otherwise.

getItem

@NonNull
public SettingHeadersAdapter.Item getItem(int position)

hasStableIds

public boolean hasStableIds()

Specified by:

hasStableIds in interface android.widget.Adapter

Overrides:

hasStableIds in class android.widget.BaseAdapter

getItemId

public long getItemId(int position)

getViewTypeCount

public int getViewTypeCount()

Specified by:

getViewTypeCount in interface android.widget.Adapter

Overrides:

getViewTypeCount in class android.widget.BaseAdapter

getItemViewType

public int getItemViewType(int position)

Specified by:

getItemViewType in interface android.widget.Adapter

Overrides:

getItemViewType in class android.widget.BaseAdapter

isEnabled

public boolean isEnabled(int position)

Specified by:

isEnabled in interface android.widget.ListAdapter

Overrides:

isEnabled in class android.widget.BaseAdapter

Returns:

True if item at the position is header, false otherwise.

See Also:

isHeaderAt(int)

isHeaderAt

public boolean isHeaderAt(int position)

Checks whether item at the specified position is a header.

Parameters:

position - The position of item to check.

Returns:

True if item at the position is header, false otherwise.

isCategoryAt

public boolean isCategoryAt(int position)

Checks whether item at the specified position is a category.

Parameters:

position - The position of item to check.

Returns:

True if item at the position is category, false otherwise.

See Also:

isHeaderAt(int), isCategoryDividerAt(int)

isCategoryDividerAt

public boolean isCategoryDividerAt(int position)

Checks whether item at the specified position is a category divider.

Parameters:

position - The position of item to check.

Returns:

True if item at the position is category divider, false otherwise.

See Also:

isCategoryAt(int)

getView

public android.view.View getView(int position,
                                 @Nullable
                                 android.view.View convertView,
                                 @NonNull
                                 android.view.ViewGroup parent)

onCreateViewHolder

@NonNull
protected SettingHeadersAdapter.ViewHolder onCreateViewHolder(@NonNull
                                                                       android.view.ViewGroup parent,
                                                                       int viewType)

Invoked from getView(int, View, ViewGroup) in order to create a view holder along with its corresponding item view for the specified viewType.

Parameters:

parent - A parent view, to resolve correct layout params in case when the item view will be inflated from an Xml layout.

viewType - Type of the item view to be created with the holder. This is the same identifier as obtained via getItemViewType(int) for the position passed to getView(int, View, ViewGroup) method.

Returns:

New view holder with the item view of the requested type.

See Also:

inflateView(int, ViewGroup)

inflateView

@NonNull
public android.view.View inflateView(@LayoutRes
                                              int resource,
                                              @Nullable
                                              android.view.ViewGroup parent)

Inflates a new view hierarchy from the given xml resource.

Parameters:

resource - Resource id of a view to inflateView.

parent - A parent view, to resolve correct layout params for the newly creating view.

Returns:

The root view of the inflated view hierarchy.

See Also:

LayoutInflater.inflate(int, ViewGroup)

onBindViewHolder

protected void onBindViewHolder(@NonNull
                                SettingHeadersAdapter.ViewHolder viewHolder,
                                int position)

Invoked from getView(int, View, ViewGroup) in order to perform binding of the given viewHolder with data of the item from this adapter's data set at the specified position.

Parameters:

viewHolder - The view holder created via onCreateViewHolder(ViewGroup, int) with its corresponding item view to be bound with data.

position - Position of the item from the current data set of which data should be bound to the view holder.