de.mrapp.android.dialog.builder

Class AbstractListDialogBuilder<DialogType extends ListDialog,BuilderType extends AbstractListDialogBuilder<DialogType,?>>

java.lang.Object

de.mrapp.android.dialog.builder.AbstractMaterialDialogBuilder<DialogType,BuilderType>

de.mrapp.android.dialog.builder.AbstractHeaderDialogBuilder<DialogType,BuilderType>

de.mrapp.android.dialog.builder.AbstractValidateableDialogBuilder<DialogType,BuilderType>

de.mrapp.android.dialog.builder.AbstractButtonBarDialogBuilder<DialogType,BuilderType>

de.mrapp.android.dialog.builder.AbstractListDialogBuilder<DialogType,BuilderType>

Type Parameters:

DialogType - The type of the dialog, which is created by the builder

BuilderType - The type of the builder

Direct Known Subclasses:

AbstractScrollableDialogBuilder

public abstract class AbstractListDialogBuilder<DialogType extends ListDialog,BuilderType extends AbstractListDialogBuilder<DialogType,?>>
extends AbstractButtonBarDialogBuilder<DialogType,BuilderType>

An abstract base class for all builders, which allow to create and show dialogs, which are designed according to Android Material Design guidelines even on pre-Lollipop devices and may contain list items.

Since:

3.3.0

Constructor Summary

Constructors

Constructor and Description
AbstractListDialogBuilder(android.content.Context context) Creates a new builder, which allows to create dialogs, which allow to create and show dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and may contain list items.
AbstractListDialogBuilder(android.content.Context context, int themeResourceId) Creates a new builder, which allows to create dialogs, which allow to create and show dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and may contain list items.

Method Summary

Modifier and Type	Method and Description
protected void	obtainStyledAttributes(int themeResourceId) Obtains all relevant attributes from the current theme.
BuilderType	setAdapter(android.widget.ListAdapter adapter, android.content.DialogInterface.OnClickListener listener) Sets the adapter, which provides the items, which should be shown by the dialog, which is created by the builder.
BuilderType	setItemColor(int color) Sets the color of the list items of the dialog, which is created by the builder.
BuilderType	setItems(java.lang.CharSequence[] items, android.content.DialogInterface.OnClickListener listener) Sets the items, which should be shown by the dialog, which is created by the builder.
BuilderType	setItems(int resourceId, android.content.DialogInterface.OnClickListener listener) Sets the items, which should be shown by the dialog, which is created by the builder.
BuilderType	setMultiChoiceItems(java.lang.CharSequence[] items, boolean[] checkedItems, android.content.DialogInterface.OnMultiChoiceClickListener listener) Sets the selectable items, which should be shown by the dialog, which is created by the builder.
BuilderType	setMultiChoiceItems(int resourceId, boolean[] checkedItems, android.content.DialogInterface.OnMultiChoiceClickListener listener) Sets the selectable items, which should be shown by the dialog, which is created by the builder.
BuilderType	setMultiChoiceItems(android.widget.ListAdapter adapter, boolean[] checkedItems, android.content.DialogInterface.OnMultiChoiceClickListener listener) Sets the adapter, which provides the selectable items, which should be shown by the dialog, which is created by the builder.
BuilderType	setOnItemSelectedListener(android.widget.AdapterView.OnItemSelectedListener listener) Sets the listener, which should be notified, when an item, which is shown by the dialog, which is created by the builder, is selected.
BuilderType	setSingleChoiceItems(java.lang.CharSequence[] items, int checkedItem, android.content.DialogInterface.OnClickListener listener) Sets the selectable items, which should be shown by the dialog, which is created by the builder.
BuilderType	setSingleChoiceItems(int resourceId, int checkedItem, android.content.DialogInterface.OnClickListener listener) Sets the selectable items, which should be shown by the dialog, which is created by the builder.
BuilderType	setSingleChoiceItems(android.widget.ListAdapter adapter, int checkedItem, android.content.DialogInterface.OnClickListener listener) Sets the adapter, which provides the selectable items, which should be shown by the dialog, which is created by the builder.

Methods inherited from class de.mrapp.android.dialog.builder.AbstractButtonBarDialogBuilder

