universum.studios.android.form

Class FormComponentsGroup

java.lang.Object

universum.studios.android.form.BaseFormComponent<View,Void>

universum.studios.android.form.FormComponentsGroup

All Implemented Interfaces:

FormComponent<View,Void>

public class FormComponentsGroup
extends BaseFormComponent<View,Void>

Groups a set of FormComponents into one group which can be validated. There is only one difference between group of all components within FormValidator and group of components here. If during validation process there is found an invalid component (FormComponent.validate() of one of group components returns false), validation of such group stops and no next form components from that group are validated.

Invalid form component for the current validation process can be obtained via getInvalidComponent(). This can be useful, when there are components in form, where some of them depends on each other and if some of these dependent components is invalid, there is no need to check next ones.

Since:

1.0

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
FormComponentsGroup(int id) Creates a new instance of FormComponentsGroup to

Method Summary

Modifier and Type	Method and Description
FormComponentsGroup	addComponent(FormComponent component) Adds the given form component into this group.
FormComponentsGroup	addComponents(FormComponent... components) Adds the given form components into this group.
void	attachToValidator(FormValidator validator) Attaches this form component to the given validator.
void	clearError() Clears the current errors of all components within this group.
protected FormComponent	findComponentTraversal(int id) Will search within the current form components to find a one with the requested id.
FormComponent	getComponent(int componentId) Returns an instance of FormComponent with the requested id.
SparseArray<FormComponent>	getComponents() Returns all components from this group.
Void	getInput() Always returns null, as a group of form components does not have a specific view attached thus it cannot have any input also.
FormComponent	getInvalidComponent() Returns currently invalid form component.
View	getView() Always returns null, as a group of form components does not have a specific view attached.
boolean	hasInputChanged() Checks whether the current value of this form component has changed since its last validation.
static boolean	isGroup(FormComponent component) Checks whether the given component represents group of form components or not.
protected boolean	onValidate(Void input) Invoked whenever BaseFormComponent.validate() is called.
void	setError(CharSequence errorMessage) This implementation does nothing.
boolean	validate() Runs validation process of this form component.

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

findComponent, getId, getLastValidatedInput, getResources, getValidator, hasError, isAttachedToValidator, obtainString, obtainText, onAttachedToValidator, onComponentViewAttached, resetCurrentState, setHasError

Methods inherited from class java.lang.Object

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

Constructor Detail

FormComponentsGroup

public FormComponentsGroup(int id)

Creates a new instance of FormComponentsGroup to

Parameters:

id - The id representing this group of form components.

Method Detail

isGroup

public static boolean isGroup(@NonNull
                              FormComponent component)

Checks whether the given component represents group of form components or not.

Parameters:

component - An instance of form component to check for group.

Returns:

True if the given component is group, false otherwise.

attachToValidator

public void attachToValidator(@NonNull
                              FormValidator validator)

Description copied from interface: FormComponent

Attaches this form component to the given validator.

Specified by:

attachToValidator in interface FormComponent<View,Void>

Overrides:

attachToValidator in class BaseFormComponent<View,Void>

Parameters:

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

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<View,Void>

Overrides:

hasInputChanged in class BaseFormComponent<View,Void>

Returns:

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

validate

public boolean validate()

Description copied from interface: FormComponent

Runs validation process of this form component.

Specified by:

validate in interface FormComponent<View,Void>

Overrides:

validate in class BaseFormComponent<View,Void>

Returns:

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

onValidate

protected boolean onValidate(@Nullable
                             Void 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<View,Void>

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()

addComponents

public FormComponentsGroup addComponents(@NonNull
                                         FormComponent... components)

Adds the given form components into this group. See FormComponentsGroup class description for info about how group of form components behave during validation.

Parameters:

components - Form components which should be part of this group.

Returns:

This group to allow methods chaining.

addComponent

public FormComponentsGroup addComponent(@NonNull
                                        FormComponent component)

Adds the given form component into this group. See FormComponentsGroup class description for info about how group of form components behave during validation.

Parameters:

component - Form component which should be part of this group.

Returns:

This group to allow methods chaining.

getView

@Nullable
public View getView()

Always returns null, as a group of form components does not have a specific view attached.

Specified by:

getView in interface FormComponent<View,Void>

Overrides:

getView in class BaseFormComponent<View,Void>

Returns:

This form component's view.

getInput

@NonNull
public Void getInput()

Always returns null, as a group of form components does not have a specific view attached thus it cannot have any input also.

Returns:

Current input of this form component presented by its view.

getComponents

@NonNull
public SparseArray<FormComponent> getComponents()

Returns all components from this group.

Returns:

The current set of form components.

getComponent

@Nullable
public FormComponent getComponent(int componentId)

Returns an instance of FormComponent with the requested id. Unlike BaseFormComponent.findComponent(int), this will check only at the top of the current components hierarchy.

Parameters:

componentId - Id of the desired form component to obtain.

Returns:

Instance of requested form component with the specified id or null if there is no such a form component presented within this group.

getInvalidComponent

@Nullable
public FormComponent getInvalidComponent()

Returns currently invalid form component.

Returns:

An instance of FormComponent which returns false from BaseFormComponent.validate() during the last validation process, or null if there was no validation requested upon this group yet, or the last validation was successful.

setError

public void setError(@NonNull
                     CharSequence errorMessage)

This implementation does nothing.

Parameters:

errorMessage - The desired error message.

See Also:

FormComponent.clearError()

clearError

public void clearError()

Clears the current errors of all components within this group.

Specified by:

clearError in interface FormComponent<View,Void>

Overrides:

clearError in class BaseFormComponent<View,Void>

findComponentTraversal

@Nullable
protected FormComponent findComponentTraversal(int id)

Will search within the current form components to find a one with the requested id.

Overrides:

findComponentTraversal in class BaseFormComponent<View,Void>

Parameters:

id - Id of the desired component to find.

Returns:

An instance of requested component (can be also this group), null if this group does not contain form component with such an id.