Skip navigation links
Android Forms 1.0.0-beta1 Documentation
A B C F G H I M N O R S U V 

A

addComponent(FormComponent) - Method in class universum.studios.android.form.FormComponentsGroup
Adds the given form component into this group.
addComponents(FormComponent...) - Method in class universum.studios.android.form.FormComponentsGroup
Adds the given form components into this group.
assignComponent(FormComponent) - Method in class universum.studios.android.form.FormValidator
Assigns the given form component to this validator.
assignComponents(FormComponent...) - Method in class universum.studios.android.form.FormValidator
Assigns the given form components to this validator.
assignComponentViews(int...) - Method in class universum.studios.android.form.FormValidator
Assigns the set of ids of views which should be validated by this validator.
attachToValidator(FormValidator) - Method in class universum.studios.android.form.BaseFormComponent
 
attachToValidator(FormValidator) - Method in interface universum.studios.android.form.FormComponent
Attaches this form component to the given validator.
attachToValidator(FormValidator) - Method in class universum.studios.android.form.FormComponentsGroup
 

B

BaseFormComponent<ComponentView extends View,Input> - Class in universum.studios.android.form
A FormComponent implementation that can be used as base for specific form components implementations.
BaseFormComponent(int) - Constructor for class universum.studios.android.form.BaseFormComponent
Creates a new instance of base FormComponent.
BaseFormComponent(ComponentView) - Constructor for class universum.studios.android.form.BaseFormComponent
Creates a new instance of base FormComponent.
BaseFormComponent(int, ComponentView) - Constructor for class universum.studios.android.form.BaseFormComponent
Creates a new instance of base FormComponent.

C

clearError() - Method in class universum.studios.android.form.BaseFormComponent
 
clearError() - Method in class universum.studios.android.form.FormCheckable
This implementation does nothing.
clearError() - Method in interface universum.studios.android.form.FormComponent
Clears the current error (if any) of this form component specified via FormComponent.setError(CharSequence).
clearError() - Method in class universum.studios.android.form.FormComponentsGroup
Clears the current errors of all components within this group.
clearError() - Method in class universum.studios.android.form.FormEditable
 
clearError() - Method in class universum.studios.android.form.FormEditableLayout
 
clearErrors() - Method in class universum.studios.android.form.FormValidator
Clears the current errors of all assigned components.

F

findComponent(int) - Method in class universum.studios.android.form.BaseFormComponent
 
findComponent(int) - Method in interface universum.studios.android.form.FormComponent
Looks for a form component with the requested id.
findComponent(int) - Method in class universum.studios.android.form.FormValidator
Returns an instance of FormComponent with the requested id.
findComponentTraversal(int) - Method in class universum.studios.android.form.BaseFormComponent
Called immediately after BaseFormComponent.findComponent(int) if the passed componentId is valid.
findComponentTraversal(int) - Method in class universum.studios.android.form.FormComponentsGroup
Will search within the current form components to find a one with the requested id.
FormCheckable<ComponentView extends View & Checkable> - Class in universum.studios.android.form
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.
FormCheckable(int) - Constructor for class universum.studios.android.form.FormCheckable
Same as FormCheckable.FormCheckable(int, boolean) with requiresChecked parameter set to true.
FormCheckable(int, boolean) - Constructor for class universum.studios.android.form.FormCheckable
Creates a new instance of FormCheckable component for a checkable view with the specified id.
FormCheckable(ComponentView) - Constructor for class universum.studios.android.form.FormCheckable
Same as FormCheckable.FormCheckable(View, boolean) with requiresChecked parameter set to true.
FormCheckable(ComponentView, boolean) - Constructor for class universum.studios.android.form.FormCheckable
Creates a new instance of FormCheckable component for the given checkable view.
FormComponent<ComponentView extends View,Input> - Interface in universum.studios.android.form
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.
FormComponentsGroup - Class in universum.studios.android.form
Groups a set of FormComponents into one group which can be validated.
FormComponentsGroup(int) - Constructor for class universum.studios.android.form.FormComponentsGroup
Creates a new instance of FormComponentsGroup to
FormEditable - Class in universum.studios.android.form
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.
FormEditable(int) - Constructor for class universum.studios.android.form.FormEditable
FormEditable(int, String) - Constructor for class universum.studios.android.form.FormEditable
Creates a new instance of FormEditable component for an editable view with the specified id and the specified regular expression.
FormEditable(int, int) - Constructor for class universum.studios.android.form.FormEditable
Creates a new instance of FormEditable component for an editable view with the specified id.
FormEditable(EditText) - Constructor for class universum.studios.android.form.FormEditable
FormEditable(EditText, int) - Constructor for class universum.studios.android.form.FormEditable
Same as FormEditable.FormEditable(EditText, String) for regular expression resource id.
FormEditable(EditText, String) - Constructor for class universum.studios.android.form.FormEditable
Creates a new instance of FormEditable component for the given editable view with the specified regular expression.
FormEditableLayout - Class in universum.studios.android.form
A BaseFormComponent implementation which wraps form EditLayout into component that can be validated by FormValidator when validating a form in which is such a layout presented.
FormEditableLayout(int) - Constructor for class universum.studios.android.form.FormEditableLayout
FormEditableLayout(int, String) - Constructor for class universum.studios.android.form.FormEditableLayout
Creates a new instance of FormEditableLayout component for an editable input layout with the specified id and the specified regular expression.
FormEditableLayout(int, int) - Constructor for class universum.studios.android.form.FormEditableLayout
Creates a new instance of FormEditableLayout component for an an editable input layout with the specified id.
FormEditableLayout(EditLayout) - Constructor for class universum.studios.android.form.FormEditableLayout
FormEditableLayout(EditLayout, int) - Constructor for class universum.studios.android.form.FormEditableLayout
Same as FormEditableLayout.FormEditableLayout(EditLayout, String) for regular expression resource id.
FormEditableLayout(EditLayout, String) - Constructor for class universum.studios.android.form.FormEditableLayout
Creates a new instance of FormEditable component for the given editable view with the specified regular expression.
FormValidator - Class in universum.studios.android.form
A FormValidator can be used to simplify validation process of a form with user inputs like EditTexts or CompoundButtons (CheckBox, RadioButton, ...).
FormValidator(View) - Constructor for class universum.studios.android.form.FormValidator
FormValidator(View, int) - Constructor for class universum.studios.android.form.FormValidator
Creates a new instance of FormValidator for the given formView with the specified validation mode.
FormValidator.OnFormListener - Interface in universum.studios.android.form
Simple listener to receive callbacks when some validation errors occurs during form validation process and also callback with the result of validation process.
FormValidator.ValidationMode - Annotation Type in universum.studios.android.form
Defines an annotation for determining set of allowed validation modes for FormValidator.setValidationMode(int) method.

