BaseFormComponent (Android Forms API)

java.lang.Object
- universum.studios.android.form.BaseFormComponent<V,I>

Type Parameters:

V - Type of the view specific for this form component.

I - Type of the input that can be presented within the component view.

All Implemented Interfaces:

FormComponent<V,I>

Direct Known Subclasses:

FormCheckable, FormComponentsGroup, FormEditable, FormEditableLayout
```
public abstract class BaseFormComponent<V extends android.view.View,I>
extends Object
implements FormComponent<V,I>
```
A FormComponent implementation that can be used as base for specific form components implementations.
This 'wrapper' is used by FormValidator that can be used to validate these input data. The FormValidator will call validate() on each of its attached form components during the validation process. If some error occurs, the FormValidator will fire error callback and if needed a desired error can be set to the error component via FormComponent.setError(CharSequence). The form validator to which is the form component currently attached can be accessed via getValidator().
Each form component must be created with its view of which validation will be then handled by that component. There are two base constructors for this purpose:
- BaseFormComponent(int)
  Use this constructor when you want to be a form view attached automatically by its form component when needed using its id.
- BaseFormComponent(View)
  Use this constructor when you have already access to a form view.
Wrapped form view can be accessed via getView().
Since:

1.0

Author:

Martin Albedinsky

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseFormComponent(int id)` Creates a new instance of base FormComponent.
`protected`	`BaseFormComponent(int id, V view)` Creates a new instance of base FormComponent.
`protected`	`BaseFormComponent(V view)` Creates a new instance of base FormComponent.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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 `FormComponent.setError(CharSequence)`.
`FormComponent`	`findComponent(int componentId)` Looks for a form component with the requested `id`.
`protected FormComponent`	`findComponentTraversal(int id)` Called immediately after `findComponent(int)` if the passed `componentId` is valid.
`int`	`getId()` Returns the id of this component.
`protected I`	`getLastValidatedInput()` Returns the input that has been last time validated via `validate()`.
`protected android.content.res.Resources`	`getResources()` Returns the resources obtained form the current attached FormValidator.
`FormValidator`	`getValidator()` Returns the instance of `FormValidator` to which is this form component currently attached.
`V`	`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.
`boolean`	`isAttachedToValidator()` Returns flag indicating whether this form component is attached to FormValidator ot not.
`protected String`	`obtainString(int resId)` Wrapped `Resources.getString(int)` (int)} on resources obtained from the current attached FormValidator.
`protected CharSequence`	`obtainText(int resId)` Wrapped `Resources.getText(int)` on resources obtained from the current attached FormValidator.
`protected void`	`onAttachedToValidator(FormValidator validator)` Invoked whenever this form component is assigned to the passed `validator`.
`protected void`	`onComponentViewAttached(V view)` Invoked only once, when there was `validate()` called and the current component view is `null` and here passed `view` was successfully obtained from the current context root view hierarchy.
`protected abstract boolean`	`onValidate(I input)` Invoked whenever `validate()` is called.
`protected void`	`resetCurrentState()` Called to reset the current state of this form component.
`protected void`	`setHasError(boolean hasError)` Sets a boolean flag indicating whether this form component has error set or not.
`boolean`	`validate()` Runs validation process of this form component.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface universum.studios.android.form.FormComponent
getInput, setError

- Constructor Detail
  - BaseFormComponent
```
protected BaseFormComponent(int id)
```
    Creates a new instance of base FormComponent.
    The specified id will be used to find a view for this new form component via FormValidator.findViewById(int) when appropriate.
    
    Parameters:
    
    id - The id for the new form component. Should be unique to correctly identify different components within FormValidator or FormComponentsGroup.
  - BaseFormComponent
```
protected BaseFormComponent(@NonNull
                            V view)
```
    Creates a new instance of base FormComponent.
    Id of the specified view will be assigned also as id of this new form component.
    
    Parameters:
    
    view - The view for which is the new form component created.
  - BaseFormComponent
```
protected BaseFormComponent(int id,
                            @Nullable
                            V view)
```
    Creates a new instance of base FormComponent.
    
    Parameters:
    
    id - The id for the new form component. Should be unique to correctly identify different components within FormValidator or FormComponentsGroup.
    
    view - The view for which is the new form component created. If null the specified id will be used to find such view via FormValidator.findViewById(int) when appropriate.
- Method Detail
  - 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<V extends android.view.View,I>
    
    Parameters:
    
    validator - An instance of FormValidator with which is this form component associated.
  - onAttachedToValidator
```
protected void onAttachedToValidator(@NonNull
                                     FormValidator validator)
```
    Invoked whenever this form component is assigned to the passed validator.
    
    Parameters:
    
    validator - An instance of FormValidator to which was this form component newly assigned.
  - 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<V extends android.view.View,I>
    
    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<V extends android.view.View,I>
    
    Returns:
    
    True if the current state of this form component's view is valid, false otherwise.
  - resetCurrentState
