net.infordata.ifw2.web.form

Class Form

java.lang.Object

net.infordata.ifw2.web.form.Form

All Implemented Interfaces:

java.io.Serializable, IClearableMessageSet, IMessageSet, IForm, AForm, IFormView

Direct Known Subclasses:

PojoForm

public class Form
extends java.lang.Object
implements AForm, IClearableMessageSet

A complete IForm implementation.
It cannot be registered and binded by different flows, use a FormRef in this cases.

Author:

valentino.proietti

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Form()
Form(IFieldFactory fieldsFactory)

Method Summary

Methods

Modifier and Type	Method and Description
void	addValidator(IFormValidator l)
void	addValidator(IFormValidator l, boolean checkFieldNames)
void	binded(int id) The form has been binded, do any required initialization.
<T extends IField> T	bindField(java.lang.Class<T> type, java.lang.String id) If the form has an IFieldFactory, then if the requested field has not been registered yet, then a new one is created and registered.
void	clearMessages() Removes all messages with IMessage.getAutoRemoveIndicator() setted.
boolean	containsValidator(IFormValidator l)
boolean	equals(java.lang.Object obj)
IAction	getAction(java.lang.String id)
java.util.Set<java.lang.String>	getActions()
<T> AFormField<T>	getBindedField(java.lang.Class<T> type, java.lang.String id)
AFormField<?>	getBindedField(java.lang.String id) This method is not intended to be called before IForm.bindField(Class, String).
java.util.Set<java.lang.String>	getBindedFields() This method is not intended to be called before IForm.binded(int).
IFieldContraints	getContraintsFor(java.lang.String fieldId)
<T> AFormField<T>	getField(java.lang.Class<T> type, java.lang.String id)
AFormField<?>	getField(java.lang.String id)
java.util.Set<java.lang.String>	getFields()
IFieldFactory	getFieldsFactory()
java.lang.String	getLabel(java.lang.String id) This method can be called before binding the field.
IMessage	getMessage()
IMessage	getMessage(java.lang.Enum<?> sc)
IMessage[]	getMessages()
java.util.Map<java.lang.Enum<?>,IMessage>	getMessagesMap()
StrokeStripe	getStrokes()
int	hashCode()
boolean	hasMessage()
boolean	hasMessage(MessageTypeEnum type)
boolean	hasValidationMessages(MessageTypeEnum type)
boolean	isEnabled() If disabled then actions are also disabled.
boolean	isReadOnly() In a read only form, actions are enabled but input fields are not.
boolean	isShadow() All fields in a shadow form act as shadow fields, see AFormField.setShadow(boolean).
boolean	isShadow(java.lang.String fieldId) Let the form control the single field shadow state.
Form	registerAction(java.lang.String id, IAction action) Used to add actions to the current form.
Form	registerField(java.lang.String id, AFormField<?> field)
IAction	removeAction(java.lang.String id)
void	removeAllValidators()
AFormField<?>	removeField(java.lang.String id)
boolean	removeValidator(IFormValidator l)
Form	replaceAction(java.lang.String id, IAction action)
void	setMessage(java.lang.Enum<?> sc, IMessage message)
boolean	validate(java.lang.String fieldId, java.lang.String... otherFieldsToValidate) The default implementation uses #validateImpl(String). An isShadow() does not trigger any validation and returns always true.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Form

public Form()

Form

public Form(IFieldFactory fieldsFactory)

Parameters:

fieldsFactory - - fields created by the factory must also implement the AFormField interface.

Method Detail

getFieldsFactory

public final IFieldFactory getFieldsFactory()

registerAction

public Form registerAction(java.lang.String id,
                  IAction action)

Description copied from interface: IForm

Used to add actions to the current form.

Specified by:

registerAction in interface IForm

Specified by:

registerAction in interface AForm

Parameters:

id - - the action id to be added.

action - - the IAction handler.

Returns:

itself.

replaceAction

