de.mrapp.android.dialog.model

Interface ListDialogDecorator

All Superinterfaces:

Dialog

All Known Subinterfaces:

ListDialog, ScrollableDialog

All Known Implementing Classes:

AbstractListDialog, AbstractScrollableDialog, ListDialogDecorator, MaterialDialog

public interface ListDialogDecorator
extends Dialog

Defines the interface, a decorator, which allows to modify the view hierarchy of a dialog, which is designed according to Android 5's Material design guidelines even on pre-Lollipop devices and may contain list items, must implement.

Since:

3.2.0

Method Summary

Modifier and Type	Method and Description
int	getItemColor() Returns the color of the list items of the dialog.
android.widget.ListAdapter	getListAdapter() Returns the adapter of the list view, which is contained by the dialog.
android.widget.ListView	getListView() Returns the list view, which is contained by the dialog.
void	setAdapter(android.widget.ListAdapter adapter, android.content.DialogInterface.OnClickListener listener) Sets the adapter, which provides the items, which should be shown by the dialog.
void	setItemColor(int color) Sets the color of the list items of the dialog.
void	setItems(java.lang.CharSequence[] items, android.content.DialogInterface.OnClickListener listener) Sets the items, which should be shown by the dialog.
void	setItems(int resourceId, android.content.DialogInterface.OnClickListener listener) Sets the items, which should be shown by the dialog.
void	setMultiChoiceItems(java.lang.CharSequence[] items, boolean[] checkedItems, android.content.DialogInterface.OnMultiChoiceClickListener listener) Sets the selectable items, which should be shown by the dialog.
void	setMultiChoiceItems(int resourceId, boolean[] checkedItems, android.content.DialogInterface.OnMultiChoiceClickListener listener) Sets the selectable items, which should be shown by the dialog.
void	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.
void	setOnItemSelectedListener(android.widget.AdapterView.OnItemSelectedListener listener) Sets the listener, which should be notified, when an item, which is shown by the dialog is selected.
void	setSingleChoiceItems(java.lang.CharSequence[] items, int checkedItem, android.content.DialogInterface.OnClickListener listener) Sets the selectable items, which should be shown by the dialog.
void	setSingleChoiceItems(int resourceId, int checkedItem, android.content.DialogInterface.OnClickListener listener) Sets the selectable items, which should be shown by the dialog.
void	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.

Methods inherited from interface de.mrapp.android.dialog.model.Dialog

getContext

Method Detail

getListView

android.widget.ListView getListView()

Returns the list view, which is contained by the dialog.

Returns:

The list view, which is contained by the dialog, as an instance of the class ListView or null, if the dialog does not show any list items or has not been shown yet

getListAdapter

android.widget.ListAdapter getListAdapter()

Returns the adapter of the list view, which is contained by the dialog.

Returns:

The adapter of the list view, which is contained by the dialog, as an instance of the type ListAdapter or null, if the dialog does not show any list items

getItemColor

int getItemColor()

Returns the color of the list items of the dialog.

Returns:

The color of the list items of the dialog as an Integer value

setItemColor

void setItemColor(int color)

Sets the color of the list items of the dialog.

Parameters:

color - The color, which should be set, as an Integer value

setItems

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

Sets the items, which should be shown by the dialog. 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

setItems

void setItems(int resourceId,
              android.content.DialogInterface.OnClickListener listener)

Sets the items, which should be shown by the dialog. 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

setAdapter

void setAdapter(android.widget.ListAdapter adapter,
                android.content.DialogInterface.OnClickListener listener)

Sets the adapter, which provides the items, which should be shown by the dialog. 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

setSingleChoiceItems

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

Sets the selectable items, which should be shown by the dialog. 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

setSingleChoiceItems

void setSingleChoiceItems(int resourceId,
                          int checkedItem,
                          android.content.DialogInterface.OnClickListener listener)

Sets the selectable items, which should be shown by the dialog. 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

setSingleChoiceItems

void 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. 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

setMultiChoiceItems

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

Sets the selectable items, which should be shown by the dialog. 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.OnMultiChoiceClickListener or null, if no listener should be notified

setMultiChoiceItems

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

Sets the selectable items, which should be shown by the dialog. 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.OnMultiChoiceClickListener or null, if no listener should be notified

setMultiChoiceItems

void 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. 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

setOnItemSelectedListener

void setOnItemSelectedListener(android.widget.AdapterView.OnItemSelectedListener listener)

Sets the listener, which should be notified, when an item, which is shown by the dialog is selected. 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:

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