G

getComponent(int) - Method in class universum.studios.android.form.FormComponentsGroup
Returns an instance of FormComponent with the requested id.
getComponent(int) - Method in class universum.studios.android.form.FormValidator
Returns an instance of FormComponent with the requested id.
getComponents() - Method in class universum.studios.android.form.FormComponentsGroup
Returns all components from this group.
getComponents() - Method in class universum.studios.android.form.FormValidator
Returns the set of current form components of this validator.
getContext() - Method in class universum.studios.android.form.FormValidator
Returns the context obtained from the context wrapper during initialization of this validator.
getEditableInput() - Method in class universum.studios.android.form.FormEditable
Returns the current editable value of the attached text field view.
getEditableInput() - Method in class universum.studios.android.form.FormEditableLayout
Returns the current editable value of the attached text field view.
getId() - Method in class universum.studios.android.form.BaseFormComponent
 
getId() - Method in interface universum.studios.android.form.FormComponent
Returns the id of this component.
getInput() - Method in class universum.studios.android.form.FormCheckable
 
getInput() - Method in interface universum.studios.android.form.FormComponent
Returns the current input presented by an attached view of this form component.
getInput() - Method in class universum.studios.android.form.FormComponentsGroup
Always returns null, as a group of form components does not have a specific view attached thus it cannot have any input also.
getInput() - Method in class universum.studios.android.form.FormEditable
 
getInput() - Method in class universum.studios.android.form.FormEditableLayout
 
getInvalidComponent() - Method in class universum.studios.android.form.FormComponentsGroup
Returns currently invalid form component.
getLastValidatedInput() - Method in class universum.studios.android.form.BaseFormComponent
Returns the input that has been last time validated via BaseFormComponent.validate().
getResources() - Method in class universum.studios.android.form.BaseFormComponent
Returns the resources obtained form the current attached FormValidator.
getValidationMode() - Method in class universum.studios.android.form.FormValidator
Returns the current validation mode of this validator.
getValidator() - Method in class universum.studios.android.form.BaseFormComponent
Returns the instance of FormValidator to which is this form component currently attached.
getView() - Method in class universum.studios.android.form.BaseFormComponent
 
getView() - Method in interface universum.studios.android.form.FormComponent
Returns the view attached to this form component.
getView() - Method in class universum.studios.android.form.FormComponentsGroup
Always returns null, as a group of form components does not have a specific view attached.

H

hasError() - Method in class universum.studios.android.form.BaseFormComponent
 
hasError() - Method in interface universum.studios.android.form.FormComponent
Checks whether this form component has error specified or not.
hasInputChanged() - Method in class universum.studios.android.form.BaseFormComponent
 
hasInputChanged() - Method in interface universum.studios.android.form.FormComponent
Checks whether the current value of this form component has changed since its last validation.
hasInputChanged() - Method in class universum.studios.android.form.FormComponentsGroup
 
hasInputChanged() - Method in class universum.studios.android.form.FormEditable
 
hasInputChanged() - Method in class universum.studios.android.form.FormEditableLayout
 

I

