de.mrapp.android.preference

Class EditTextPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

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

de.mrapp.android.preference.EditTextPreference

All Implemented Interfaces:

android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, android.content.DialogInterface.OnKeyListener, android.content.DialogInterface.OnShowListener

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.

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
protected AbstractButtonBarDialog	createDialog(<any> dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
protected <any>	createDialogBuilder(int dialogTheme) The method, which is invoked on subclasses when the builder, which is used to configure the preference's dialog, is about to be created.
java.lang.CharSequence	getHint() Returns the hint of the edit text widget, which is contained by the preference's dialog.
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(AbstractButtonBarDialog dialog, 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	onPrepareDialog(<any> 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(java.lang.Object defaultValue)
void	setHint(java.lang.CharSequence hint) Sets the hint of the edit text widget, which is contained by the preference's dialog.
void	setHint(int resourceId) Sets the hint of the edit text widget, which is contained by the preference's dialog.
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, removeAllValidators, removeAllValidators, removeAllValidators, removeValidationListener, removeValidator, setErrorColor, setHelperText, setHelperText, setHelperTextColor, validate, validateOnFocusLost, validateOnValueChange

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

areDialogDividersShownOnScroll, getDialog, getDialogBackground, getDialogBottomMargin, getDialogButtonTextColor, getDialogButtonTypeface, getDialogCancelAnimation, getDialogDismissAnimation, getDialogDividerColor, getDialogDividerMargin, getDialogGravity, getDialogHeaderBackground, getDialogHeaderIcon, getDialogHeaderIconTintList, getDialogHeaderIconTintMode, getDialogHeight, getDialogIcon, getDialogIconTintList, getDialogIconTintMode, getDialogLeftMargin, getDialogMaxHeight, getDialogMaxWidth, getDialogMessage, getDialogMessageColor, getDialogMessageTypeface, getDialogPaddingBottom, getDialogPaddingLeft, getDialogPaddingRight, getDialogPaddingTop, getDialogRightMargin, getDialogScrollableArea, getDialogShowAnimation, getDialogTitle, getDialogTitleColor, getDialogTitleTypeface, getDialogTopMargin, getDialogWidth, getDialogWindowBackground, getNegativeButtonText, getPositiveButtonText, isDialogButtonBarDividerShown, isDialogFitsSystemWindowsBottom, isDialogFitsSystemWindowsLeft, isDialogFitsSystemWindowsRight, isDialogFitsSystemWindowsTop, isDialogFullscreen, isDialogHeaderShown, isDialogShown, isValueShownAsSummary, onCancel, onClick, onClick, onDismiss, onKey, onShow, performClick, setCustomDialogButtonBar, setCustomDialogButtonBar, setCustomDialogHeader, setCustomDialogHeader, setCustomDialogMessage, setCustomDialogMessage, setCustomDialogTitle, setCustomDialogTitle, setDialogBackground, setDialogBackground, setDialogBackgroundColor, setDialogButtonTextColor, setDialogButtonTextColor, setDialogButtonTypeface, setDialogCancelAnimation, setDialogDismissAnimation, setDialogDividerColor, setDialogDividerMargin, setDialogFitsSystemWindows, setDialogFitsSystemWindows, setDialogFullscreen, setDialogGravity, setDialogHeaderBackground, setDialogHeaderBackground, setDialogHeaderBackgroundColor, setDialogHeaderIcon, setDialogHeaderIcon, setDialogHeaderIconTint, setDialogHeaderIconTintList, setDialogHeaderIconTintMode, setDialogHeight, setDialogIcon, setDialogIcon, setDialogIconTint, setDialogIconTintList, setDialogIconTintMode, setDialogMargin, setDialogMaxHeight, setDialogMaxWidth, setDialogMessage, setDialogMessage, setDialogMessageColor, setDialogMessageTypeface, setDialogPadding, setDialogScrollableArea, setDialogScrollableArea, setDialogShowAnimation, setDialogTitle, setDialogTitle, setDialogTitleColor, setDialogTitleTypeface, setDialogWidth, setDialogWindowBackground, setDialogWindowBackground, setNegativeButtonText, setNegativeButtonText, setOnCancelListener, setOnClickListener, setOnDismissListener, setOnKeyListener, setOnShowListener, setPositiveButtonText, setPositiveButtonText, showDialogButtonBarDivider, showDialogDividersOnScroll, showDialogHeader, showValueAsSummary

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

getIconTintList, getIconTintMode, setIcon, setIconTint, setIconTintList, setIconTintMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

getHint

public final java.lang.CharSequence getHint()

Returns the hint of the edit text widget, which is contained by the preference's dialog.

Returns:

The hint of the edit text widget, which is contained by the preference's dialog, as an instance of the type CharSequence or null, if no hint is set

setHint

public final void setHint(java.lang.CharSequence hint)

Sets the hint of the edit text widget, which is contained by the preference's dialog.

Parameters:

hint - The hint, which should be set, as an instance of the type CharSequence or null, if no hint should be set

setHint

public final void setHint(int resourceId)

Sets the hint of the edit text widget, which is contained by the preference's dialog.

Parameters:

resourceId - The resource id of the hint, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getSummary

public final java.lang.CharSequence getSummary()

shouldDisableDependents

public final boolean shouldDisableDependents()

validate

public final boolean validate()

createDialogBuilder

protected <any> createDialogBuilder(int dialogTheme)

Description copied from class: DialogPreference

The method, which is invoked on subclasses when the builder, which is used to configure the preference's dialog, is about to be created.

Overrides:

createDialogBuilder in class DialogPreference

Parameters:

dialogTheme - The resource id of the theme, which should be used by the dialog, as an Integer value

Returns:

The builder, which has been created, as an instance of the class AbstractButtonBarDialogBuilder. The builder may not be null

onPrepareDialog

protected final void onPrepareDialog(<any> dialogBuilder)

Description copied from class: DialogPreference

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. When views are inflated inside this method, the context of the builder should be used in order to ensure that the dialog's theme is used.

Overrides:

onPrepareDialog 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 AbstractMaterialDialogBuilder

createDialog

protected AbstractButtonBarDialog createDialog(<any> dialogBuilder)

Description copied from class: DialogPreference

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. When views are inflated inside this method, the context of the builder should be used in order to ensure that the dialog's theme is used.

Overrides:

createDialog in class DialogPreference

Parameters:

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

Returns:

The dialog, which has been created, as an instance of the class AbstractButtonBarDialog. The dialog may not be null

onDialogClosed

protected final void onDialogClosed(AbstractButtonBarDialog dialog,
                                    boolean positiveResult)

Description copied from class: DialogPreference

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.

Overrides:

onDialogClosed in class DialogPreference

Parameters:

dialog - The dialog, which has been closed, as an instance of the class AbstractButtonBarDialog. The dialog may not be null

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

needInputMethod

protected final boolean needInputMethod()

Description copied from class: DialogPreference

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.

Overrides:

needInputMethod in class DialogPreference

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)

onSetInitialValue

protected final void onSetInitialValue(java.lang.Object defaultValue)

onSaveInstanceState

protected android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class DialogPreference

onRestoreInstanceState

protected void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class DialogPreference