de.mrapp.android.preference

Class AbstractValidateableDialogPreference<ValueType>

java.lang.Object

android.preference.Preference

de.mrapp.android.preference.AbstractDialogPreference

de.mrapp.android.preference.AbstractValidateableDialogPreference<ValueType>

Type Parameters:

ValueType - The type of the values, which can be validated

All Implemented Interfaces:

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

Direct Known Subclasses:

EditTextPreference, ResolutionPreference

public abstract class AbstractValidateableDialogPreference<ValueType>
extends AbstractDialogPreference

An abstract base class for all dialog preferences, which can be validated.

Since:

1.2.0

Nested Class Summary

Nested classes/interfaces inherited from class de.mrapp.android.preference.AbstractDialogPreference

AbstractDialogPreference.SavedState

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
AbstractValidateableDialogPreference(android.content.Context context) Creates a new dialog preference, which can be validated.
AbstractValidateableDialogPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new dialog preference, which can be validated.
AbstractValidateableDialogPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new dialog preference, which can be validated.
AbstractValidateableDialogPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new dialog preference, which can be validated.

Method Summary

Modifier and Type	Method and Description
void	addAllValidators(<any>... validators)
void	addAllValidators(java.util.Collection<<any>> validators)
void	addValidationListener(<any> listener)
void	addValidator(<any> validator)
int	getErrorColor() Returns the color, which is used to indicate validation errors.
java.lang.CharSequence	getHelperText() Returns the helper text of the view, which is contained by the preference's dialog.
int	getHelperTextColor() Returns the color of the helper text of the view, which is contained by the preference's dialog.
protected java.util.Set<<any>>	getValidationListeners() Returns the listeners, which are notified when the view, which is contained by the preference's dialog, has been validated.
java.util.Collection<<any>>	getValidators()
boolean	isValidatedOnFocusLost()
boolean	isValidatedOnValueChange()
protected void	onPrepareDialog(MaterialDialog.Builder dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
protected abstract void	onPrepareValidateableDialog(MaterialDialog.Builder dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
void	removeAllValidators()
void	removeAllValidators(<any>... validators)
void	removeAllValidators(java.util.Collection<<any>> validators)
void	removeValidationListener(<any> listener)
void	removeValidator(<any> validator)
void	setErrorColor(int color) Sets the color, which should be used to indicate validation errors.
void	setHelperText(java.lang.CharSequence helperText) Sets the helper text of the view, which is contained by the preference's dialog.
void	setHelperText(int resourceId) Sets the helper text of the view, which is contained by the preference's dialog.
void	setHelperTextColor(int color) Sets the color of the helper text of the view, which is contained by the preference's dialog.
boolean	validate(ValidateableDialog dialog)
void	validateOnFocusLost(boolean validateOnFocusLost)
void	validateOnValueChange(boolean 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, needInputMethod, onClick, onClick, onDialogClosed, onDismiss, onRestoreInstanceState, onSaveInstanceState, 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, getSummary, getTitle, getTitleRes, getView, getWidgetLayoutResource, hasKey, isEnabled, isPersistent, isSelectable, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttachedToActivity, onAttachedToHierarchy, onBindView, onCreateView, onDependencyChanged, onGetDefaultValue, onParentChanged, onPrepareForRemoval, onSetInitialValue, 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, shouldDisableDependents, shouldPersist, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValidateableDialogPreference

public AbstractValidateableDialogPreference(android.content.Context context)

Creates a new dialog preference, which can be validated.

Parameters:

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

AbstractValidateableDialogPreference

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

Creates a new dialog preference, which can be validated.

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

AbstractValidateableDialogPreference

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

Creates a new dialog preference, which can be validated.

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

AbstractValidateableDialogPreference

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

Creates a new dialog preference, which can be validated.

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

onPrepareValidateableDialog

protected abstract void onPrepareValidateableDialog(MaterialDialog.Builder dialogBuilder)

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.

Parameters:

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

getValidationListeners

protected final java.util.Set<<any>> getValidationListeners()

Returns the listeners, which are notified when the view, which is contained by the preference's dialog, has been validated.

Returns:

A set, which contains the listeners, which are notified when the view, which is contained by the preference's dialog, has been validated, as an instance of the type Set or an empty set, if no validators are used

getHelperText

public final java.lang.CharSequence getHelperText()

Returns the helper text of the view, which is contained by the preference's dialog.

Returns:

The helper text of the view, which is contained by the preference's dialog, as an instance of the type CharSequence or null, if no helper text is shown

setHelperText

public final void setHelperText(java.lang.CharSequence helperText)

Sets the helper text of the view, which is contained by the preference's dialog.

Parameters:

helperText - The helper text, which should be set, as an instance of the type CharSequence or null, if no helper text should be shown

setHelperText

public final void setHelperText(int resourceId)

Sets the helper text of the view, which is contained by the preference's dialog.

Parameters:

resourceId - The resource ID of the string resource, which contains the helper text, which should be set, as an Integer value. The resource ID must correspond to a valid string resource

getErrorColor

public final int getErrorColor()

Returns the color, which is used to indicate validation errors.

Returns:

The color, which is used to indicate validation errors, as an Integer value

setErrorColor

public final void setErrorColor(int color)

Sets the color, which should be used to indicate validation errors.

Parameters:

color - The color, which should be set, as an Integer value

getHelperTextColor

public final int getHelperTextColor()

Returns the color of the helper text of the view, which is contained by the preference's dialog.

Returns:

The color of the helper text as an Integer value

setHelperTextColor

public final void setHelperTextColor(int color)

Sets the color of the helper text of the view, which is contained by the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value

validate

public final boolean validate(ValidateableDialog dialog)

getValidators

public final java.util.Collection<<any>> getValidators()

addValidator

public final void addValidator(<any> validator)

addAllValidators

public final void addAllValidators(java.util.Collection<<any>> validators)

addAllValidators

@SafeVarargs
public final void addAllValidators(<any>... validators)

removeValidator

public final void removeValidator(<any> validator)

removeAllValidators

public final void removeAllValidators(java.util.Collection<<any>> validators)

removeAllValidators

@SafeVarargs
public final void removeAllValidators(<any>... validators)

removeAllValidators

public final void removeAllValidators()

isValidatedOnValueChange

public final boolean isValidatedOnValueChange()

validateOnValueChange

public final void validateOnValueChange(boolean validateOnValueChange)

isValidatedOnFocusLost

public final boolean isValidatedOnFocusLost()

validateOnFocusLost

public final void validateOnFocusLost(boolean validateOnFocusLost)

addValidationListener

public final void addValidationListener(<any> listener)

removeValidationListener

public final void removeValidationListener(<any> listener)

onPrepareDialog

protected final void onPrepareDialog(MaterialDialog.Builder dialogBuilder)

Description copied from class: AbstractDialogPreference

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.

Specified by:

onPrepareDialog in class AbstractDialogPreference

Parameters:

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