universum.studios.android.form

Class FormCheckable<V extends View & Checkable>

java.lang.Object

universum.studios.android.form.BaseFormComponent<V,Boolean>

universum.studios.android.form.FormCheckable<V>

All Implemented Interfaces:

FormComponent<V,Boolean>

public class FormCheckable<V extends View & Checkable>
extends BaseFormComponent<V,Boolean>

A BaseFormComponent implementation that wraps form checkable view like CheckBox or RadioButton 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:

FormEditable

Constructor Summary

Constructors

Constructor and Description
FormCheckable(int id) Same as FormCheckable(int, boolean) with requiresChecked parameter set to true.
FormCheckable(int id, boolean requiresChecked) Creates a new instance of FormCheckable component for a checkable view with the specified id.
FormCheckable(V checkable) Same as FormCheckable(View, boolean) with requiresChecked parameter set to true.
FormCheckable(V checkable, boolean requiresChecked) Creates a new instance of FormCheckable component for the given checkable view.

Method Summary

Modifier and Type	Method and Description
void	clearError() This implementation does nothing.
Boolean	getInput() Returns the current input presented by an attached view of this form component.
boolean	isChecked() Checks, whether the compound view of this component is checked or not.
protected boolean	onValidate(Boolean 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, hasInputChanged, isAttachedToValidator, obtainString, obtainText, onAttachedToValidator, onComponentViewAttached, resetCurrentState, setHasError, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

FormCheckable

public FormCheckable(@IdRes
                     int id)

Same as FormCheckable(int, boolean) with requiresChecked parameter set to true.

FormCheckable

public FormCheckable(@IdRes
                     int id,
                     boolean requiresChecked)

Creates a new instance of FormCheckable component for a checkable view with the specified id.

Parameters:

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

requiresChecked - Flag to be compared to the checked state of the checkable view during the validation process.

FormCheckable

public FormCheckable(@NonNull
                     V checkable)

Same as FormCheckable(View, boolean) with requiresChecked parameter set to true.

FormCheckable

public FormCheckable(@NonNull
                     V checkable,
                     boolean requiresChecked)

Creates a new instance of FormCheckable component for the given checkable view.

Parameters:

checkable - Checkable view that should be validated.

requiresChecked - Flag to be compared to the checked state of the checkable view during the validation process.

See Also:

BaseFormComponent.BaseFormComponent(int, View)

Method Detail

onValidate

protected boolean onValidate(@NonNull
                             Boolean 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<V extends View & Checkable,Boolean>

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

isChecked

public boolean isChecked()

Checks, whether the compound view of this component is checked or not.

Returns:

True if checkable view is checked, false otherwise.

getInput

@NonNull
public Boolean 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.

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

This implementation does nothing.

Note, that this form component cannot have error specified as it just shows a toast whenever setError(CharSequence) is called.

Specified by:

clearError in interface FormComponent<V extends View & Checkable,Boolean>

Overrides:

clearError in class BaseFormComponent<V extends View & Checkable,Boolean>