org.dominokit.domino.ui.forms

Class FieldsGrouping

java.lang.Object

org.dominokit.domino.ui.forms.FieldsGrouping

All Implemented Interfaces:

HasValidation<FieldsGrouping>

public class FieldsGrouping
extends Object
implements HasValidation<FieldsGrouping>

This class can logically group a set of components that implements HasGrouping interface

The same component can be grouped using multiple FieldGrouping instances

The FieldsGrouping can be used to perform common logic to all grouped component with a single call

example

     FieldsGrouping.create()
         .addFormElement(nameTextBox)
         .addFormElement(phoneTextBox)
         .addFormElement(emailBox)
         .setRequired(true)
         .setAutoValidation(true);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FieldsGrouping.KeyboardEventsHandler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation

HasValidation.Validator

Constructor Summary

Constructors

Constructor and Description
FieldsGrouping()

Method Summary

Modifier and Type	Method and Description
FieldsGrouping	addFormElement(HasGrouping<?> formElement) Adds a component that implements HasGrouping
FieldsGrouping	addValidator(HasValidation.Validator validator) Adds a validator to this FieldsGrouping, the validator will be applied to all grouped elements when validate() is called
FieldsGrouping	clear() Clears all the grouped components
FieldsGrouping	clear(boolean silent) Clears all the grouped components
FieldsGrouping	clearInvalid() Removes all error messages and mark the component as valid
static FieldsGrouping	create()
FieldsGrouping	disable() Disable all grouped components
FieldsGrouping	enable() Enable all grouped components
List<String>	getErrors()
List<HasGrouping<?>>	getFormElements()
FieldsGrouping	group(HasGrouping<?>... formElements) Adds a component that implements HasGrouping
boolean	hasValidator(HasValidation.Validator validator)
FieldsGrouping	invalidate(List<String> errorMessages) Mark the component as invalid with a list of error messages
FieldsGrouping	invalidate(String errorMessage) Mark the component as invalid with the specified error message
boolean	isAutoValidation()
boolean	isEnabled()
boolean	isRequired()
FieldsGrouping	onKeyDown(FieldsGrouping.KeyboardEventsHandler handler)
FieldsGrouping	onKeyPress(FieldsGrouping.KeyboardEventsHandler handler)
FieldsGrouping	onKeyUp(FieldsGrouping.KeyboardEventsHandler handler)
FieldsGrouping	removeAllFormElements() Removes all grouped components from this FieldsGrouping
FieldsGrouping	removeFormElement(HasGrouping hasGrouping) Removes a grouped component from this FieldsGrouping
FieldsGrouping	removeValidator(HasValidation.Validator validator)
FieldsGrouping	setAutoValidation(boolean autoValidation)
FieldsGrouping	setReadOnly(boolean readOnly) change the readonly mode for all grouped components
FieldsGrouping	setRequired(boolean required) Disable/Enable required for all grouped components
FieldsGrouping	setRequired(boolean required, String message) Disable/Enable required for all grouped components with a custom required message
ValidationResult	validate() validate the component and fail-fast with first error

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.HasValidation

validateAll

Constructor Detail

FieldsGrouping

public FieldsGrouping()

Method Detail

create

public static FieldsGrouping create()

Returns:

a new instance

addFormElement

public FieldsGrouping addFormElement(HasGrouping<?> formElement)

Adds a component that implements HasGrouping

Parameters:

formElement - HasGrouping

Returns:

same FieldGrouping instance

group

public FieldsGrouping group(HasGrouping<?>... formElements)

Adds a component that implements HasGrouping

Parameters:

formElements - a vararg of HasGrouping

Returns:

same FieldGrouping instance

validate

public ValidationResult validate()

validate the component and fail-fast with first error validate all components grouped by this FieldsGrouping in fail-fast mode

Specified by:

validate in interface HasValidation<FieldsGrouping>

Returns:

same implementing component

clear

public FieldsGrouping clear()

Clears all the grouped components

Returns:

same FieldsGrouping instance

clear

public FieldsGrouping clear(boolean silent)

Clears all the grouped components

Parameters:

silent - if true clear the fields without triggering the change handlers

Returns:

same FieldsGrouping instance