isAttachedToValidator() - Method in class universum.studios.android.form.BaseFormComponent
Returns flag indicating whether this form component is attached to FormValidator ot not.
isChecked() - Method in class universum.studios.android.form.FormCheckable
Checks, whether the compound view of this component is checked or not.
isGroup(FormComponent) - Static method in class universum.studios.android.form.FormComponentsGroup
Checks whether the given component represents group of form components or not.

M

mContext - Variable in class universum.studios.android.form.FormValidator
Context in which is this validator used.
mFormView - Variable in class universum.studios.android.form.FormValidator
View in which are placed all form component views.

N

NOT_EMPTY_REG_EXP - Static variable in class universum.studios.android.form.FormEditable
Regular expression to check for not empty text.

O

obtainString(int) - Method in class universum.studios.android.form.BaseFormComponent
Wrapped Resources.getString(int) (int)} on resources obtained from the current attached FormValidator.
obtainText(int) - Method in class universum.studios.android.form.BaseFormComponent
Wrapped Resources.getText(int) on resources obtained from the current attached FormValidator.
onAssignComponentForView(View) - Method in class universum.studios.android.form.FormValidator
Invoked to assign a new form component to this validator for the specified componentView.
onAttachedToValidator(FormValidator) - Method in class universum.studios.android.form.BaseFormComponent
Invoked whenever this form component is assigned to the passed validator.
onAttachedToValidator(FormValidator) - Method in class universum.studios.android.form.FormEditable
 
onAttachedToValidator(FormValidator) - Method in class universum.studios.android.form.FormEditableLayout
 
onComponentViewAttached(ComponentView) - Method in class universum.studios.android.form.BaseFormComponent
Invoked only once, when there was BaseFormComponent.validate() called and the current component view is null and here passed view was successfully obtained from the current context root view hierarchy.
onValidate(Input) - Method in class universum.studios.android.form.BaseFormComponent
Invoked whenever BaseFormComponent.validate() is called.
onValidate(Boolean) - Method in class universum.studios.android.form.FormCheckable
 
onValidate(Void) - Method in class universum.studios.android.form.FormComponentsGroup
 
onValidate(CharSequence) - Method in class universum.studios.android.form.FormEditable
 
onValidate(CharSequence) - Method in class universum.studios.android.form.FormEditableLayout
 
onValidationError(FormValidator, FormComponent) - Method in interface universum.studios.android.form.FormValidator.OnFormListener
Invoked during validation process, when the passed form component returns false from BaseFormComponent.validate().
onValidationResult(FormValidator, boolean) - Method in interface universum.studios.android.form.FormValidator.OnFormListener
Invoked at the end of each validation process.

R

resetCurrentState() - Method in class universum.studios.android.form.BaseFormComponent
Called to reset the current state of this form component.
runValidation() - Method in class universum.studios.android.form.FormValidator
Runs validation process upon the current set of form components.

S

setError(CharSequence) - Method in class universum.studios.android.form.FormCheckable
 
setError(CharSequence) - Method in interface universum.studios.android.form.FormComponent
Sets an error for this form component.
setError(CharSequence) - Method in class universum.studios.android.form.FormComponentsGroup
This implementation does nothing.
setError(CharSequence) - Method in class universum.studios.android.form.FormEditable
 
setError(CharSequence) - Method in class universum.studios.android.form.FormEditableLayout
 
setHasError(boolean) - Method in class universum.studios.android.form.BaseFormComponent
Sets a boolean flag indicating whether this form component has error set or not.
setOnFormListener(FormValidator.OnFormListener) - Method in class universum.studios.android.form.FormValidator
Registers a callback to be invoked when some validation error occurs during form validation process or when validation process is finished with the validation result.
setSubmitView(int) - Method in class universum.studios.android.form.FormValidator
Same as FormValidator.setSubmitView(View) for id of the submit view that will be searched for in the form view.
setSubmitView(View) - Method in class universum.studios.android.form.FormValidator
Sets the submit view for this validator.
setValidationMode(int) - Method in class universum.studios.android.form.FormValidator
Sets validation mode for this validator.

U

universum.studios.android.form - package universum.studios.android.form
Provides classes that may be used to validate data of a simple form in an Android UI, like username, password input and/or checkable input.

V

validate() - Method in class universum.studios.android.form.BaseFormComponent
 
validate() - Method in interface universum.studios.android.form.FormComponent
Runs validation process of this form component.
validate() - Method in class universum.studios.android.form.FormComponentsGroup
 
VALIDATION_MODE_BULK - Static variable in class universum.studios.android.form.FormValidator
Mode used to validate all currently assigned BaseFormComponents.
VALIDATION_MODE_SINGLE - Static variable in class universum.studios.android.form.FormValidator
Unlike FormValidator.VALIDATION_MODE_BULK, when this mode is used, validation will be running until some validation error occurs.
A B C F G H I M N O R S U V 
Skip navigation links
Android Forms 1.0.0-beta1 Documentation