DialogPreference

abstract class DialogPreference : Preference

Known direct subclasses
EditTextPreference

A DialogPreference that shows a EditText in the dialog.

ListPreference

A Preference that displays a list of entries as a dialog.

MultiSelectListPreference

A Preference that displays a list of entries as a dialog.

Known indirect subclasses
DropDownPreference

A ListPreference that presents the options in a drop down menu rather than a dialog.


A base class for Preferences that are dialog-based. When clicked, these preferences will open a dialog showing the actual preference controls.

name android:dialogTitle

name android:dialogMessage

name android:dialogIcon

name android:dialogLayout

name android:positiveButtonText

name android:negativeButtonText

Summary

Nested types

Interface for PreferenceFragmentCompats to implement to allow DialogPreferences to find the preference that launched the dialog.

Public constructors

DialogPreference(context: Context, attrs: AttributeSet?)
DialogPreference(context: Context, attrs: AttributeSet?, defStyleAttr: Int)
DialogPreference(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int
)

Public functions

Drawable?

Returns the icon to be shown on subsequent dialogs.

Int

Returns the layout resource that is used as the content view for subsequent dialogs.

CharSequence?

Returns the message to be shown on subsequent dialogs.

CharSequence?

Returns the title to be shown on subsequent dialogs.

CharSequence?

Returns the text of the negative button to be shown on subsequent dialogs.

CharSequence?

Returns the text of the positive button to be shown on subsequent dialogs.

Unit
setDialogIcon(dialogIcon: Drawable?)

Sets the icon of the dialog.

Unit
setDialogIcon(dialogIconRes: Int)

Sets the icon (resource ID) of the dialog.

Unit
setDialogLayoutResource(dialogLayoutResId: Int)

Sets the layout resource that is inflated as the View to be shown as the content view of subsequent dialogs.

Unit
setDialogMessage(dialogMessage: CharSequence?)

Sets the message of the dialog.

Unit
setDialogMessage(dialogMessageResId: Int)
Unit

Sets the title of the dialog.

Unit
setDialogTitle(dialogTitleResId: Int)
Unit
setNegativeButtonText(negativeButtonText: CharSequence?)

Sets the text of the negative button of the dialog.

Unit
setNegativeButtonText(negativeButtonTextResId: Int)
Unit
setPositiveButtonText(positiveButtonText: CharSequence?)

Sets the text of the positive button of the dialog.

Unit
setPositiveButtonText(positiveButtonTextResId: Int)

Protected functions

Unit

Processes a click on the preference.

Inherited Constants

From androidx.preference.Preference
const Int
DEFAULT_ORDER = 2147483647

Specify for setOrder if a specific order is not required.

Inherited functions

From java.lang.Comparable
abstract Int
compareTo(p: T!)
From androidx.preference.Preference
Boolean
callChangeListener(newValue: Any!)

Call this method after the user changes the preference, but before the internal state is set.

Int

Compares preference objects based on order (if set), otherwise alphabetically on the titles.

T?

Finds a preference in the entire hierarchy (above or below this preference) with the given key.

Context

Returns the Context of this preference.

String?

Returns the key of the dependency on this preference.

Bundle

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.

String?

Return the fragment class name associated with this preference.

Drawable?

Returns the icon of this preference.

Intent?

Return the Intent associated with this preference.

String!

Gets the key for this preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore.

Int

Gets the layout resource that will be shown as the View for this preference.

Preference.OnPreferenceChangeListener?

Returns the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

Preference.OnPreferenceClickListener?

Returns the callback to be invoked when this preference is clicked.

Int

Gets the order of this preference with respect to other preference objects on the same level.

PreferenceGroup?

Returns the PreferenceGroup which is this preference assigned to or null if this preference is not assigned to any group or is a root preference.

Boolean
getPersistedBoolean(defaultReturnValue: Boolean)

Attempts to get a persisted Boolean if this preference is persistent.

Float
getPersistedFloat(defaultReturnValue: Float)

Attempts to get a persisted Float if this preference is persistent.

Int
getPersistedInt(defaultReturnValue: Int)

Attempts to get a persisted Integer if this preference is persistent.

Long
getPersistedLong(defaultReturnValue: Long)

Attempts to get a persisted Long if this preference is persistent.

String!
getPersistedString(defaultReturnValue: String!)

Attempts to get a persisted set of Strings if this preference is persistent.

(Mutable)Set<String!>!
getPersistedStringSet(defaultReturnValue: (Mutable)Set<String!>!)

Attempts to get a persisted set of Strings if this preference is persistent.

PreferenceDataStore?

Returns PreferenceDataStore used by this preference.

PreferenceManager!

Gets the PreferenceManager that manages this preference object's tree.

SharedPreferences?

Returns the SharedPreferences where this preference can read its value(s).

Boolean

Checks whether this preference should disable its view when it's action is disabled.

CharSequence?

Returns the summary of this preference.

Preference.SummaryProvider?

Returns the SummaryProvider used to configure the summary of this preference.

