universum.studios.android.form

Interface FormComponent<ComponentView extends View,Input>

All Known Implementing Classes:

BaseFormComponent, FormCheckable, FormComponentsGroup, FormEditable, FormEditableLayout

public interface FormComponent<ComponentView extends View,Input>

A FormComponent is a general abstraction for 'object that is part of a form', more exactly an object which wraps a view that is part of a view hierarchy representing a form of which input data need to be validated.

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
void	attachToValidator(FormValidator validator) Attaches this form component to the given validator.
void	clearError() Clears the current error (if any) of this form component specified via setError(CharSequence).
FormComponent	findComponent(int componentId) Looks for a form component with the requested id.
int	getId() Returns the id of this component.
Input	getInput() Returns the current input presented by an attached view of this form component.
ComponentView	getView() Returns the view attached to this form component.
boolean	hasError() Checks whether this form component has error specified or not.
boolean	hasInputChanged() Checks whether the current value of this form component has changed since its last validation.
void	setError(CharSequence errorMessage) Sets an error for this form component.
boolean	validate() Runs validation process of this form component.

Method Detail

attachToValidator

void attachToValidator(@NonNull
                       FormValidator validator)

Attaches this form component to the given validator.

Parameters:

validator - An instance of FormValidator with which is this form component associated.

hasInputChanged

boolean hasInputChanged()

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.

Returns:

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

validate

boolean validate()

Runs validation process of this form component.

Returns:

True if the current state of this form component's view is valid, false otherwise.

getId

int getId()

Returns the id of this component.

Returns:

This form component's id.

getView

@Nullable
ComponentView getView()

Returns the view attached to this form component.

Returns:

This form component's view.

getInput

@NonNull
Input getInput()

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.

setError

void setError(@NonNull
              CharSequence errorMessage)

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:

clearError()

hasError

boolean hasError()

Checks whether this form component has error specified or not.

Returns:

True if error has been specified via setError(CharSequence), false if not or has been cleared via clearError().

clearError

void clearError()

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

findComponent

@Nullable
FormComponent findComponent(int componentId)

Looks for a form component with the requested id.

Parameters:

componentId - Id of the desired component to find.

Returns:

An instance of the requested form component, null if component with such a componentId was not found.