EditTextPreference
public
class
EditTextPreference
extends DialogPreference
java.lang.Object | |||
↳ | androidx.preference.Preference | ||
↳ | androidx.preference.DialogPreference | ||
↳ | androidx.preference.EditTextPreference |
A DialogPreference
that shows a EditText
in the dialog.
This preference saves a string value.
Summary
Nested classes | |
---|---|
interface |
EditTextPreference.OnBindEditTextListener
Interface definition for a callback to be invoked when the corresponding dialog view for this preference is bound. |
class |
EditTextPreference.SimpleSummaryProvider
A simple |
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 current data storage. |
void
|
setOnBindEditTextListener(EditTextPreference.OnBindEditTextListener onBindEditTextListener)
Set an |
void
|
setText(String text)
Saves the text to the current data storage. |
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 |
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
public EditTextPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
EditTextPreference
public EditTextPreference (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
EditTextPreference
public EditTextPreference (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
Public methods
getText
public String getText ()
Gets the text from the current data storage.
Returns | |
---|---|
String |
The current preference value |
setOnBindEditTextListener
public void setOnBindEditTextListener (EditTextPreference.OnBindEditTextListener onBindEditTextListener)
Set an EditTextPreference.OnBindEditTextListener
that will be invoked when the corresponding dialog
view for this preference is bound. Set null
to remove the existing
OnBindEditTextListener.
Parameters | |
---|---|
onBindEditTextListener |
EditTextPreference.OnBindEditTextListener : The EditTextPreference.OnBindEditTextListener that will be invoked when
the corresponding dialog view for this preference is bound |
setText
public void setText (String text)
Saves the text to the current data storage.
Parameters | |
---|---|
text |
String : The text to save
|
shouldDisableDependents
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
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
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
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
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 .
|
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.