setButtonBarDividerColor, setButtonTextColor, setNegativeButton, setNegativeButton, setNeutralButton, setNeutralButton, setPositiveButton, setPositiveButton, showButtonBarDivider, stackButtons

Methods inherited from class de.mrapp.android.dialog.builder.AbstractValidateableDialogBuilder

addAllValidators, addValidator

Methods inherited from class de.mrapp.android.dialog.builder.AbstractHeaderDialogBuilder

setHeaderBackground, setHeaderBackground, setHeaderBackgroundColor, setHeaderDividerColor, setHeaderHeight, setHeaderIcon, setHeaderIcon, showHeader, showHeaderDivider

Methods inherited from class de.mrapp.android.dialog.builder.AbstractMaterialDialogBuilder

create, getContext, getDialog, onCreateDialog, self, setBackground, setBackground, setBackgroundColor, setCancelable, setCustomMessage, setCustomMessage, setCustomTitle, setCustomTitle, setIcon, setIcon, setIconAttribute, setMessage, setMessage, setMessageColor, setOnCancelListener, setOnDismissListener, setOnShowListener, setTitle, setTitle, setTitleColor, setView, setView

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractListDialogBuilder

public AbstractListDialogBuilder(android.content.Context context)

Creates a new builder, which allows to create dialogs, which allow to create and show dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and may contain list items.

Parameters:

context - The context, which should be used by the builder, as an instance of the class Context. The context may not be null

AbstractListDialogBuilder

public AbstractListDialogBuilder(android.content.Context context,
                                 int themeResourceId)

Creates a new builder, which allows to create dialogs, which allow to create and show dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and may contain list items.

Parameters:

context - The context, which should be used by the builder, as an instance of the class Context. The context may not be null

themeResourceId - The resource id of the theme, which should be used by the dialog, as an Integer value. The resource id must correspond to a valid theme

Method Detail

setItemColor

public final BuilderType setItemColor(int color)

Sets the color of the list items of the dialog, which is created by the builder.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom color should be set

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setItems

public final BuilderType setItems(java.lang.CharSequence[] items,
                                  android.content.DialogInterface.OnClickListener listener)

Sets the items, which should be shown by the dialog, which is created by the builder. Note, that the attached listener is not stored using a dialog's onSaveInstanceState-method, because it is not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-register the listener.

Parameters:

items - The items, which should be set, as an array of the type CharSequence. The items may not be null

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setItems

public final BuilderType setItems(int resourceId,
                                  android.content.DialogInterface.OnClickListener listener)

Sets the items, which should be shown by the dialog, which is created by the builder. Note, that the attached listener is not stored using a dialog's onSaveInstanceState-method, because it is not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-register the listener.

Parameters:

resourceId - The resource id of the items, which should be set, as an Integer value. The resource id must correspond to a valid array resource

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setAdapter

public final BuilderType setAdapter(android.widget.ListAdapter adapter,
                                    android.content.DialogInterface.OnClickListener listener)

Sets the adapter, which provides the items, which should be shown by the dialog, which is created by the builder. Note, that the adapter and the attached listener are not stored using a dialog's onSaveInstanceState-method, because they are not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-set the adapter and re-register the listener.

Parameters:

adapter - The adapter, which should be set, as an instance of the type ListAdapter. The adapter may not be null

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setSingleChoiceItems

public final BuilderType setSingleChoiceItems(java.lang.CharSequence[] items,
                                              int checkedItem,
                                              android.content.DialogInterface.OnClickListener listener)

Sets the selectable items, which should be shown by the dialog, which is created by the builder. Only one of the items can be selected at once. Note, that the attached listener is not stored using a dialog's onSaveInstanceState-method, because it is not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-register the listener.

Parameters:

items - The items, which should be set, as an array of the type CharSequence. The items may not be null

checkedItem - The index of the item, which should be selected by default, as an Integer value or -1, if no item should be selected by default

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setSingleChoiceItems

public final BuilderType setSingleChoiceItems(int resourceId,
                                              int checkedItem,
                                              android.content.DialogInterface.OnClickListener listener)

Sets the selectable items, which should be shown by the dialog, which is created by the builder. Only one of the items can be selected at once. Note, that the attached listener is not stored using a dialog's onSaveInstanceState-method, because it is not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-register the listener.

