Package name.matthewgreet.strutscommons.annotation

Annotation Type Form

@Documented
@Inherited
@Target(FIELD)
@Retention(RUNTIME)
public @interface Form

Defines a member variable of a Viewer Action as receiving an injected form processed by a Form Processing Action, whether successfully or not. The member variable is only set if the form's type is compatible with its type.

If any processors are set, the class of the Struts action that processed the form (successfully or not) must match or be a subclass one of the values. This is useful if multiple displayed forms happen to be the same type.

By default, the member variable is only set if the form's processor rejected the form. How reception values affect form data reception:

Form Reception

NEVER	Never receives form. This option only exists for completeness.
ERROR	Receives form if it was rejected. Default.
SUCCESS	Receives form if it was rejected. This option only exists for completeness.
ALWAYS	Always receives form.

Other parameters

Other Parameters

disableFormatting

If true, disables setting of form fields from their unformatted values (unless StrutsMiscellaneousLibrary#formatForm is explicitly called).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Form.Reception	Form validation success/fail states accepted by receiving Action.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	disableFormatting
Class<?>[]	processors
Form.Reception	reception

Element Details

disableFormatting

boolean disableFormatting

Default:

false

processors

Class<?>[] processors

Default:

{}

reception

Form.Reception reception

Default:

ERROR