added in version 24.1.0
belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1

Summary: Nested Classes | Inherited XML Attrs | Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

DialogPreference

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public abstract class DialogPreference
extends Preference

java.lang.Object
↳	android.support.v7.preference.Preference
	↳	android.support.v7.preference.DialogPreference

Known Direct Subclasses EditTextPreference,ListPreference,MultiSelectListPreference EditTextPreference A Preference that allows for string input.  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 DropDownPreference A version of ListPreference that presents the options in a drop down menu rather than a dialog.

---

A base class for Preference objects that are dialog-based. These preferences will, when clicked, open a dialog showing the actual preference controls.

Summary

Nested classes
interface	DialogPreference.TargetFragment

Inherited XML attributes
From class android.support.v7.preference.Preference Preference_android_iconSpaceReserved   Preference_android_singleLineTitle

Inherited constants
From class android.support.v7.preference.Preference int DEFAULT_ORDER Specify for setOrder(int) if a specific order is not required.

Public constructors
DialogPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
DialogPreference(Context context, AttributeSet attrs, int defStyleAttr)
DialogPreference(Context context, AttributeSet attrs)
DialogPreference(Context context)

Public methods
Drawable	getDialogIcon() Returns the icon to be shown on subsequent dialogs.
int	getDialogLayoutResource() Returns the layout resource that is used as the content View for subsequent dialogs.
CharSequence	getDialogMessage() Returns the message to be shown on subsequent dialogs.
CharSequence	getDialogTitle() Returns the title to be shown on subsequent dialogs.
CharSequence	getNegativeButtonText() Returns the text of the negative button to be shown on subsequent dialogs.
CharSequence	getPositiveButtonText() Returns the text of the positive button to be shown on subsequent dialogs.
void	setDialogIcon(int dialogIconRes) Sets the icon (resource ID) of the dialog.
void	setDialogIcon(Drawable dialogIcon) Sets the icon of the dialog.
void	setDialogLayoutResource(int dialogLayoutResId) Sets the layout resource that is inflated as the View to be shown as the content View of subsequent dialogs.
void	setDialogMessage(CharSequence dialogMessage) Sets the message of the dialog.
void	setDialogMessage(int dialogMessageResId)
void	setDialogTitle(int dialogTitleResId)
void	setDialogTitle(CharSequence dialogTitle) Sets the title of the dialog.
void	setNegativeButtonText(CharSequence negativeButtonText) Sets the text of the negative button of the dialog.
void	setNegativeButtonText(int negativeButtonTextResId)
void	setPositiveButtonText(int positiveButtonTextResId)
void	setPositiveButtonText(CharSequence positiveButtonText) Sets the text of the positive button of the dialog.

Protected methods
void	onClick() Processes a click on the preference.

