Android APIs
public class

EditTextPreference

extends DialogPreference
java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.DialogPreference
       ↳ android.preference.EditTextPreference

Class Overview

A Preference that allows for string input.

It is a subclass of DialogPreference and shows the EditText in a dialog. This EditText can be modified either programmatically via getEditText(), or through XML by setting any EditText attributes on the EditTextPreference.

This preference will store a string into the SharedPreferences.

See EditText Attributes.

Summary

[Expand]
Inherited XML Attributes
From class android.preference.DialogPreference
From class android.preference.Preference
[Expand]
Inherited Constants
From class android.preference.Preference
Public Constructors
EditTextPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
EditTextPreference(Context context, AttributeSet attrs, int defStyleAttr)
EditTextPreference(Context context, AttributeSet attrs)
EditTextPreference(Context context)
Public Methods
EditText getEditText()
Returns the EditText widget that will be shown in the dialog.
String getText()
Gets the text from the SharedPreferences.
void setText(String text)
Saves the text to the SharedPreferences.
boolean shouldDisableDependents()
Checks whether this preference's dependents should currently be disabled.
Protected Methods
void onAddEditTextToDialogView(View dialogView, EditText editText)
Adds the EditText widget of this preference to the dialog's view.
void onBindDialogView(View view)
Binds views in the content View of the dialog to data.
void onDialogClosed(boolean positiveResult)
Called when the dialog is dismissed and should be used to save data to the SharedPreferences.
Object onGetDefaultValue(TypedArray a, int index)
Called when a Preference is being inflated and the default value attribute needs to be read.
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 restoreValue, Object defaultValue)
Implement this to set the initial value of the Preference.
[Expand]
Inherited Methods
From class android.preference.DialogPreference
From class android.preference.Preference
From class java.lang.Object
From interface android.content.DialogInterface.OnClickListener
From interface android.content.DialogInterface.OnDismissListener
From interface android.preference.PreferenceManager.OnActivityDestroyListener
From interface java.lang.Comparable

Public Constructors

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

Added in API level 21

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

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

Added in API level 1

Parameters
context Context
attrs AttributeSet
defStyleAttr int

public EditTextPreference (Context context, AttributeSet attrs)

Added in API level 1

Parameters
context Context
attrs AttributeSet

public EditTextPreference (Context context)

Added in API level 1

Parameters
context Context

Public Methods

public EditText getEditText ()

Added in API level 1

Returns the EditText widget that will be shown in the dialog.

Returns
EditText The EditText widget that will be shown in the dialog.

public String getText ()

Added in API level 1

Gets the text from the SharedPreferences.

Returns
String The current preference value.

public void setText (String text)

Added in API level 1

Saves the text to the SharedPreferences.

Parameters
text String: The text to save

public boolean shouldDisableDependents ()

Added in API level 1

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

Returns
boolean True if the dependents should be disabled, otherwise false.

Protected Methods

protected void onAddEditTextToDialogView (View dialogView, EditText editText)

Added in API level 1

Adds the EditText widget of this preference to the dialog's view.

Parameters
dialogView View: The dialog view.
editText EditText

protected void onBindDialogView (View view)

Added in API level 1

Binds views in the content View of the dialog to data.

Make sure to call through to the superclass implementation.

Parameters
view View: The content View of the dialog, if it is custom.

protected void onDialogClosed (boolean positiveResult)

Added in API level 1

Called when the dialog is dismissed and should be used to save data to the SharedPreferences.

Parameters
positiveResult boolean: Whether the positive button was clicked (true), or the negative button was clicked or the dialog was canceled (false).

protected Object onGetDefaultValue (TypedArray a, int index)

Added in API level 1

Called when a Preference is being inflated and the default value attribute needs to be read. Since different Preference types have different value types, the subclass should get and return the default value which will be its value type.

For example, if the value type is String, the body of the method would proxy to getString(int).

Parameters
a TypedArray: The set of attributes.
index int: The index of the default value attribute.
Returns
Object The default value of this preference type.

protected void onRestoreInstanceState (Parcelable state)

Added in API level 1

Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters
state Parcelable: The saved state that had previously been returned by onSaveInstanceState().

protected Parcelable onSaveInstanceState ()

Added in API level 1

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. This state should only contain information that is not persistent or can be reconstructed later.

Returns
Parcelable A Parcelable object containing the current dynamic state of this Preference, or null if there is nothing interesting to save. The default implementation returns null.

protected void onSetInitialValue (boolean restoreValue, Object defaultValue)

Added in API level 1

Implement this to set the initial value of the Preference.

If restorePersistedValue is true, you should restore the Preference value from the SharedPreferences. If restorePersistedValue is false, you should set the Preference value to defaultValue that is given (and possibly store to SharedPreferences if shouldPersist() is true).

This may not always be called. One example is if it should not persist but there is no default value given.

Parameters
restoreValue boolean: True to restore the persisted value; false to use the given defaultValue.
defaultValue Object: The default value for this Preference. Only use this if restorePersistedValue is false.