public Form replaceAction(java.lang.String id,
                 IAction action)

Specified by:

replaceAction in interface IForm

Specified by:

replaceAction in interface AForm

Returns:

removeAction

public IAction removeAction(java.lang.String id)

Specified by:

removeAction in interface IForm

Specified by:

removeAction in interface AForm

Returns:

the removed action or null if none.

registerField

public Form registerField(java.lang.String id,
                 AFormField<?> field)

removeField

public AFormField<?> removeField(java.lang.String id)

Parameters:

id -

Returns:

the removed field or null if it doesn't exist

binded

public void binded(int id)

Description copied from interface: IForm

The form has been binded, do any required initialization. This is called before any IForm.bindField(Class, String) call.

Specified by:

binded in interface IForm

Specified by:

binded in interface AForm

Parameters:

id - - since it can be called more than once, as you can have the IForm form shared between different IFlow (if the implementation support it), this id can be used to track this situation, it changes when a new cycle of bind begins.

bindField

public <T extends IField> T bindField(java.lang.Class<T> type,
                             java.lang.String id)

If the form has an IFieldFactory, then if the requested field has not been registered yet, then a new one is created and registered.

Specified by:

bindField in interface IForm

Specified by:

bindField in interface AForm

Returns:

the binded IField
It is required that this is the of the same IField type returned by IForm.getBindedField(String).

getAction

public IAction getAction(java.lang.String id)

Specified by:

getAction in interface IForm

Specified by:

getAction in interface AForm

getActions

public java.util.Set<java.lang.String> getActions()

Specified by:

getActions in interface IForm

Specified by:

getActions in interface AForm

Returns:

a set of actions ids

getStrokes

public StrokeStripe getStrokes()

Specified by:

getStrokes in interface IForm

Specified by:

getStrokes in interface AForm

Returns:

the default StrokeStripe for the form.

getLabel

public java.lang.String getLabel(java.lang.String id)

Description copied from interface: IForm

This method can be called before binding the field.

Specified by:

getLabel in interface IForm

Specified by:

getLabel in interface AForm

Returns:

the label for the given field.

getBindedField

public AFormField<?> getBindedField(java.lang.String id)

Description copied from interface: IForm

This method is not intended to be called before IForm.bindField(Class, String).

Specified by:

getBindedField in interface IForm

Specified by:

getBindedField in interface AForm

Specified by:

getBindedField in interface IFormView

Returns:

the IField binded to the given id.

getBindedField

public final <T> AFormField<T> getBindedField(java.lang.Class<T> type,
                               java.lang.String id)

Specified by:

getBindedField in interface AForm

Specified by:

getBindedField in interface IFormView

Returns:

the binded field, ie a field with a binded ifw2 html form element

getBindedFields

public java.util.Set<java.lang.String> getBindedFields()

Description copied from interface: IForm

This method is not intended to be called before IForm.binded(int).

Specified by:

getBindedFields in interface IForm

Specified by:

getBindedFields in interface AForm

Specified by:

getBindedFields in interface IFormView

Returns:

a set of all binded fields.

getField

public AFormField<?> getField(java.lang.String id)

Specified by:

getField in interface IForm

Specified by:

getField in interface AForm

Specified by:

getField in interface IFormView

Returns:

the binded or unbinded field.

getField

public final <T> AFormField<T> getField(java.lang.Class<T> type,
                         java.lang.String id)

Specified by:

getField in interface AForm

Specified by:

getField in interface IFormView

Returns:

the binded or unbinded field.

getContraintsFor

public IFieldContraints getContraintsFor(java.lang.String fieldId)

Specified by:

getContraintsFor in interface AForm

Specified by:

getContraintsFor in interface IFormView

Returns:

contraints for the given field, null if none are defined at the form level.

getFields

public java.util.Set<java.lang.String> getFields()

Specified by:

getFields in interface IForm

Specified by:

getFields in interface AForm

