AlertDialog.Builder

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 alertDialogTheme within the parent context's theme.

Builder(context: Context, themeResId: @StyleRes Int)

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

fun create(): AlertDialog

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.

fun getContext(): Context

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.

fun setAdapter(
    adapter: ListAdapter!,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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.

fun setCancelable(cancelable: Boolean): AlertDialog.Builder!

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

fun setCursor(
    cursor: Cursor!,
    listener: DialogInterface.OnClickListener!,
    labelColumn: String!
): AlertDialog.Builder!

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.

fun setCustomTitle(customTitleView: View?): AlertDialog.Builder!

Set the title using the custom view customTitleView.

The methods setTitle and setIcon 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.

fun setIcon(icon: Drawable?): AlertDialog.Builder!

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.

fun setIcon(iconId: @DrawableRes Int): AlertDialog.Builder!

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

Takes precedence over values set using setIcon.

fun setIconAttribute(attrId: @AttrRes Int): AlertDialog.Builder!

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

Takes precedence over values set using setIcon or setIcon.

fun setInverseBackgroundForced(useInverseBackground: Boolean): AlertDialog.Builder!

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

fun setItems(
    items: Array<CharSequence!>!,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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.

fun setItems(itemsId: @ArrayRes Int, listener: DialogInterface.OnClickListener!): AlertDialog.Builder!

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

fun setMessage(message: CharSequence?): AlertDialog.Builder!

Set the message to display.

fun setMessage(messageId: @StringRes Int): AlertDialog.Builder!

Set the message to display using the given resource id.

fun setMultiChoiceItems(
    items: Array<CharSequence!>!,
    checkedItems: BooleanArray!,
    listener: DialogInterface.OnMultiChoiceClickListener!
): AlertDialog.Builder!

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.

fun setMultiChoiceItems(
    itemsId: @ArrayRes Int,
    checkedItems: BooleanArray!,
    listener: DialogInterface.OnMultiChoiceClickListener!
): AlertDialog.Builder!

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.

fun setMultiChoiceItems(
    cursor: Cursor!,
    isCheckedColumn: String!,
    labelColumn: String!,
    listener: DialogInterface.OnMultiChoiceClickListener!
): AlertDialog.Builder!

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.

fun setNegativeButton(
    text: CharSequence!,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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

fun setNegativeButton(
    textId: @StringRes Int,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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

fun setNegativeButtonIcon(icon: Drawable!): AlertDialog.Builder!

Set an icon to be displayed for the negative button.

fun setNeutralButton(
    text: CharSequence!,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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

fun setNeutralButton(
    textId: @StringRes Int,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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

fun setNeutralButtonIcon(icon: Drawable!): AlertDialog.Builder!

Set an icon to be displayed for the neutral button.

fun setOnCancelListener(onCancelListener: DialogInterface.OnCancelListener!): AlertDialog.Builder!

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

Even in a cancelable dialog, the dialog may be dismissed for reasons other than being canceled or one of the supplied choices being selected. If you are interested in listening for all cases where the dialog is dismissed and not just when it is canceled, see setOnDismissListener.

fun setOnDismissListener(
    onDismissListener: DialogInterface.OnDismissListener!
): AlertDialog.Builder!

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

fun setOnItemSelectedListener(listener: AdapterView.OnItemSelectedListener!): AlertDialog.Builder!

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

fun setOnKeyListener(onKeyListener: DialogInterface.OnKeyListener!): AlertDialog.Builder!

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

fun setPositiveButton(
    text: CharSequence!,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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

fun setPositiveButton(
    textId: @StringRes Int,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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

fun setPositiveButtonIcon(icon: Drawable!): AlertDialog.Builder!

Set an icon to be displayed for the positive button.

fun setSingleChoiceItems(
    adapter: ListAdapter!,
    checkedItem: Int,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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.

fun setSingleChoiceItems(
    items: Array<CharSequence!>!,
    checkedItem: Int,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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.

fun setSingleChoiceItems(
    itemsId: @ArrayRes Int,
    checkedItem: Int,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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.

fun setSingleChoiceItems(
    cursor: Cursor!,
    checkedItem: Int,
    labelColumn: String!,
    listener: DialogInterface.OnClickListener!
): AlertDialog.Builder!

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.

fun setTitle(title: CharSequence?): AlertDialog.Builder!

Set the title displayed in the Dialog.

fun setTitle(titleId: @StringRes Int): AlertDialog.Builder!

Set the title using the given resource id.

fun setView(layoutResId: Int): AlertDialog.Builder!

Inflates a custom view resource inside the dialog, below the message and above the buttons. If none of the other parts of the dialog are made visible, the custom view occupies the entire view. Because the view is inflated inside the parent dialog's view, take care not to define conflicting resource IDs.

fun setView(view: View!): AlertDialog.Builder!

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

When using a pre-Holo theme, if the supplied view is an instance of a ListView then the light background will be used.

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

fun show(): AlertDialog!

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

Calling this method is functionally identical to:

    AlertDialog dialog = builder.create();
    dialog.show();