android.app
Class AlertDialog.Builder

java.lang.Object
  android.app.AlertDialog.Builder

Enclosing class:

AlertDialog

public static class AlertDialog.Builder
extends Object

Constructor Summary

AlertDialog.Builder(Context context)
Constructor using a context for this builder and the AlertDialog it creates.

Method Summary

AlertDialog	create() Creates a AlertDialog with the arguments supplied to this builder.
AlertDialog.Builder	setAdapter(ListAdapter adapter, DialogInterface.OnClickListener listener) Set a list of items, which are supplied by the given ListAdapter, to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setCancelable(boolean cancelable) Sets whether the dialog is cancelable or not default is true.
AlertDialog.Builder	setCursor(Cursor cursor, DialogInterface.OnClickListener listener, String labelColumn) Set a list of items, which are supplied by the given Cursor, to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setCustomTitle(View customTitleView) Set the title using the custom view customTitleView.
AlertDialog.Builder	setIcon(Drawable icon) Set the Drawable to be used in the title.
AlertDialog.Builder	setIcon(int iconId) Set the resource id of the Drawable to be used in the title.
AlertDialog.Builder	setInverseBackgroundForced(boolean useInverseBackground) Sets the Dialog to use the inverse background, regardless of what the contents is.
AlertDialog.Builder	setItems(CharSequence[] items, DialogInterface.OnClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setItems(int itemsId, DialogInterface.OnClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setMessage(CharSequence message) Set the message to display.
AlertDialog.Builder	setMessage(int messageId) Set the message to display using the given resource id.
AlertDialog.Builder	setMultiChoiceItems(CharSequence[] items, boolean[] checkedItems, DialogInterface.OnMultiChoiceClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setMultiChoiceItems(Cursor cursor, String isCheckedColumn, String labelColumn, DialogInterface.OnMultiChoiceClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setMultiChoiceItems(int itemsId, boolean[] checkedItems, DialogInterface.OnMultiChoiceClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setNegativeButton(CharSequence text, DialogInterface.OnClickListener listener) Set a listener to be invoked when the negative button of the dialog is pressed.
AlertDialog.Builder	setNegativeButton(int textId, DialogInterface.OnClickListener listener) Set a listener to be invoked when the negative button of the dialog is pressed.
AlertDialog.Builder	setNeutralButton(CharSequence text, DialogInterface.OnClickListener listener) Set a listener to be invoked when the neutral button of the dialog is pressed.
AlertDialog.Builder	setNeutralButton(int textId, DialogInterface.OnClickListener listener) Set a listener to be invoked when the neutral button of the dialog is pressed.
AlertDialog.Builder	setOnCancelListener(DialogInterface.OnCancelListener onCancelListener) Sets the callback that will be called if the dialog is canceled.
AlertDialog.Builder	setOnItemSelectedListener(AdapterView.OnItemSelectedListener listener) Sets a listener to be invoked when an item in the list is selected.
AlertDialog.Builder	setOnKeyListener(DialogInterface.OnKeyListener onKeyListener) Sets the callback that will be called if a key is dispatched to the dialog.
AlertDialog.Builder	setPositiveButton(CharSequence text, DialogInterface.OnClickListener listener) Set a listener to be invoked when the positive button of the dialog is pressed.
AlertDialog.Builder	setPositiveButton(int textId, DialogInterface.OnClickListener listener) Set a listener to be invoked when the positive button of the dialog is pressed.
AlertDialog.Builder	setSingleChoiceItems(CharSequence[] items, int checkedItem, DialogInterface.OnClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setSingleChoiceItems(Cursor cursor, int checkedItem, String labelColumn, DialogInterface.OnClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setSingleChoiceItems(int itemsId, int checkedItem, DialogInterface.OnClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setSingleChoiceItems(ListAdapter adapter, int checkedItem, DialogInterface.OnClickListener listener) Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.
AlertDialog.Builder	setTitle(CharSequence title) Set the title displayed in the Dialog.
AlertDialog.Builder	setTitle(int titleId) Set the title using the given resource id.
AlertDialog.Builder	setView(View view) Set a custom view to be the contents of the Dialog.
AlertDialog	show() Creates a AlertDialog with the arguments supplied to this builder and Dialog.show()'s the dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertDialog.Builder

public AlertDialog.Builder(Context context)

Constructor using a context for this builder and the AlertDialog it creates.

Method Detail

setTitle

public AlertDialog.Builder setTitle(int titleId)

Set the title using the given resource id.

setTitle

public AlertDialog.Builder setTitle(CharSequence title)

Set the title displayed in the Dialog.

setCustomTitle

public AlertDialog.Builder setCustomTitle(View customTitleView)

Set the title using the custom view customTitleView. The methods setTitle(int) and setIcon(int) should be sufficient for most titles, but this is provided if the title needs more customization. Using this will replace the title and icon set via the other methods.

Parameters:

customTitleView - The custom view to use as the title.

setMessage

public AlertDialog.Builder setMessage(int messageId)

Set the message to display using the given resource id.

setMessage

public AlertDialog.Builder setMessage(CharSequence message)

Set the message to display.

setIcon

public AlertDialog.Builder setIcon(int iconId)

Set the resource id of the Drawable to be used in the title.

setIcon

public AlertDialog.Builder setIcon(Drawable icon)

Set the Drawable to be used in the title.

setPositiveButton

public AlertDialog.Builder setPositiveButton(int textId,
                                             DialogInterface.OnClickListener listener)

Set a listener to be invoked when the positive button of the dialog is pressed.

Parameters:

textId - The resource id of the text to display in the positive button

listener - The DialogInterface.OnClickListener to use.

setPositiveButton

public AlertDialog.Builder setPositiveButton(CharSequence text,
                                             DialogInterface.OnClickListener listener)

Set a listener to be invoked when the positive button of the dialog is pressed.

Parameters:

text - The text to display in the positive button

listener - The DialogInterface.OnClickListener to use.

setNegativeButton

public AlertDialog.Builder setNegativeButton(int textId,
                                             DialogInterface.OnClickListener listener)

Set a listener to be invoked when the negative button of the dialog is pressed.

Parameters:

textId - The resource id of the text to display in the negative button

listener - The DialogInterface.OnClickListener to use.

setNegativeButton

public AlertDialog.Builder setNegativeButton(CharSequence text,
                                             DialogInterface.OnClickListener listener)

Set a listener to be invoked when the negative button of the dialog is pressed.

Parameters:

text - The text to display in the negative button

listener - The DialogInterface.OnClickListener to use.

setNeutralButton

public AlertDialog.Builder setNeutralButton(int textId,
                                            DialogInterface.OnClickListener listener)

Set a listener to be invoked when the neutral button of the dialog is pressed.

Parameters:

textId - The resource id of the text to display in the neutral button

listener - The DialogInterface.OnClickListener to use.

setNeutralButton

public AlertDialog.Builder setNeutralButton(CharSequence text,
                                            DialogInterface.OnClickListener listener)

Set a listener to be invoked when the neutral button of the dialog is pressed.

Parameters:

text - The text to display in the neutral button

listener - The DialogInterface.OnClickListener to use.

setCancelable

public AlertDialog.Builder setCancelable(boolean cancelable)

Sets whether the dialog is cancelable or not default is true.

setOnCancelListener

public AlertDialog.Builder setOnCancelListener(DialogInterface.OnCancelListener onCancelListener)

Sets the callback that will be called if the dialog is canceled.

See Also:

setCancelable(boolean)

setOnKeyListener

public AlertDialog.Builder setOnKeyListener(DialogInterface.OnKeyListener onKeyListener)

Sets the callback that will be called if a key is dispatched to the dialog.

setItems

public AlertDialog.Builder setItems(int itemsId,
                                    DialogInterface.OnClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. This should be an array type i.e. R.array.foo

setItems

public AlertDialog.Builder setItems(CharSequence[] items,
                                    DialogInterface.OnClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.

setAdapter

public AlertDialog.Builder setAdapter(ListAdapter adapter,
                                      DialogInterface.OnClickListener listener)

Set a list of items, which are supplied by the given ListAdapter, to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.

Parameters:

adapter - The ListAdapter to supply the list of items

listener - The listener that will be called when an item is clicked.

setCursor

public AlertDialog.Builder setCursor(Cursor cursor,
                                     DialogInterface.OnClickListener listener,
                                     String labelColumn)

Set a list of items, which are supplied by the given Cursor, to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener.

Parameters:

cursor - The Cursor to supply the list of items

listener - The listener that will be called when an item is clicked.

labelColumn - The column name on the cursor containing the string to display in the label.

setMultiChoiceItems

public AlertDialog.Builder setMultiChoiceItems(int itemsId,
                                               boolean[] checkedItems,
                                               DialogInterface.OnMultiChoiceClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. This should be an array type, e.g. R.array.foo. The list will have a check mark displayed to the right of the text for each checked item. Clicking on an item in the list will not dismiss the dialog. Clicking on a button will dismiss the dialog.

Parameters:

itemsId - the resource id of an array i.e. R.array.foo

checkedItems - specifies which items are checked. It should be null in which case no items are checked. If non null it must be exactly the same length as the array of items.

listener - notified when an item on the list is clicked. The dialog will not be dismissed when an item is clicked. It will only be dismissed if clicked on a button, if no buttons are supplied it's up to the user to dismiss the dialog.

setMultiChoiceItems

public AlertDialog.Builder setMultiChoiceItems(CharSequence[] items,
                                               boolean[] checkedItems,
                                               DialogInterface.OnMultiChoiceClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. The list will have a check mark displayed to the right of the text for each checked item. Clicking on an item in the list will not dismiss the dialog. Clicking on a button will dismiss the dialog.

Parameters:

items - the text of the items to be displayed in the list.

checkedItems - specifies which items are checked. It should be null in which case no items are checked. If non null it must be exactly the same length as the array of items.

listener - notified when an item on the list is clicked. The dialog will not be dismissed when an item is clicked. It will only be dismissed if clicked on a button, if no buttons are supplied it's up to the user to dismiss the dialog.

setMultiChoiceItems

public AlertDialog.Builder setMultiChoiceItems(Cursor cursor,
                                               String isCheckedColumn,
                                               String labelColumn,
                                               DialogInterface.OnMultiChoiceClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. The list will have a check mark displayed to the right of the text for each checked item. Clicking on an item in the list will not dismiss the dialog. Clicking on a button will dismiss the dialog.

Parameters:

cursor - the cursor used to provide the items.

isCheckedColumn - specifies the column name on the cursor to use to determine whether a checkbox is checked or not. It must return an integer value where 1 means checked and 0 means unchecked.

labelColumn - The column name on the cursor containing the string to display in the label.

listener - notified when an item on the list is clicked. The dialog will not be dismissed when an item is clicked. It will only be dismissed if clicked on a button, if no buttons are supplied it's up to the user to dismiss the dialog.

setSingleChoiceItems

public AlertDialog.Builder setSingleChoiceItems(int itemsId,
                                                int checkedItem,
                                                DialogInterface.OnClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. This should be an array type i.e. R.array.foo The list will have a check mark displayed to the right of the text for the checked item. Clicking on an item in the list will not dismiss the dialog. Clicking on a button will dismiss the dialog.

Parameters:

itemsId - the resource id of an array i.e. R.array.foo

checkedItem - specifies which item is checked. If -1 no items are checked.

listener - notified when an item on the list is clicked. The dialog will not be dismissed when an item is clicked. It will only be dismissed if clicked on a button, if no buttons are supplied it's up to the user to dismiss the dialog.

setSingleChoiceItems

public AlertDialog.Builder setSingleChoiceItems(Cursor cursor,
                                                int checkedItem,
                                                String labelColumn,
                                                DialogInterface.OnClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. The list will have a check mark displayed to the right of the text for the checked item. Clicking on an item in the list will not dismiss the dialog. Clicking on a button will dismiss the dialog.

Parameters:

cursor - the cursor to retrieve the items from.

checkedItem - specifies which item is checked. If -1 no items are checked.

labelColumn - The column name on the cursor containing the string to display in the label.

listener - notified when an item on the list is clicked. The dialog will not be dismissed when an item is clicked. It will only be dismissed if clicked on a button, if no buttons are supplied it's up to the user to dismiss the dialog.

setSingleChoiceItems

public AlertDialog.Builder setSingleChoiceItems(CharSequence[] items,
                                                int checkedItem,
                                                DialogInterface.OnClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. The list will have a check mark displayed to the right of the text for the checked item. Clicking on an item in the list will not dismiss the dialog. Clicking on a button will dismiss the dialog.

Parameters:

items - the items to be displayed.

checkedItem - specifies which item is checked. If -1 no items are checked.

listener - notified when an item on the list is clicked. The dialog will not be dismissed when an item is clicked. It will only be dismissed if clicked on a button, if no buttons are supplied it's up to the user to dismiss the dialog.

setSingleChoiceItems

public AlertDialog.Builder setSingleChoiceItems(ListAdapter adapter,
                                                int checkedItem,
                                                DialogInterface.OnClickListener listener)

Set a list of items to be displayed in the dialog as the content, you will be notified of the selected item via the supplied listener. The list will have a check mark displayed to the right of the text for the checked item. Clicking on an item in the list will not dismiss the dialog. Clicking on a button will dismiss the dialog.

Parameters:

adapter - The ListAdapter to supply the list of items

checkedItem - specifies which item is checked. If -1 no items are checked.

listener - notified when an item on the list is clicked. The dialog will not be dismissed when an item is clicked. It will only be dismissed if clicked on a button, if no buttons are supplied it's up to the user to dismiss the dialog.

setOnItemSelectedListener

public AlertDialog.Builder setOnItemSelectedListener(AdapterView.OnItemSelectedListener listener)

Sets a listener to be invoked when an item in the list is selected.

Parameters:

listener - The listener to be invoked.

See Also:

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

setView

public AlertDialog.Builder setView(View view)

Set a custom view to be the contents of the Dialog. If the supplied view is an instance of a ListView the light background will be used.

setInverseBackgroundForced

public AlertDialog.Builder setInverseBackgroundForced(boolean useInverseBackground)

Sets the Dialog to use the inverse background, regardless of what the contents is.

Parameters:

useInverseBackground - Whether to use the inverse background

Returns:

This Builder object to allow for chaining of sets.

create

public AlertDialog create()

Creates a AlertDialog with the arguments supplied to this builder. It does not Dialog.show() the dialog. This allows the user to do any extra processing before displaying the dialog. Use show() if you don't have any other processing to do and want this to be created and displayed.

show

public AlertDialog show()

Creates a AlertDialog with the arguments supplied to this builder and Dialog.show()'s the dialog.