AlertDialog.Builder

public static class AlertDialog.Builder
extends Object

java.lang.Object
   ↳ androidx.appcompat.app.AlertDialog.Builder


Summary

Public constructors

Builder(Context context)

Creates a builder for an alert dialog that uses the default alert dialog theme.

Builder(Context context, int themeResId)

Creates a builder for an alert dialog that uses an explicit theme resource.

Public methods

AlertDialog create()

Creates an AlertDialog with the arguments supplied to this builder.

Context getContext()

Returns a Context with the appropriate theme for dialogs created by 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.

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 setIconAttribute(int attrId)

Set an icon as supplied by a theme attribute.

AlertDialog.Builder setInverseBackgroundForced(boolean useInverseBackground)

This method is deprecated. This flag is only used for pre-Material themes. Instead, specify the window background using on the alert dialog theme.

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 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 setMessage(int messageId)

Set the message to display using the given resource id.

AlertDialog.Builder setMessage(CharSequence message)

Set the message to display.

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 setNegativeButtonIcon(Drawable icon)

Set an icon to be displayed for the negative button.

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 setNeutralButtonIcon(Drawable icon)

Set an icon to be displayed for the neutral button.

AlertDialog.Builder setOnCancelListener(DialogInterface.OnCancelListener onCancelListener)

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

AlertDialog.Builder setOnDismissListener(DialogInterface.OnDismissListener onDismissListener)

Sets the callback that will be called when the dialog is dismissed for any reason.

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(int textId, DialogInterface.OnClickListener listener)

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

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 setPositiveButtonIcon(Drawable icon)

Set an icon to be displayed for the positive button.

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 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(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 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(int layoutResId)

Set a custom view resource to be the contents of the Dialog.

AlertDialog.Builder setView(View view)

Sets a custom view to be the contents of the alert dialog.

AlertDialog show()

Creates an AlertDialog with the arguments supplied to this builder and immediately displays the dialog.

Inherited methods

Public constructors

Builder

public Builder (Context context)

Creates a builder for an alert dialog that uses the default alert dialog theme.

The default alert dialog theme is defined by R.attr.alertDialogTheme within the parent context's theme.

Parameters
context Context: the parent context

Builder

public Builder (Context context, 
                int themeResId)

Creates a builder for an alert dialog that uses an explicit theme resource.

The specified theme resource (themeResId) is applied on top of the parent context's theme. It may be specified as a style resource containing a fully-populated theme, such as R.style.Theme_AppCompat_Dialog, to replace all attributes in the parent context's theme including primary and accent colors.

To preserve attributes such as primary and accent colors, the themeResId may instead be specified as an overlay theme such as R.style.ThemeOverlay_AppCompat_Dialog. This will override only the window attributes necessary to style the alert window as a dialog.

Alternatively, the themeResId may be specified as 0 to use the parent context's resolved value for R.attr.alertDialogTheme.

Parameters
context Context: the parent context

themeResId int: the resource ID of the theme against which to inflate this dialog, or 0 to use the parent context's default alert dialog theme

Public methods

create

public AlertDialog create ()

Creates an AlertDialog with the arguments supplied to this builder.

Calling this method does not display the dialog. If no additional processing is needed, show() may be called instead to both create and display the dialog.

Returns
AlertDialog

getContext

public Context getContext ()

Returns a Context with the appropriate theme for dialogs created by this Builder. Applications should use this Context for obtaining LayoutInflaters for inflating views that will be used in the resulting dialogs, as it will cause views to be inflated with the correct theme.

Returns
Context A Context for built Dialogs.

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 ListAdapter: The ListAdapter to supply the list of items

listener DialogInterface.OnClickListener: The listener that will be called when an item is clicked.

Returns
AlertDialog.Builder This Builder object to allow for chaining of calls to set methods

setCancelable

public AlertDialog.Builder setCancelable (boolean cancelable)

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

Parameters
cancelable boolean

Returns
AlertDialog.Builder This Builder object to allow for chaining of calls to set methods

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 Cursor: The Cursor to supply the list of items

listener DialogInterface.OnClickListener: The listener that will be called when an item is clicked.

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

Returns
AlertDialog.Builder This Builder object to allow for chaining of calls to set methods

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.

Note: To ensure consistent styling, the custom view should be inflated or constructed using the alert dialog's themed context obtained via getContext().

Parameters
customTitleView View: the custom view to use as the title

Returns
AlertDialog.Builder this Builder object to allow for chaining of calls to set methods

setIcon

public AlertDialog.Builder setIcon (Drawable icon)

Set the Drawable to be used in the title.

Note: To ensure consistent styling, the drawable should be inflated or constructed using the alert dialog's themed context obtained via getContext().

Parameters
icon Drawable

Returns
AlertDialog.Builder this Builder object to allow for chaining of calls to set methods

setIcon

public AlertDialog.Builder setIcon (int iconId)

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

Takes precedence over values set using setIcon(Drawable).

Parameters
iconId int

Returns
AlertDialog.Builder This Builder object to allow for chaining of calls to set methods

setIconAttribute

public AlertDialog.Builder setIconAttribute (int attrId)

Set an icon as supplied by a theme attribute. e.g. R.attr.alertDialogIcon.

Takes precedence over values set using setIcon(int) or setIcon(Drawable).

Parameters
attrId int: ID of a theme attribute that points to a drawable resource.

Returns
AlertDialog.Builder

setInverseBackgroundForced

public AlertDialog.Builder setInverseBackgroundForced (boolean useInverseBackground)

This method is deprecated.
This flag is only used for pre-Material themes. Instead, specify the window background using on the alert dialog theme.

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

Parameters
useInverseBackground boolean: Whether to use the inverse background

Returns
AlertDialog.Builder This Builder object to allow for chaining of calls to set methods

setItems

public