clearInvalid

public FieldsGrouping clearInvalid()

Removes all error messages and mark the component as valid Remove all validation messages from all grouped components

Specified by:

clearInvalid in interface HasValidation<FieldsGrouping>

Returns:

same implementing component

invalidate

public FieldsGrouping invalidate(String errorMessage)

Mark the component as invalid with the specified error message Invalidate all the grouped components using the provided errorMessage

Specified by:

invalidate in interface HasValidation<FieldsGrouping>

Parameters:

errorMessage - String

Returns:

same implementing component

invalidate

public FieldsGrouping invalidate(List<String> errorMessages)

Mark the component as invalid with a list of error messages Invalidate all the grouped components using the provided list of errorMessages

Specified by:

invalidate in interface HasValidation<FieldsGrouping>

Parameters:

errorMessages - List of String error messages

Returns:

same implementing component

setReadOnly

public FieldsGrouping setReadOnly(boolean readOnly)

change the readonly mode for all grouped components

Parameters:

readOnly - boolean, if true change all grouped components to readonly mode, otherwise switch them out of readonly mode

Returns:

same FieldsGrouping instance

disable

public FieldsGrouping disable()

Disable all grouped components

Returns:

same FieldsGrouping instance

enable

public FieldsGrouping enable()

Enable all grouped components

Returns:

same FieldsGrouping instance

isEnabled

public boolean isEnabled()

Returns:

boolean, true if all grouped components are enabled, otherwise false

setAutoValidation

public FieldsGrouping setAutoValidation(boolean autoValidation)

Parameters:

autoValidation - boolean, if true enables autoValidation for all grouped components, otherwise disable autoValidation

Returns:

isAutoValidation

public boolean isAutoValidation()

Returns:

boolean, true if all grouped components has autoValidation enabled

setRequired

public FieldsGrouping setRequired(boolean required)

Disable/Enable required for all grouped components

Parameters:

required - boolean, if true set all grouped components to required, otherwise to not required

Returns:

same FieldsGrouping instance

setRequired

public FieldsGrouping setRequired(boolean required,
                                  String message)

Disable/Enable required for all grouped components with a custom required message

Parameters:

required - boolean, if true set all grouped components to required, otherwise to not required

message - String required validation message

Returns:

same FieldsGrouping instance

isRequired

public boolean isRequired()

Returns:

boolean, true if all grouped components are required

getFormElements

public List<HasGrouping<?>> getFormElements()

Returns:

the grouped components as a List of HasGrouping

addValidator

public FieldsGrouping addValidator(HasValidation.Validator validator)

Adds a validator to this FieldsGrouping, the validator will be applied to all grouped elements when validate() is called

Specified by:

addValidator in interface HasValidation<FieldsGrouping>

Parameters:

validator - Validator

Returns:

same FieldsGrouping instance

removeValidator

public FieldsGrouping removeValidator(HasValidation.Validator validator)

Specified by:

removeValidator in interface HasValidation<FieldsGrouping>

Parameters:

validator - HasValidation.Validator

Returns:

same implementing component

hasValidator

public boolean hasValidator(HasValidation.Validator validator)

Specified by:

hasValidator in interface HasValidation<FieldsGrouping>

Parameters:

validator - HasValidation.Validator

Returns:

same implementing component

removeFormElement

public FieldsGrouping removeFormElement(HasGrouping hasGrouping)

Removes a grouped component from this FieldsGrouping

Parameters:

hasGrouping - HasGrouping

Returns:

same FieldsGrouping instance

removeAllFormElements

public FieldsGrouping removeAllFormElements()

Removes all grouped components from this FieldsGrouping

Returns:

same FieldsGrouping insatnce

getErrors

public List<String> getErrors()

Specified by:

getErrors in interface HasValidation<FieldsGrouping>

Returns:

a List of String error messages

onKeyDown

public FieldsGrouping onKeyDown(FieldsGrouping.KeyboardEventsHandler handler)

onKeyUp

public FieldsGrouping onKeyUp(FieldsGrouping.KeyboardEventsHandler handler)

onKeyPress

public FieldsGrouping onKeyPress(FieldsGrouping.KeyboardEventsHandler handler)