Builder

class Builder
kotlin.Any
   ↳ androidx.car.app.CarListDialog.Builder

Builder class that can be used to create a CarListDialog by configuring the options for the list and behavior of the dialog.

Summary

Public constructors
<init>(context: Context!)

Creates a new instance of the Builder.
Public methods
CarListDialog.Builder!
setTitle(titleId: Int)

Sets the title of the dialog to be the given string resource.
CarListDialog.Builder!

Sets the title of the dialog for be the given string.
CarListDialog.Builder!

Sets the callback that will be called when the dialog is dismissed for any reason.
CarListDialog.Builder!
setCancelable(cancelable: Boolean)

Sets whether the dialog is cancelable or not.
CarListDialog.Builder!

Sets the callback that will be called if the dialog is canceled.
CarListDialog.Builder!
setItems(items: Array<String!>, onClickListener: OnClickListener?)

Sets the items that should appear in the list.
CarListDialog!

Creates an CarListDialog with the arguments supplied to this Builder.
CarListDialog.Builder!
setInitialPosition(initialPosition: Int)

Sets the initial position in the list that the CarListDialog will start at.

Public constructors

<init>

Builder(context: Context!)

Creates a new instance of the Builder.

Parameters
context Context!: The Context that the dialog is to be created in.

Public methods

setTitle

fun setTitle(titleId: Int): CarListDialog.Builder!

Sets the title of the dialog to be the given string resource.

Parameters
titleId Int: The resource id of the string to be used as the title.
Return
CarListDialog.Builder!: This Builder object to allow for chaining of calls.

setTitle

fun setTitle(title: CharSequence!): CarListDialog.Builder!

Sets the title of the dialog for be the given string.

Parameters
title CharSequence!: The string to be used as the title.
Return
CarListDialog.Builder!: This Builder object to allow for chaining of calls.

setOnDismissListener

fun setOnDismissListener(onDismissListener: OnDismissListener!): CarListDialog.Builder!

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

Return
CarListDialog.Builder!: This Builder object to allow for chaining of calls.

setCancelable

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

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

Return
CarListDialog.Builder!: This Builder object to allow for chaining of calls.

setOnCancelListener

fun setOnCancelListener(onCancelListener: OnCancelListener!): CarListDialog.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(OnDismissListener).

Parameters
onCancelListener OnCancelListener!: The listener to be invoked when this dialog is canceled.
Return
CarListDialog.Builder!: This Builder object to allow for chaining of calls.

setItems

fun setItems(items: Array<String!>, onClickListener: OnClickListener?): CarListDialog.Builder!

Sets the items that should appear in the list. The dialog will automatically dismiss itself when an item in the list is clicked on.

If a DialogInterface.OnClickListener is given, then it will be notified of the click. The dialog will still be dismissed afterwards. The which parameter of the DialogInterface.OnClickListener#onClick(DialogInterface, int) method will be the position of the item. This position maps to the index of the item in the given list.

The provided list of items cannot be null or empty. Passing an empty list to this method will throw can exception.

Parameters
items Array<String!>: The items that will appear in the list.
onClickListener Array<String!>: The listener that will be notified of a click.
Return
CarListDialog.Builder!: This Builder object to allow for chaining of calls.

create

fun create(): CarListDialog!

Creates an CarListDialog with the arguments supplied to this Builder.

If #setItems(String[],DialogInterface.OnClickListener) is never called, then calling this method will throw an exception.

Calling this method does not display the dialog. Utilize this dialog within a androidx.fragment.app.DialogFragment to show the dialog.

setInitialPosition

fun setInitialPosition(initialPosition: Int): CarListDialog.Builder!

Sets the initial position in the list that the CarListDialog will start at. When the dialog is created, the list will animate to the given position.

Parameters
initialPosition Int: The initial position in the list to display.
Return
CarListDialog.Builder!: This Builder object to allow for chaining of calls.