universum.studios.android.form

Class FormEditable

java.lang.Object

universum.studios.android.form.BaseFormComponent<EditText,CharSequence>

universum.studios.android.form.FormEditable

All Implemented Interfaces:

FormComponent<EditText,CharSequence>

public class FormEditable
extends BaseFormComponent<EditText,CharSequence>

A BaseFormComponent implementation that wraps form editable view like EditText into component that can be validated by FormValidator when validating a form in which is such a view presented.

Since:

1.0

Author:

Martin Albedinsky

See Also:

FormCheckable

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOT_EMPTY_REG_EXP Regular expression to check for not empty text.

Constructor Summary

Constructors

Constructor and Description
FormEditable(EditText editable) Same as FormEditable(EditText, String) with NOT_EMPTY_REG_EXP for regExp parameter.
FormEditable(EditText editable, int regExpResId) Same as FormEditable(EditText, String) for regular expression resource id.
FormEditable(EditText editable, String regExp) Creates a new instance of FormEditable component for the given editable view with the specified regular expression.
FormEditable(int id) Same as FormEditable(int, String) with NOT_EMPTY_REG_EXP for regExp parameter.
FormEditable(int id, int regExpResId) Creates a new instance of FormEditable component for an editable view with the specified id.
FormEditable(int id, String regExp) Creates a new instance of FormEditable component for an editable view with the specified id and the specified regular expression.

Method Summary

Modifier and Type	Method and Description
void	clearError() Clears the current error (if any) of this form component specified via FormComponent.setError(CharSequence).
Editable	getEditableInput() Returns the current editable value of the attached text field view.
CharSequence	getInput() Returns the current input presented by an attached view of this form component.
boolean	hasInputChanged() Checks whether the current value of this form component has changed since its last validation.
protected void	onAttachedToValidator(FormValidator validator) Invoked whenever this form component is assigned to the passed validator.
protected boolean	onValidate(CharSequence input) Invoked whenever BaseFormComponent.validate() is called.
void	setError(CharSequence errorMessage) Sets an error for this form component.

Methods inherited from class universum.studios.android.form.BaseFormComponent

attachToValidator, findComponent, findComponentTraversal, getId, getLastValidatedInput, getResources, getValidator, getView, hasError, isAttachedToValidator, obtainString, obtainText, onComponentViewAttached, resetCurrentState, setHasError, validate

Methods inherited from class java.lang.Object

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

Field Detail

NOT_EMPTY_REG_EXP

public static final String NOT_EMPTY_REG_EXP

Regular expression to check for not empty text.

See Also:

Constant Field Values

Constructor Detail

FormEditable

public FormEditable(@IdRes
                    int id)

Same as FormEditable(int, String) with NOT_EMPTY_REG_EXP for regExp parameter.

FormEditable

public FormEditable(@IdRes
                    int id,
                    @NonNull
                    String regExp)

Creates a new instance of FormEditable component for an editable view with the specified id and the specified regular expression.

Parameters:

id - Id used to find the editable view within the form view hierarchy of the associated FormValidator via FormValidator.findViewById(int).

regExp - The desired regular expression that is used to validate editable value obtained from the editable view during the validation process.

FormEditable

public FormEditable(@IdRes
                    int id,
                    @StringRes
                    int regExpResId)

Creates a new instance of FormEditable component for an editable view with the specified id.

Parameters:

id - Id used to find the editable view within the form view hierarchy of the associated FormValidator via FormValidator.findViewById(int).

regExpResId - Resource id of the desired regular expression that is used to validate editable value obtained from the editable view during the validation process.

FormEditable

public FormEditable(@NonNull
                    EditText editable)

Same as FormEditable(EditText, String) with NOT_EMPTY_REG_EXP for regExp parameter.

FormEditable

public FormEditable(@NonNull
                    EditText editable,
                    @StringRes
                    int regExpResId)

Same as FormEditable(EditText, String) for regular expression resource id.

Parameters:

regExpResId - Resource id of the desired regular expression.

FormEditable

public FormEditable(@NonNull
                    EditText editable,
                    @NonNull
                    String regExp)

Creates a new instance of FormEditable component for the given editable view with the specified regular expression.

Parameters:

editable - Editable view, which should be validated.

regExp - The desired regular expression used to validate editable value obtained from the editable view during the validation process.

See Also:

BaseFormComponent.BaseFormComponent(int, View)

Method Detail

hasInputChanged

public boolean hasInputChanged()

Description copied from interface: FormComponent

Checks whether the current value of this form component has changed since its last validation.

Basically, whenever this returns true this component should be validated, otherwise there is no need given the fact that its value did not change.

Specified by:

hasInputChanged in interface FormComponent<EditText,CharSequence>

Overrides:

hasInputChanged in class BaseFormComponent<EditText,CharSequence>

Returns:

True if the current value is different from the one that has been last time validated via FormComponent.validate(), false otherwise.

onValidate

protected boolean onValidate(@NonNull
                             CharSequence input)

Description copied from class: BaseFormComponent

Invoked whenever BaseFormComponent.validate() is called. Note, that there will be BaseFormComponent.resetCurrentState() always called before this.

Specified by:

onValidate in class BaseFormComponent<EditText,CharSequence>

Parameters:

input - Current input of this form component to be validated.

Returns:

Should return true if the current form component's view state passed validation requirements, false otherwise.

See Also:

FormComponent.getInput()

getInput

@NonNull
public CharSequence getInput()

Description copied from interface: FormComponent

Returns the current input presented by an attached view of this form component. Type of input is determined by a specific form component type and may vary.

Returns:

Current input of this form component presented by its view.

getEditableInput

@Nullable
public Editable getEditableInput()

Returns the current editable value of the attached text field view.

Returns:

Current editable, or null if view of this component is null.

setError

public void setError(@NonNull
                     CharSequence errorMessage)

Description copied from interface: FormComponent

Sets an error for this form component.

Note, that a specific implementations can ignore this call and also depends on the specific implementation how the requested error parameter will be shown.

Parameters:

errorMessage - The desired error message.

See Also:

FormComponent.clearError()

clearError

public void clearError()

Description copied from interface: FormComponent

Clears the current error (if any) of this form component specified via FormComponent.setError(CharSequence).

Specified by:

clearError in interface FormComponent<EditText,CharSequence>

Overrides:

clearError in class BaseFormComponent<EditText,CharSequence>

onAttachedToValidator

protected void onAttachedToValidator(@NonNull
                                     FormValidator validator)

Description copied from class: BaseFormComponent

Invoked whenever this form component is assigned to the passed validator.

Overrides:

onAttachedToValidator in class BaseFormComponent<EditText,CharSequence>

Parameters:

validator - An instance of FormValidator to which was this form component newly assigned.