CharSequence?

Returns the title of this preference.

Int

Gets the layout resource for the controllable widget portion of this preference.

Boolean

Checks whether this preference has a valid key.

Boolean

Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

Boolean

Checks whether this preference should be enabled in the list.

Boolean

Returns whether the space of this preference icon view is reserved.

Boolean

Checks whether this preference is persistent.

Boolean

Checks whether this preference should be selectable in the list.

Boolean

Checks whether this preference is shown to the user in the hierarchy.

Boolean

Gets whether the title of this preference is constrained to a single line.

Boolean

Checks whether this preference should be visible to the user.

Unit

Should be called when the data of this Preference has changed.

Unit
notifyDependencyChange(disableDependents: Boolean)

Notifies any listening dependents of a change that affects the dependency.

Unit

Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated.

Unit

Called when the preference hierarchy has been attached to the list of preferences.

Unit

Called when this preference has been attached to a preference hierarchy.

Unit

Binds the created View to the data for this preference.

Unit
onDependencyChanged(dependency: Preference, disableDependent: Boolean)

Called when the dependency changes.

Unit

Called when the preference hierarchy has been detached from the list of preferences.

Any?

Called when a preference is being inflated and the default value attribute needs to be read.

Unit

This function is deprecated.

Preferences aren't views.

Unit
onParentChanged(parent: Preference, disableChild: Boolean)

Called when the implicit parent dependency changes.

Unit

Called when this preference is being removed from the hierarchy.

Unit

Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState.

Parcelable?

Hook allowing a preference to generate a representation of its internal state that can later be used to create a new instance with that same state.

Unit
onSetInitialValue(defaultValue: Any?)

Implement this to set the initial value of the preference.

Unit
onSetInitialValue(restorePersistedValue: Boolean, defaultValue: Any!)

This function is deprecated.

Use onSetInitialValue instead.

Bundle?

Return the extras Bundle object associated with this preference, returning null if there is not currently one.

Boolean

Attempts to persist a Boolean if this preference is persistent.

Boolean

Attempts to persist a Float if this preference is persistent.

Boolean
persistInt(value: Int)

Attempts to persist an Integer if this preference is persistent.

Boolean
persistLong(value: Long)

Attempts to persist a Long if this preference is persistent.

Boolean

Attempts to persist a String if this preference is persistent.

Boolean

Attempts to persist a set of Strings if this preference is persistent.

Unit

Restore this preference hierarchy's previously saved state from the given container.

Unit

Store this preference hierarchy's frozen state into the given container.

Unit

Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

Unit
setDefaultValue(defaultValue: Any!)

Sets the default value for this preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.

Unit
setDependency(dependencyKey: String?)

Sets the key of a preference that this preference will depend on.

Unit
setEnabled(enabled: Boolean)

Sets whether this preference is enabled.

Unit
setFragment(fragment: String?)

Sets the class name of a fragment to be shown when this preference is clicked.

Unit
setIcon(icon: Drawable?)

Sets the icon for this preference with a Drawable.

Unit
setIcon(iconResId: Int)

Sets the icon for this preference with a resource ID.

Unit
setIconSpaceReserved(iconSpaceReserved: Boolean)

Sets whether to reserve the space of this preference icon view when no icon is provided.

Unit
setIntent(intent: Intent?)

Sets an Intent to be used for startActivity when this preference is clicked.

Unit
setKey(key: String!)

Sets the key for this preference, which is used as a key to the SharedPreferences or PreferenceDataStore.

Unit
setLayoutResource(layoutResId: Int)

Sets the layout resource that is inflated as the View to be shown for this preference.

Unit

Sets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

Unit

Sets the callback to be invoked when this preference is clicked.

Unit
setOrder(order: Int)

Sets the order of this preference with respect to other preference objects on the same level.

Unit
setPersistent(persistent: Boolean)

Sets whether this preference is persistent.

Unit

Sets a PreferenceDataStore to be used by this preference instead of using SharedPreferences.

Unit
setSelectable(selectable: Boolean)

Sets whether this preference is selectable.

Unit
setShouldDisableView(shouldDisableView: Boolean)

Sets whether this preference should disable its view when it gets disabled.

Unit
setSingleLineTitle(singleLineTitle: Boolean)

Sets whether to constrain the title of this preference to a single line instead of letting it wrap onto multiple lines.

Unit

Sets the summary for this preference with a CharSequence.

Unit
setSummary(summaryResId: Int)

Sets the summary for this preference with a resource ID.

Unit

Set a SummaryProvider that will be invoked whenever the summary of this preference is requested.

Unit

Sets the title for this preference with a CharSequence.

Unit
setTitle(titleResId: Int)

Sets the title for this preference with a resource ID.

Unit
setViewId(viewId: Int)

Set the ID that will be assigned to the overall View representing this preference, once bound.

Unit
setVisible(visible: Boolean)

Sets whether this preference should be visible to the user.

Unit
setWidgetLayoutResource(widgetLayoutResId: Int)