Specified by:

getFields in interface IFormView

Returns:

the returned set reflects the insertion order.

isEnabled

public boolean isEnabled()

Description copied from interface: IForm

If disabled then actions are also disabled.

Specified by:

isEnabled in interface IForm

Specified by:

isEnabled in interface AForm

Specified by:

isEnabled in interface IFormView

Returns:

true if the form is enabled

isReadOnly

public boolean isReadOnly()

Description copied from interface: IForm

In a read only form, actions are enabled but input fields are not.

Specified by:

isReadOnly in interface IForm

Specified by:

isReadOnly in interface AForm

Specified by:

isReadOnly in interface IFormView

Returns:

true if the form is readOnly.

isShadow

public boolean isShadow()

All fields in a shadow form act as shadow fields, see AFormField.setShadow(boolean).

Returns:

false as default.

isShadow

public boolean isShadow(java.lang.String fieldId)

Let the form control the single field shadow state.

Parameters:

fieldId - - the field id

Returns:

false by default.

validate

public boolean validate(java.lang.String fieldId,
               java.lang.String... otherFieldsToValidate)

The default implementation uses #validateImpl(String).
An isShadow() does not trigger any validation and returns always true.

Specified by:

validate in interface IForm

Specified by:

validate in interface AForm

Parameters:

fieldId - - the changed field or null to validate the whole form.

otherFieldsToValidate - - possible other fields that must be validated.
It makes sense only if a fieldId has been specified.

Returns:

true if the form is valid.

getMessage

public final IMessage getMessage()

Specified by:

getMessage in interface IMessageSet

Specified by:

getMessage in interface AForm

Returns:

The most important message.

getMessage

public final IMessage getMessage(java.lang.Enum<?> sc)

Specified by:

getMessage in interface IMessageSet

Specified by:

getMessage in interface AForm

getMessages

public final IMessage[] getMessages()

Specified by:

getMessages in interface IMessageSet

Specified by:

getMessages in interface AForm

getMessagesMap

public final java.util.Map<java.lang.Enum<?>,IMessage> getMessagesMap()

Specified by:

getMessagesMap in interface IMessageSet

Specified by:

getMessagesMap in interface AForm

Returns:

a read-only map reflecting the message priority, the last one is the one returned by IMessageSet.getMessage().
Neve returns null.

hasMessage

public final boolean hasMessage()

Specified by:

hasMessage in interface IMessageSet

Specified by:

hasMessage in interface AForm

hasMessage

public final boolean hasMessage(MessageTypeEnum type)

Specified by:

hasMessage in interface IMessageSet

Specified by:

hasMessage in interface AForm

Returns:

true if a message of MessageTypeEnum type or severe is found.

setMessage

public final void setMessage(java.lang.Enum<?> sc,
              IMessage message)

Specified by:

setMessage in interface IMessageSet

Specified by:

setMessage in interface AForm

Parameters:

sc - - the owner of the message.

message - - null to remove the message for the given IMessageToken.

clearMessages

public final void clearMessages()

Description copied from interface: IClearableMessageSet

Removes all messages with IMessage.getAutoRemoveIndicator() setted.

Specified by:

clearMessages in interface IClearableMessageSet

hasValidationMessages

public boolean hasValidationMessages(MessageTypeEnum type)

Parameters:

type -

Returns:

true if the form or one of its fields has a message of the given MessageTypeEnum type.

addValidator

public void addValidator(IFormValidator l)

addValidator

public void addValidator(IFormValidator l,
                boolean checkFieldNames)

Parameters:

l -

checkFieldNames - - If true fields required by the validator, see IFormValidator.getFieldNames(), are checked for existence.
Set it to false if fields are not yet created, see IFieldFactory.

removeValidator

public boolean removeValidator(IFormValidator l)

containsValidator

public boolean containsValidator(IFormValidator l)

removeAllValidators

public void removeAllValidators()

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object