Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in version 1.0.0
belongs to Maven artifact androidx.preference:preference:1.0.0-rc01

EditTextPreference

public class EditTextPreference
extends DialogPreference

java.lang.Object
   ↳ androidx.preference.Preference
     ↳ androidx.preference.DialogPreference
       ↳ androidx.preference.EditTextPreference


A Preference that allows for string input.

It is a subclass of DialogPreference and shows the EditText in a dialog.

This preference will store a string into the SharedPreferences.

Summary

Inherited XML attributes

Inherited constants

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

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

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(Object defaultValue)

Implement this to set the initial value of the preference.

Inherited methods

Public constructors

EditTextPreference

added in version 1.0.0
public EditTextPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

defStyleRes int

EditTextPreference

added in version 1.0.0
public EditTextPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

EditTextPreference

added in version 1.0.0
public EditTextPreference (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

EditTextPreference

added in version 1.0.0
public EditTextPreference (Context context)

Parameters
context Context

Public methods

getText

added in version 1.0.0
public String getText ()

Gets the text from the SharedPreferences.

Returns
String The current preference value.

setText

added in version 1.0.0
public void setText (String text)

Saves the text to the SharedPreferences.

Parameters
text String: The text to save

shouldDisableDependents

added in version 1.0.0
public boolean shouldDisableDependents ()

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

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

Protected methods

onGetDefaultValue

added in version 1.0.0
protected Object onGetDefaultValue (TypedArray a, 
                int index)

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

onRestoreInstanceState

added in version 1.0.0
protected void onRestoreInstanceState (Parcelable state)

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

onSaveInstanceState

added in version 1.0.0
protected 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. 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.

onSetInitialValue

added in version 1.0.0
protected void onSetInitialValue (Object defaultValue)

Implement this to set the initial value of the preference.

If you are persisting values to SharedPreferences or a PreferenceDataStore you should restore the saved value for the preference.

If you are not persisting values, or there is no value saved for the preference, you should set the value of the preference to defaultValue.

Parameters
defaultValue Object: The default value for the preference if set, otherwise null.