DialogPreference - Android SDK

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

Class Overview

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

XML Attributes
Attribute Name	Related Method	Description
android:dialogIcon		The icon for the dialog.
android:dialogLayout		A layout to be used as the content View for the dialog.
android:dialogMessage		The message in the dialog.
android:dialogTitle		The title in the dialog.
android:negativeButtonText		The negative button text for the dialog.
android:positiveButtonText		The positive button text for the dialog.

[Expand]

Inherited XML Attributes

From class android.support.v7.preference.Preference

Attribute Name	Related Method	Description
android:defaultValue		The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
android:dependency		The key of another Preference that this Preference will depend on.
android:enabled		Whether the Preference is enabled.
android:fragment		When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item.
android:icon		The optional icon for the preference Must be a reference to another resource, in the form "`@[+][package:]type:name`" or to a theme attribute in the form "`?[package:][type:]name`".
android:key		The key to store the Preference value.
android:layout		The layout for the Preference in a PreferenceActivity screen.
android:order		The order for the Preference (lower values are to be ordered first).
android:persistent		Whether the Preference stores its value to the shared preferences.
android:selectable		Whether the Preference is selectable.
android:shouldDisableView		Whether the view of this Preference should be disabled when this Preference is disabled.
android:summary		The summary for the Preference in a PreferenceActivity screen.
android:title		The title for the Preference in a PreferenceActivity screen.
android:widgetLayout		The layout for the controllable widget portion of a Preference.

[Expand]

Inherited Constants

From class android.support.v7.preference.Preference

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(int negativeButtonTextResId)
void	setNegativeButtonText(CharSequence negativeButtonText) Sets the text of the negative button of the dialog.
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.

[Expand]

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.
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.
boolean	getPersistedBoolean(boolean defaultReturnValue) Attempts to get a persisted boolean from the `SharedPreferences`.
float	getPersistedFloat(float defaultReturnValue) Attempts to get a persisted float from the `SharedPreferences`.
int	getPersistedInt(int defaultReturnValue) Attempts to get a persisted int from the `SharedPreferences`.
long	getPersistedLong(long defaultReturnValue) Attempts to get a persisted long from the `SharedPreferences`.
String	getPersistedString(String defaultReturnValue) Attempts to get a persisted String from the `SharedPreferences`.
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	isPersistent() Checks whether this Preference is persistent.
boolean	isSelectable() Checks whether this Preference should be selectable in the list.
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.
Object	onGetDefaultValue(TypedArray a, int index) Called when a Preference is being inflated and the default value attribute needs to be read.
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 to the `SharedPreferences`.
boolean	persistFloat(float value) Attempts to persist a float to the `SharedPreferences`.
boolean	persistInt(int value) Attempts to persist an int to the `SharedPreferences`.
boolean	persistLong(long value) Attempts to persist a long to the `SharedPreferences`.
boolean	persistString(String value) Attempts to persist a String to the `SharedPreferences`.
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	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`.
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	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	setSummary(int summaryResId) Sets the summary for this Preference with a resource ID.
void	setSummary(CharSequence summary) Sets the summary for this Preference with a CharSequence.
void	setTitle(int titleResId) Sets the title for this Preference with a resource ID.
void	setTitle(CharSequence title) Sets the title for this Preference with a CharSequence.
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`.
String	toString() Returns a string containing a concise, human-readable description of this object.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.lang.Comparable

XML Attributes

android:dialogIcon

The icon for the dialog.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol dialogIcon.

Related Methods

android:dialogLayout

A layout to be used as the content View for the dialog. By default, this shouldn't be needed. If a custom DialogPreference is required, this should be set. For example, the EditTextPreference uses a layout with an EditText as this attribute.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol dialogLayout.

Related Methods

android:dialogMessage

The message in the dialog. If a dialogLayout is provided and contains a TextView with ID android:id/message, this message will be placed in there.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol dialogMessage.