Sets the layout for the controllable widget portion of this preference.

Boolean

Checks whether this preference's dependents should currently be disabled.

Boolean

Checks whether, at the given time this method is called, this preference should store/restore its value(s) into the SharedPreferences or into PreferenceDataStore if assigned.

String

Public constructors

DialogPreference

Added in 1.0.0
DialogPreference(context: Context)

DialogPreference

Added in 1.0.0
DialogPreference(context: Context, attrs: AttributeSet?)

DialogPreference

Added in 1.0.0
DialogPreference(context: Context, attrs: AttributeSet?, defStyleAttr: Int)

DialogPreference

Added in 1.0.0
DialogPreference(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int
)

Public functions

getDialogIcon

Added in 1.0.0
fun getDialogIcon(): Drawable?

Returns the icon to be shown on subsequent dialogs.

Returns
Drawable?

The icon, as a Drawable

getDialogLayoutResource

Added in 1.0.0
fun getDialogLayoutResource(): Int

Returns the layout resource that is used as the content view for subsequent dialogs.

Returns
Int

The layout resource

getDialogMessage

Added in 1.0.0
fun getDialogMessage(): CharSequence?

Returns the message to be shown on subsequent dialogs.

Returns
CharSequence?

The message

getDialogTitle

Added in 1.0.0
fun getDialogTitle(): CharSequence?

Returns the title to be shown on subsequent dialogs.

Returns
CharSequence?

The title

getNegativeButtonText

Added in 1.0.0
fun getNegativeButtonText(): CharSequence?

Returns the text of the negative button to be shown on subsequent dialogs.

Returns
CharSequence?

The text of the negative button

getPositiveButtonText

Added in 1.0.0
fun getPositiveButtonText(): CharSequence?

Returns the text of the positive button to be shown on subsequent dialogs.

Returns
CharSequence?

The text of the positive button

setDialogIcon

Added in 1.0.0
fun setDialogIcon(dialogIcon: Drawable?): Unit

Sets the icon of the dialog. This will be shown on subsequent dialogs.

Parameters
dialogIcon: Drawable?

The icon, as a Drawable

setDialogIcon

Added in 1.0.0
fun setDialogIcon(dialogIconRes: Int): Unit

Sets the icon (resource ID) of the dialog. This will be shown on subsequent dialogs.

Parameters
dialogIconRes: Int

The icon, as a resource ID

setDialogLayoutResource

Added in 1.0.0
fun setDialogLayoutResource(dialogLayoutResId: Int): Unit

Sets the layout resource that is inflated as the View to be shown as the content view of subsequent dialogs.

Parameters
dialogLayoutResId: Int

The layout resource ID to be inflated

See also
setDialogMessage

setDialogMessage

Added in 1.0.0
fun setDialogMessage(dialogMessage: CharSequence?): Unit

Sets the message of the dialog. This will be shown on subsequent dialogs.

This message forms the content view of the dialog and conflicts with list-based dialogs, for example. If setting a custom View on a dialog via setDialogLayoutResource, include a android.widget.TextView with ID message and it will be populated with this message.

Parameters
dialogMessage: CharSequence?

The message

setDialogMessage

Added in 1.0.0
fun setDialogMessage(dialogMessageResId: Int): Unit
Parameters
dialogMessageResId: Int

The dialog message as a resource

See also
setDialogMessage

setDialogTitle

Added in 1.0.0
fun setDialogTitle(dialogTitle: CharSequence?): Unit

Sets the title of the dialog. This will be shown on subsequent dialogs.

Parameters
dialogTitle: CharSequence?

The title

setDialogTitle

Added in 1.0.0
fun setDialogTitle(dialogTitleResId: Int): Unit
Parameters
dialogTitleResId: Int

The dialog title as a resource

See also
setDialogTitle

setNegativeButtonText

Added in 1.0.0
fun setNegativeButtonText(negativeButtonText: CharSequence?): Unit

Sets the text of the negative button of the dialog. This will be shown on subsequent dialogs.

Parameters
negativeButtonText: CharSequence?

The text of the negative button

setNegativeButtonText

Added in 1.0.0
fun setNegativeButtonText(negativeButtonTextResId: Int): Unit
Parameters
negativeButtonTextResId: Int

The negative button text as a resource

setPositiveButtonText

Added in 1.0.0
fun setPositiveButtonText(positiveButtonText: CharSequence?): Unit

Sets the text of the positive button of the dialog. This will be shown on subsequent dialogs.

Parameters
positiveButtonText: CharSequence?

The text of the positive button

setPositiveButtonText

Added in 1.0.0
fun setPositiveButtonText(positiveButtonTextResId: Int): Unit
Parameters
positiveButtonTextResId: Int

The positive button text as a resource

Protected functions

onClick

protected fun onClick(): Unit

Processes a click on the preference. This includes saving the value to the SharedPreferences. However, the overridden method should call callChangeListener to make sure the client wants to update the preference's state with the new value.