Android
android.preference
public class

android.preference.EditTextPreference

java.lang.Object
android.preference.Preference Comparable<T>
android.preference.DialogPreference DialogInterface.OnClickListener DialogInterface.OnDismissListener PreferenceManager.OnActivityDestroyListener
android.preference.EditTextPreference

The EditTextPreference class is 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

XML Attributes inherited from class android.preference.DialogPreference
XML Attributes inherited from class android.preference.Preference
Constants inherited from class android.preference.Preference

Public Constructors

            EditTextPreference(Context context, AttributeSet attrs, int defStyle)
            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()
Should return 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 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.
Methods inherited from class android.preference.DialogPreference
Methods inherited from class android.preference.Preference
Methods inherited from class java.lang.Object
Methods inherited from interface android.content.DialogInterface.OnClickListener
Methods inherited from interface android.content.DialogInterface.OnDismissListener
Methods inherited from interface android.preference.PreferenceManager.OnActivityDestroyListener
Methods inherited from interface java.lang.Comparable

Details

Public Constructors

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

public EditTextPreference(Context context, AttributeSet attrs)

public EditTextPreference(Context context)

Public Methods

public EditText getEditText()

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

Returns

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

public String getText()

Gets the text from the SharedPreferences.

Returns

  • The current preference value.

public void setText(String text)

Saves the text to the SharedPreferences.

Parameters

text The text to save

public boolean shouldDisableDependents()

Should return whether this preference's dependents should currently be disabled.

Returns

  • True if the dependents should be disabled, otherwise false.

Protected Methods

protected void onAddEditTextToDialogView(View dialogView, EditText editText)

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

Parameters

dialogView The dialog view.

protected void onBindDialogView(View view)

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

Make sure to call through to the superclass implementation.

Parameters

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

protected void onDialogClosed(boolean positiveResult)

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

Parameters

positiveResult 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)

Called when 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 The set of attributes.
index The index of the default value attribute.

Returns

  • The default value of this preference type.

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

Parameters

state The frozen state that had previously been returned by onSaveInstanceState().

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

  • Returns a Parcelable object containing the preference's current dynamic state, or null if there is nothing interesting to save. The default implementation returns null.

protected void onSetInitialValue(boolean restoreValue, Object defaultValue)

Implement this to set the initial value of the Preference. If the restoreValue flag is true, you should restore the value from the shared preferences. If false, you should set (and possibly store to shared preferences if shouldPersist()) to defaultValue.

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

Parameters

restoreValue Whether to restore the persisted value (true), or use the given default value (false).
defaultValue The default value. Only use if restoreValue is false.
Copyright 2007 Google Inc. Build 119366-119366 - 19 Nov 2008 16:04