Related Methods

android:dialogTitle

The title in the dialog.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol dialogTitle.

Related Methods

android:negativeButtonText

The negative button text for the dialog. Set to @null to hide the negative button.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol negativeButtonText.

Related Methods

android:positiveButtonText

The positive button text for the dialog. Set to @null to hide the positive button.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol positiveButtonText.

Related Methods

Public Constructors

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

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

public DialogPreference (Context context, AttributeSet attrs)

public DialogPreference (Context context)

Public Methods

public Drawable getDialogIcon ()

Returns the icon to be shown on subsequent dialogs.

Returns

The icon, as a Drawable.

public int getDialogLayoutResource ()

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

Returns

The layout resource.

public CharSequence getDialogMessage ()

Returns the message to be shown on subsequent dialogs.

Returns

The message.

public CharSequence getDialogTitle ()

Returns the title to be shown on subsequent dialogs.

Returns

The title.

public CharSequence getNegativeButtonText ()

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

Returns

The text of the negative button.

public CharSequence getPositiveButtonText ()

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

Returns

The text of the positive button.

public void setDialogIcon (int dialogIconRes)

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

Parameters

dialogIconRes	The icon, as a resource ID.

public void setDialogIcon (Drawable dialogIcon)

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

Parameters

dialogIcon	The icon, as a `Drawable`.

public 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	The layout resource ID to be inflated.

public 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	The message.

public void setDialogMessage (int dialogMessageResId)

Parameters

dialogMessageResId	The dialog message as a resource.

public void setDialogTitle (int dialogTitleResId)

Parameters

dialogTitleResId	The dialog title as a resource.

public void setDialogTitle (CharSequence dialogTitle)

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

Parameters

dialogTitle	The title.

public void setNegativeButtonText (int negativeButtonTextResId)

Parameters

negativeButtonTextResId	The negative button text as a resource.

public void setNegativeButtonText (CharSequence negativeButtonText)

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

Parameters

negativeButtonText	The text of the negative button.

public void setPositiveButtonText (int positiveButtonTextResId)

Parameters

positiveButtonTextResId	The positive button text as a resource.

public void setPositiveButtonText (CharSequence positiveButtonText)

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

Parameters

positiveButtonText	The text of the positive button.

Protected Methods

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

Results

Interfaces

Classes

DialogPreference

Class Overview

Summary

XML Attributes

android:dialogIcon

Related Methods

android:dialogLayout

Related Methods

android:dialogMessage

Related Methods

android:dialogTitle

Related Methods

android:negativeButtonText

Related Methods

android:positiveButtonText

Related Methods

Public Constructors

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

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

public DialogPreference (Context context, AttributeSet attrs)

public DialogPreference (Context context)

Public Methods

public Drawable getDialogIcon ()

Returns

public int getDialogLayoutResource ()

Returns

public CharSequence getDialogMessage ()

Returns

public CharSequence getDialogTitle ()

Returns

public CharSequence getNegativeButtonText ()

Returns

public CharSequence getPositiveButtonText ()

Returns

public void setDialogIcon (int dialogIconRes)

Parameters

public void setDialogIcon (Drawable dialogIcon)

Parameters

public void setDialogLayoutResource (int dialogLayoutResId)

Parameters

See Also

public void setDialogMessage (CharSequence dialogMessage)

Parameters

public void setDialogMessage (int dialogMessageResId)

Parameters

See Also

public void setDialogTitle (int dialogTitleResId)

Parameters

See Also

public void setDialogTitle (CharSequence dialogTitle)

Parameters

public void setNegativeButtonText (int negativeButtonTextResId)

Parameters

See Also

public void setNegativeButtonText (CharSequence negativeButtonText)

Parameters

public void setPositiveButtonText (int positiveButtonTextResId)

Parameters

See Also

public void setPositiveButtonText (CharSequence positiveButtonText)

Parameters

Protected Methods

protected void onClick ()