Added in API level 1
Deprecated in API level 29

EditTextPreference


open class EditTextPreference : DialogPreference
kotlin.Any
   ↳ android.preference.Preference
   ↳ android.preference.DialogPreference
   ↳ android.preference.EditTextPreference

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

Inherited XML attributes
Inherited constants
Public constructors
EditTextPreference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int, defStyleRes: Int)

EditTextPreference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)

Public methods
open EditText!

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

open String!

Gets the text from the SharedPreferences.

open Unit
setText(text: String!)

Saves the text to the SharedPreferences.

open Boolean

Protected methods
open Unit
onAddEditTextToDialogView(dialogView: View!, editText: EditText!)

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

open Unit

open Unit
onDialogClosed(positiveResult: Boolean)

open Any!

open Unit

open Parcelable!

open Unit
onSetInitialValue(restoreValue: Boolean, defaultValue: Any!)

open Unit
showDialog(state: Bundle!)

Inherited functions

Public constructors

EditTextPreference

Added in API level 21
EditTextPreference(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int,
    defStyleRes: Int)

EditTextPreference

Added in API level 1
EditTextPreference(
    context: Context!,
    attrs: AttributeSet!,
    defStyleAttr: Int)

EditTextPreference

Added in API level 1
EditTextPreference(
    context: Context!,
    attrs: AttributeSet!)

EditTextPreference

Added in API level 1
EditTextPreference(context: Context!)

Public methods

getEditText

Added in API level 1
open fun getEditText(): EditText!

Deprecated: Deprecated in Java.

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

Return
EditText! The EditText widget that will be shown in the dialog.

getText

Added in API level 1
open fun getText(): String!

Deprecated: Deprecated in Java.

Gets the text from the SharedPreferences.

Return
String! The current preference value.

setText

Added in API level 1
open fun setText(text: String!): Unit

Deprecated: Deprecated in Java.

Saves the text to the SharedPreferences.

Parameters
text String!: The text to save

shouldDisableDependents

Added in API level 1
open fun shouldDisableDependents(): Boolean

Deprecated: Deprecated in Java.

Return
Boolean True if the dependents should be disabled, otherwise false.

Protected methods

onAddEditTextToDialogView

Added in API level 1
protected open fun onAddEditTextToDialogView(
    dialogView: View!,
    editText: EditText!
): Unit

Deprecated: Deprecated in Java.

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

Parameters
dialogView View!: The dialog view.

onBindDialogView

Added in API level 1
protected open fun onBindDialogView(view: View!): Unit

Deprecated: Deprecated in Java.

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

onDialogClosed

Added in API level 1
protected open fun onDialogClosed(positiveResult: Boolean): Unit

Deprecated: Deprecated in Java.

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

onGetDefaultValue

Added in API level 1
protected open fun onGetDefaultValue(
    a: TypedArray!,
    index: Int
): Any!

Deprecated: Deprecated in Java.

Parameters
a TypedArray!: The set of attributes.
index Int: The index of the default value attribute.
Return
Any! The default value of this preference type.

onRestoreInstanceState

Added in API level 1
protected open fun onRestoreInstanceState(state: Parcelable!): Unit

Deprecated: Deprecated in Java.

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

onSaveInstanceState

Added in API level 1
protected open fun onSaveInstanceState(): Parcelable!

Deprecated: Deprecated in Java.

Return
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 API level 1
protected open fun onSetInitialValue(
    restoreValue: Boolean,
    defaultValue: Any!
): Unit

Deprecated: Deprecated in Java.

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

showDialog

Added in API level 1
protected open fun showDialog(state: Bundle!): Unit

Deprecated: Deprecated in Java.

Parameters
state Bundle!: Optional instance state to restore on the dialog