Parameters:

resourceId - The resource id of the items, which should be set, as an Integer value. The resource id must correspond to a valid array resource

checkedItem - The index of the item, which should be selected by default, as an Integer value or -1, if no item should be selected by default

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setSingleChoiceItems

public final BuilderType setSingleChoiceItems(android.widget.ListAdapter adapter,
                                              int checkedItem,
                                              android.content.DialogInterface.OnClickListener listener)

Sets the adapter, which provides the selectable items, which should be shown by the dialog, which is created by the builder. Only one of the items can be selected at once. Note, that the adapter and the attached listener are not stored using a dialog's onSaveInstanceState-method, because they are not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-set the adapter and re-register the listener.

Parameters:

adapter - The adapter, which should be set, as an instance of the type ListAdapter. The adapter may not be null

checkedItem - The index of the item, which should be selected by default, as an Integer value or -1, if no item should be selected by default

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setMultiChoiceItems

public final BuilderType setMultiChoiceItems(java.lang.CharSequence[] items,
                                             boolean[] checkedItems,
                                             android.content.DialogInterface.OnMultiChoiceClickListener listener)

Sets the selectable items, which should be shown by the dialog, which is created by the builder. Multiple items can be selected at once. Note, that the attached listener is not stored using a dialog's onSaveInstanceState-method, because it is not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-register the listener.

Parameters:

items - The items, which should be set, as an array of the type CharSequence. The items may not be null

checkedItems - An array, which contains, whether the items, which correspond to the corresponding indices, should be selected by default, or not, as a Boolean array or null, if no items should be selected by default

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setMultiChoiceItems

public final BuilderType setMultiChoiceItems(int resourceId,
                                             boolean[] checkedItems,
                                             android.content.DialogInterface.OnMultiChoiceClickListener listener)

Sets the selectable items, which should be shown by the dialog, which is created by the builder. Multiple items can be selected at once. Note, that the attached listener is not stored using a dialog's onSaveInstanceState-method, because it is not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-register the listener.

Parameters:

resourceId - The resource id of the items, which should be set, as an Integer value. The resource id must correspond to a valid array resource

checkedItems - An array, which contains, whether the items, which correspond to the corresponding indices, should be selected by default, or not, as a Boolean array or null, if no items should be selected by default

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setMultiChoiceItems

public final BuilderType setMultiChoiceItems(android.widget.ListAdapter adapter,
                                             boolean[] checkedItems,
                                             android.content.DialogInterface.OnMultiChoiceClickListener listener)

Sets the adapter, which provides the selectable items, which should be shown by the dialog, which is created by the builder. Multiple items can be selected at once. Note, that the adapter and the attached listener are not stored using a dialog's onSaveInstanceState-method, because they are not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-set the adapter and re-register the listener.

Parameters:

adapter - The adapter, which should be set, as an instance of the type ListAdapter. The adapter may not be null

checkedItems - An array, which contains, whether the items, which correspond to the corresponding indices, should be selected by default, or not, as a Boolean array or null, if no items should be selected by default

listener - The listener, which should be notified, when an item is clicked, as an instance of the type DialogInterface.OnMultiChoiceClickListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

setOnItemSelectedListener

public final BuilderType setOnItemSelectedListener(android.widget.AdapterView.OnItemSelectedListener listener)

Sets the listener, which should be notified, when an item, which is shown by the dialog, which is created by the builder, is selected.

Parameters:

listener - The listener, which should be set, as an instance of the type AdapterView.OnItemSelectedListener or null, if no listener should be notified

Returns:

The builder, the method has been called upon, as an instance of the generic type BuilderType

obtainStyledAttributes

protected void obtainStyledAttributes(int themeResourceId)

Description copied from class: AbstractMaterialDialogBuilder

Obtains all relevant attributes from the current theme.

Overrides:

obtainStyledAttributes in class AbstractButtonBarDialogBuilder<DialogType extends ListDialog,BuilderType extends AbstractListDialogBuilder<DialogType,?>>

Parameters:

themeResourceId - The resource id of the theme, which should be used by the dialog, as an Integer value. The resource id must correspond to a valid style resource