de.mrapp.android.preference

Class EditTextPreference

java.lang.Object

android.preference.Preference

de.mrapp.android.preference.AbstractDialogPreference

de.mrapp.android.preference.AbstractValidateableDialogPreference<java.lang.CharSequence>

de.mrapp.android.preference.EditTextPreference

All Implemented Interfaces:

android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, java.lang.Comparable<android.preference.Preference>

public class EditTextPreference
extends AbstractValidateableDialogPreference<java.lang.CharSequence>

A preference, which allows to enter a text via an EditText widget. The entered text will only be persisted, if confirmed by the user.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditTextPreference.SavedState A data structure, which allows to save the internal state of an EditTextPreference.

Nested classes/interfaces inherited from class android.preference.Preference

android.preference.Preference.BaseSavedState, android.preference.Preference.OnPreferenceChangeListener, android.preference.Preference.OnPreferenceClickListener

Field Summary

Fields inherited from class android.preference.Preference

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
EditTextPreference(android.content.Context context) Creates a new preference, which allows to enter a text via an EditText widget.
EditTextPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to enter a text via an EditText widget.
EditTextPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to enter a text via an EditText widget.
EditTextPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to enter a text via an EditText widget.

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	getSummary()
java.lang.String	getText() Returns the currently persisted text of the preference.
protected boolean	needInputMethod() The method, which is invoked on subclasses to determine, whether the soft input mode should be requested when the preference's dialog becomes shown, or not.
protected void	onDialogClosed(boolean positiveResult) The method, which is invoked on subclasses when the preference's dialog has been closed.
protected java.lang.Object	onGetDefaultValue(android.content.res.TypedArray typedArray, int index)
protected void	onPrepareValidateableDialog(MaterialDialog.Builder dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
protected void	onRestoreInstanceState(android.os.Parcelable state)
protected android.os.Parcelable	onSaveInstanceState()
protected void	onSetInitialValue(boolean restoreValue, java.lang.Object defaultValue)
void	setText(java.lang.String text) Sets the current text of the preference.
boolean	shouldDisableDependents()
boolean	validate()

Methods inherited from class de.mrapp.android.preference.AbstractValidateableDialogPreference

addAllValidators, addAllValidators, addValidationListener, addValidator, getErrorColor, getHelperText, getHelperTextColor, getValidationListeners, getValidators, isValidatedOnFocusLost, isValidatedOnValueChange, onPrepareDialog, removeAllValidators, removeAllValidators, removeAllValidators, removeValidationListener, removeValidator, setErrorColor, setHelperText, setHelperText, setHelperTextColor, validate, validateOnFocusLost, validateOnValueChange

Methods inherited from class de.mrapp.android.preference.AbstractDialogPreference

getDialog, getDialogBackground, getDialogButtonBarDividerColor, getDialogButtonTextColor, getDialogContentDividerColor, getDialogHeaderBackground, getDialogHeaderIcon, getDialogIcon, getDialogMessage, getDialogMessageColor, getDialogTitle, getDialogTitleColor, getNegativeButtonText, getPositiveButtonText, isDialogButtonBarDividerShown, isDialogContentDividerShown, isDialogHeaderShown, isDialogShown, isValueShownAsSummary, onClick, onClick, onDismiss, setDialogBackground, setDialogBackground, setDialogBackgroundColor, setDialogButtonBarDividerColor, setDialogButtonTextColor, setDialogContentDividerColor, setDialogHeaderBackground, setDialogHeaderBackground, setDialogHeaderBackgroundColor, setDialogHeaderIcon, setDialogHeaderIcon, setDialogIcon, setDialogIcon, setDialogMessage, setDialogMessage, setDialogMessageColor, setDialogTitle, setDialogTitle, setDialogTitleColor, setNegativeButtonText, setNegativeButtonText, setPositiveButtonText, setPositiveButtonText, showDialogButtonBarDivider, showDialogContentDivider, showDialogHeader, showValueAsSummary

Methods inherited from class android.preference.Preference

callChangeListener, compareTo, findPreferenceInHierarchy, getContext, getDependency, getEditor, getExtras, getFragment, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPreferenceManager, getSharedPreferences, getShouldDisableView, getTitle, getTitleRes, getView, getWidgetLayoutResource, hasKey, isEnabled, isPersistent, isSelectable, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttachedToActivity, onAttachedToHierarchy, onBindView, onCreateView, onDependencyChanged, onParentChanged, onPrepareForRemoval, peekExtras, persistBoolean, persistFloat, persistInt, persistLong, persistString, restoreHierarchyState, saveHierarchyState, setDefaultValue, setDependency, setEnabled, setFragment, setIcon, setIcon, setIntent, setKey, setLayoutResource, setOnPreferenceChangeListener, setOnPreferenceClickListener, setOrder, setPersistent, setSelectable, setShouldDisableView, setSummary, setSummary, setTitle, setTitle, setWidgetLayoutResource, shouldCommit, shouldPersist, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EditTextPreference

public EditTextPreference(android.content.Context context)

Creates a new preference, which allows to enter a text via an EditText widget.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

EditTextPreference

public EditTextPreference(android.content.Context context,
                          android.util.AttributeSet attributeSet)

Creates a new preference, which allows to enter a text via an EditText widget.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

EditTextPreference

public EditTextPreference(android.content.Context context,
                          android.util.AttributeSet attributeSet,
                          int defaultStyle)

Creates a new preference, which allows to enter a text via an EditText widget.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

EditTextPreference

public EditTextPreference(android.content.Context context,
                          android.util.AttributeSet attributeSet,
                          int defaultStyle,
                          int defaultStyleResource)

Creates a new preference, which allows to enter a text via an EditText widget.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

defaultStyleResource - A resource identifier of a style resource that supplies default values for the preference, used only if the default style is 0 or can not be found in the theme. Can be 0 to not look for defaults

Method Detail

getText

public final java.lang.String getText()

Returns the currently persisted text of the preference.

Returns:

The currently persisted text as a String

setText

public final void setText(java.lang.String text)

Sets the current text of the preference. By setting a value, it will be persisted.

Parameters:

text - The text, which should be set, as a String

getSummary

public final java.lang.CharSequence getSummary()

Overrides:

getSummary in class android.preference.Preference

shouldDisableDependents

public final boolean shouldDisableDependents()

Overrides:

shouldDisableDependents in class android.preference.Preference

validate

public final boolean validate()

onPrepareValidateableDialog

protected final void onPrepareValidateableDialog(MaterialDialog.Builder dialogBuilder)

Description copied from class: AbstractValidateableDialogPreference

The method, which is invoked on subclasses when the preference's dialog is about to be created. The builder, which is passed as a method parameter may be manipulated by subclasses in order to change the appearance of the dialog.

Specified by:

onPrepareValidateableDialog in class AbstractValidateableDialogPreference<java.lang.CharSequence>

Parameters:

dialogBuilder - The builder, which is used to create the preference's dialog, as an instance of the class MaterialDialog.Builder

onDialogClosed

protected final void onDialogClosed(boolean positiveResult)

Description copied from class: AbstractDialogPreference

The method, which is invoked on subclasses when the preference's dialog has been closed. This method may be used within subclasses to evaluate the changes, which have been made while the dialog was shown.

Specified by:

onDialogClosed in class AbstractDialogPreference

Parameters:

positiveResult - True, if the dialog has been close affirmatively, false otherwise

needInputMethod

protected final boolean needInputMethod()

Description copied from class: AbstractDialogPreference

The method, which is invoked on subclasses to determine, whether the soft input mode should be requested when the preference's dialog becomes shown, or not.

Specified by:

needInputMethod in class AbstractDialogPreference

Returns:

True, if the soft input mode should be requested when the preference's dialog becomes shown, false otherwise

onGetDefaultValue

protected final java.lang.Object onGetDefaultValue(android.content.res.TypedArray typedArray,
                                                   int index)

Overrides:

onGetDefaultValue in class android.preference.Preference

onSetInitialValue

protected final void onSetInitialValue(boolean restoreValue,
                                       java.lang.Object defaultValue)

Overrides:

onSetInitialValue in class android.preference.Preference

onSaveInstanceState

protected final android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class AbstractDialogPreference

onRestoreInstanceState

protected final void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class AbstractDialogPreference