Package net.sf.jguiraffe.gui.forms

A package for dealing with forms.

In typical GUI applications forms are used for gathering data from the user. Creating a form is usually a tedious task. In addition to the presentation of the data the developer has to deal with more or less complex logic, including

• initializing the form's input fields from the model,
• handling the OK and the Cancel button correctly,
• performing validation of user input,
• optionally mark input fields that contain no valid data,
• transfer the data entered by the user back into the application's model.

This package provides fundamental classes and interfaces for addressing such common problems. Its main goal is making the handling of forms as easy as possible.

The main class of this package is the Form class. A Form object is a representation of a GUI form including all its input fields. Using methods provided by this class, it is possible to copy data between the input fields and the data model in both directions. Support for validation on both the field level and the form level (which allows for semantical checks involving the form as a whole) is available, too.

$Id: package.html 205 2012-01-29 18:29:57Z oheger $

Interface Summary

Interface	Description
BindingStrategy	Definition of an interface for objects that are responsible of the binding of form fields to model objects.
ComponentHandler<T>	Definition of an interface for accessing GUI components independently from their type.
ComponentStore	Definition of an interface for objects that are able to manage entities related to a Form object.
FieldHandler	Definition of an interface for accessing fields of a form.
FormValidator	Definition of an interface for objects that can validate forms.
FormValidatorResults	Definition of an interface for describing results of a form validation.
TransformerWrapper	Definition of an interface for objects that wrap a transformer.
ValidatorWrapper	Definition of an interface for objects that wrap a Validator.

Class Summary

Class	Description
ComponentHandlerImpl	A simple default implementation of the ComponentHandler interface.
ComponentStoreImpl	A fully functional default implementation of the ComponentStore interface.
DefaultFieldHandler	A default implementation of the FieldHandler interface.
DefaultFormValidatorResults	Default implementation of the FormValidatorResults interface.
DefaultTransformerWrapper	A default implementation of the TransformerWrapper interface.
DefaultValidatorWrapper	A default implementation of the ValidatorWrapper interface.
Form	This class represents a form.
FormValidationMessageFormat	A class for converting a FormValidatorResults object to text.

Enum Summary

Enum	Description
DummyWrapper	A dummy implementation of the TransformerWrapper and the ValidatorWrapper interfaces.
ValidationPhase	An enumeration class that describes the different validation phases.

Exception Summary

Exception	Description
FormRuntimeException	An exception class for reporting runtime exceptions related to the form framework.