Inherited methods
From class android.support.v7.preference.Preference boolean callChangeListener(Object newValue) Call this method after the user changes the preference, but before the internal state is set. int compareTo(Preference another) Compares Preference objects based on order (if set), otherwise alphabetically on the titles. Preference findPreferenceInHierarchy(String key) Finds a Preference in this hierarchy (the whole thing, even above/below your PreferenceScreen screen break) with the given key. Context getContext() Returns the Context of this Preference. String getDependency() Returns the key of the dependency on this Preference. Bundle getExtras() Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one. String getFragment() Return the fragment class name associated with this Preference. Drawable getIcon() Returns the icon of this Preference. Intent getIntent() Return the Intent associated with this Preference. String getKey() Gets the key for this Preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore. final int getLayoutResource() Gets the layout resource that will be shown as the View for this Preference. Preference.OnPreferenceChangeListener getOnPreferenceChangeListener() Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated). Preference.OnPreferenceClickListener getOnPreferenceClickListener() Returns the callback to be invoked when this Preference is clicked. int getOrder() Gets the order of this Preference with respect to other Preference objects on the same level. PreferenceGroup getParent() 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(boolean defaultReturnValue) Attempts to get a persisted Boolean if this Preference is persistent. float getPersistedFloat(float defaultReturnValue) Attempts to get a persisted Float if this Preference is persistent. int getPersistedInt(int defaultReturnValue) Attempts to get a persisted Integer if this Preference is persistent. long getPersistedLong(long defaultReturnValue) Attempts to get a persisted Long if this Preference is persistent. String getPersistedString(String defaultReturnValue) Attempts to get a persisted set of Strings if this Preference is persistent. Set<String> getPersistedStringSet(Set<String> defaultReturnValue) Attempts to get a persisted set of Strings if this Preference is persistent. PreferenceDataStore getPreferenceDataStore() Returns PreferenceDataStore used by this Preference. PreferenceManager getPreferenceManager() Gets the PreferenceManager that manages this Preference object's tree. SharedPreferences getSharedPreferences() Returns the SharedPreferences where this Preference can read its value(s). boolean getShouldDisableView() Checks whether this Preference should disable its view when it's action is disabled. CharSequence getSummary() Returns the summary of this Preference. CharSequence getTitle() Returns the title of this Preference. final int getWidgetLayoutResource() Gets the layout resource for the controllable widget portion of this Preference. boolean hasKey() Checks whether this Preference has a valid key. boolean isEnabled() Checks whether this Preference should be enabled in the list. boolean isIconSpaceReserved() Returns whether the space of this preference icon view is reserved. boolean isPersistent() Checks whether this Preference is persistent. boolean isSelectable() Checks whether this Preference should be selectable in the list. boolean isSingleLineTitle() Gets whether the title of this preference is constrained to a single line. final boolean isVisible() Checks whether this preference should be visible to the user in the list. void notifyChanged() Should be called when the data of this Preference has changed. void notifyDependencyChange(boolean disableDependents) Notifies any listening dependents of a change that affects the dependency. void notifyHierarchyChanged() Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated. void onAttached() Called when the Preference hierarchy has been attached to the list of preferences. void onAttachedToHierarchy(PreferenceManager preferenceManager) Called when this Preference has been attached to a Preference hierarchy. void onBindViewHolder(PreferenceViewHolder holder) Binds the created View to the data for this Preference. void onClick() Processes a click on the preference. void onDependencyChanged(Preference dependency, boolean disableDependent) Called when the dependency changes. void onDetached() Called when the Preference hierarchy has been detached from the list of preferences. Object onGetDefaultValue(TypedArray a, int index) Called when a Preference is being inflated and the default value attribute needs to be read. void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info) Initializes an AccessibilityNodeInfo with information about the View for this Preference. void onParentChanged(Preference parent, boolean disableChild) Called when the implicit parent dependency changes. void onPrepareForRemoval() Called when this Preference is being removed from the hierarchy. void onRestoreInstanceState(Parcelable state) Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). Parcelable onSaveInstanceState() 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. void onSetInitialValue(boolean restorePersistedValue, Object defaultValue) Implement this to set the initial value of the Preference. Bundle peekExtras() Return the extras Bundle object associated with this preference, returning null if there is not currently one. boolean persistBoolean(boolean value) Attempts to persist a Boolean if this Preference is persistent. boolean persistFloat(float value) Attempts to persist a Float if this Preference is persistent. boolean persistInt(int value) Attempts to persist an Integer if this Preference is persistent. boolean persistLong(long value) Attempts to persist a Long if this Preference is persistent. boolean persistString(String value) Attempts to persist a String if this Preference is persistent. boolean persistStringSet(Set<String> values) Attempts to persist a set of Strings if this Preference is persistent. void restoreHierarchyState(Bundle container) Restore this Preference hierarchy's previously saved state from the given container. void saveHierarchyState(Bundle container) Store this Preference hierarchy's frozen state into the given container. void setDefaultValue(Object defaultValue) 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. void setDependency(String dependencyKey) Sets the key of a Preference that this Preference will depend on. void setEnabled(boolean enabled) Sets whether this Preference is enabled. void setFragment(String fragment) Sets the class name of a fragment to be shown when this Preference is clicked. void setIcon(Drawable icon) Sets the icon for this Preference with a Drawable. void setIcon(int iconResId) Sets the icon for this Preference with a resource ID. void setIconSpaceReserved(boolean iconSpaceReserved) Sets whether to reserve the space of this Preference icon view when no icon is provided. void setIntent(Intent intent) Sets an Intent to be used for startActivity(Intent) when this Preference is clicked. void setKey(String key) Sets the key for this Preference, which is used as a key to the SharedPreferences or PreferenceDataStore. void setLayoutResource(int layoutResId) Sets the layout resource that is inflated as the View to be shown for this Preference. void setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener) Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated). void setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener) Sets the callback to be invoked when this Preference is clicked. void setOrder(int order) Sets the order of this Preference with respect to other Preference objects on the same level. void setPersistent(boolean persistent) Sets whether this Preference is persistent. void setPreferenceDataStore(PreferenceDataStore dataStore) Sets a PreferenceDataStore to be used by this Preference instead of using SharedPreferences. void setSelectable(boolean selectable) Sets whether this Preference is selectable. void setShouldDisableView(boolean shouldDisableView) Sets whether this Preference should disable its view when it gets disabled. void setSingleLineTitle(boolean singleLineTitle) Sets whether to constrain the title of this Preference to a single line instead of letting it wrap onto multiple lines. void setSummary(CharSequence summary) Sets the summary for this Preference with a CharSequence. void setSummary(int summaryResId) Sets the summary for this Preference with a resource ID. void setTitle(CharSequence title) Sets the title for this Preference with a CharSequence. void setTitle(int titleResId) Sets the title for this Preference with a resource ID. void setViewId(int viewId) Set the ID that will be assigned to the overall View representing this preference, once bound. final void setVisible(boolean visible) Sets whether this preference should be visible in the list. void setWidgetLayoutResource(int widgetLayoutResId) Sets the layout for the controllable widget portion of this Preference. boolean shouldDisableDependents() Checks whether this preference's dependents should currently be disabled. boolean shouldPersist() 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 toString()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface java.lang.Comparable abstract int compareTo(Preference arg0)

Public constructors

DialogPreference

added in version 24.1.0

DialogPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context	Context
attrs	AttributeSet
defStyleAttr	int
defStyleRes	int

DialogPreference

added in version 24.1.0

DialogPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context	Context
attrs	AttributeSet
defStyleAttr	int

DialogPreference

added in version 24.1.0

DialogPreference (Context context, 
                AttributeSet attrs)

Parameters
context	Context
attrs	AttributeSet

DialogPreference

added in version 24.1.0

DialogPreference (Context context)

Parameters
context	Context

Public methods

getDialogIcon

added in version 24.1.0

Drawable getDialogIcon ()

Returns the icon to be shown on subsequent dialogs.

Returns
Drawable	The icon, as a Drawable.

getDialogLayoutResource

added in version 24.1.0

int getDialogLayoutResource ()

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

Returns
int	The layout resource.

getDialogMessage

added in version 24.1.0

CharSequence getDialogMessage ()

Returns the message to be shown on subsequent dialogs.

Returns
CharSequence	The message.

getDialogTitle

added in version 24.1.0

CharSequence getDialogTitle ()

Returns the title to be shown on subsequent dialogs.

Returns
CharSequence	The title.

getNegativeButtonText

added in version 24.1.0

CharSequence getNegativeButtonText ()

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

Returns
CharSequence	The text of the negative button.

getPositiveButtonText

added in version 24.1.0

CharSequence getPositiveButtonText ()

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

Returns
CharSequence	The text of the positive button.

setDialogIcon

added in version 24.1.0

void setDialogIcon (int dialogIconRes)

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

Parameters
dialogIconRes	int: The icon, as a resource ID.

setDialogIcon

added in version 24.1.0

void setDialogIcon (Drawable dialogIcon)

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

Parameters
dialogIcon	Drawable: The icon, as a Drawable.

setDialogLayoutResource

added in version 24.1.0

void setDialogLayoutResource (int dialogLayoutResId)

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(CharSequence)

setDialogMessage

added in version 24.1.0

void setDialogMessage (CharSequence dialogMessage)

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(int), include a text View with ID message and it will be populated with this message.

Parameters
dialogMessage	CharSequence: The message.

setDialogMessage

added in version 24.1.0

void setDialogMessage (int dialogMessageResId)

Parameters
dialogMessageResId	int: The dialog message as a resource.

See also:

• setDialogMessage(CharSequence)

setDialogTitle

added in version 24.1.0

void setDialogTitle (int dialogTitleResId)

Parameters
dialogTitleResId	int: The dialog title as a resource.

See also:

• setDialogTitle(CharSequence)

setDialogTitle

added in version 24.1.0

void setDialogTitle (CharSequence dialogTitle)

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

Parameters
dialogTitle	CharSequence: The title.

setNegativeButtonText

added in version 24.1.0

void setNegativeButtonText (CharSequence negativeButtonText)

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 version 24.1.0

void setNegativeButtonText (int negativeButtonTextResId)

Parameters
negativeButtonTextResId	int: The negative button text as a resource.

See also:

• setNegativeButtonText(CharSequence)

setPositiveButtonText

added in version 24.1.0

void setPositiveButtonText (int positiveButtonTextResId)

Parameters
positiveButtonTextResId	int: The positive button text as a resource.

See also:

• setPositiveButtonText(CharSequence)

setPositiveButtonText

added in version 24.1.0

void setPositiveButtonText (CharSequence positiveButtonText)

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.

Protected methods

onClick

added in version 24.1.0

void onClick ()

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

• Interfaces

  • DialogPreference.TargetFragment
  • Preference.OnPreferenceChangeListener
  • Preference.OnPreferenceClickListener
  • PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback
  • PreferenceFragmentCompat.OnPreferenceStartFragmentCallback
  • PreferenceFragmentCompat.OnPreferenceStartScreenCallback
  • PreferenceGroup.PreferencePositionCallback
  • PreferenceManager.OnDisplayPreferenceDialogListener
  • PreferenceManager.OnNavigateToScreenListener
  • PreferenceManager.OnPreferenceTreeClickListener

• Classes

  • CheckBoxPreference
  • DialogPreference
  • DropDownPreference
  • EditTextPreference
  • EditTextPreferenceDialogFragmentCompat
  • ListPreference
  • ListPreferenceDialogFragmentCompat
  • MultiSelectListPreferenceDialogFragmentCompat
  • Preference
  • Preference.BaseSavedState
  • PreferenceCategory
  • PreferenceDataStore
  • PreferenceDialogFragmentCompat
  • PreferenceFragmentCompat
  • PreferenceGroup
  • PreferenceManager
  • PreferenceManager.PreferenceComparisonCallback
  • PreferenceManager.SimplePreferenceComparisonCallback
  • PreferenceScreen
  • PreferenceViewHolder
  • R
  • R.anim
  • R.attr
  • R.bool
  • R.color
  • R.dimen
  • R.drawable
  • R.id
  • R.integer
  • R.layout
  • R.string
  • R.style
  • R.styleable
  • SeekBarPreference
  • SwitchPreferenceCompat
  • TwoStatePreference