```
protected void resetCurrentState()
```
    Called to reset the current state of this form component. This is always called from validate() before onValidate(Object) is called.
  - getLastValidatedInput
```
@Nullable
protected final I getLastValidatedInput()
```
    Returns the input that has been last time validated via validate().
    
    Returns:
    
    Last validated input or null if no validation has been performed yet.
  - onValidate
```
protected abstract boolean onValidate(@NonNull
                                      I input)
```
    Invoked whenever validate() is called. Note, that there will be resetCurrentState() always called before this.
    
    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()
  - isAttachedToValidator
```
public final boolean isAttachedToValidator()
```
    Returns flag indicating whether this form component is attached to FormValidator ot not.
    
    Returns:
    
    True if this form component is attached to FormValidator, false otherwise.
    
    See Also:
    
    getValidator()
  - getValidator
```
@Nullable
public final FormValidator getValidator()
```
    Returns the instance of FormValidator to which is this form component currently attached.
    
    Returns:
    
    An instance of FormValidator or null if this form component is not attached to any FormValidator.
    
    See Also:
    
    isAttachedToValidator()
  - getId
```
public final int getId()
```
    Description copied from interface: FormComponent
    
    Returns the id of this component.
    
    Specified by:
    
    getId in interface FormComponent<V extends android.view.View,I>
    
    Returns:
    
    This form component's id.
  - getView
```
@Nullable
public V getView()
```
    Description copied from interface: FormComponent
    
    Returns the view attached to this form component.
    
    Specified by:
    
    getView in interface FormComponent<V extends android.view.View,I>
    
    Returns:
    
    This form component's view.
  - 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<V extends android.view.View,I>
  - setHasError
```
protected final void setHasError(boolean hasError)
```
    Sets a boolean flag indicating whether this form component has error set or not.
    
    Parameters:
    
    hasError - True if error is set, false otherwise.
    
    See Also:
    
    hasError()
  - hasError
```
public boolean hasError()
```
    Description copied from interface: FormComponent
    
    Checks whether this form component has error specified or not.
    
    Specified by:
    
    hasError in interface FormComponent<V extends android.view.View,I>
    
    Returns:
    
    True if error has been specified via FormComponent.setError(CharSequence), false if not or has been cleared via FormComponent.clearError().
  - getResources
```
@Nullable
protected final android.content.res.Resources getResources()
```
    Returns the resources obtained form the current attached FormValidator.
    
    Returns:
    
    An instance of application resources or null if this form component isn't attached to any FormValidator.
  - obtainString
```
@NonNull
protected final String obtainString(@StringRes
                                             int resId)
```
    Wrapped Resources.getString(int) (int)} on resources obtained from the current attached FormValidator.
    
    Returns:
    
    Can return empty string if this form component isn't attached to any FormValidator, so no resources are available at this time.
  - obtainText
```
@NonNull
protected final CharSequence obtainText(@StringRes
                                                 int resId)
```
    Wrapped Resources.getText(int) on resources obtained from the current attached FormValidator.
    
    Returns:
    
    Can return empty text if this form component isn't attached to any FormValidator, so no resources are available at this time.
  - findComponent
```
@Nullable
public final FormComponent findComponent(int componentId)
```
    Description copied from interface: FormComponent
    
    Looks for a form component with the requested id.
    
    Specified by:
    
    findComponent in interface FormComponent<V extends android.view.View,I>
    
    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.
  - findComponentTraversal
```
@Nullable
protected FormComponent findComponentTraversal(int id)
```
    Called immediately after findComponent(int) if the passed componentId is valid. This can be useful if this component represents a group of form components.
    
    Parameters:
    
    id - Id of the desired component to find.
    
    Returns:
    
    This component if the passed id is same as this component's id, null otherwise.
  - onComponentViewAttached
```
protected void onComponentViewAttached(@NonNull
                                       V view)
```
    Invoked only once, when there was validate() called and the current component view is null and here passed view was successfully obtained from the current context root view hierarchy.
    
    Parameters:
    
    view - The view obtained from the root view of the current context by the id provided during initialization of this component.

Class BaseFormComponent<V extends android.view.View,I>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface universum.studios.android.form.FormComponent

Constructor Detail

BaseFormComponent

BaseFormComponent

BaseFormComponent

Method Detail

attachToValidator

onAttachedToValidator

hasInputChanged

validate

resetCurrentState

getLastValidatedInput

onValidate

isAttachedToValidator

getValidator

getId

getView

clearError

setHasError

hasError

getResources

obtainString

obtainText

findComponent

findComponentTraversal

onComponentViewAttached