org.springframework.richclient.form
Class GeneratedForm

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.factory.AbstractControlFactory
          org.springframework.richclient.form.AbstractForm
              org.springframework.richclient.form.GeneratedForm

All Implemented Interfaces:

InitializingBean, CommitListener, ControlFactory, Form

public class GeneratedForm
extends AbstractForm
implements InitializingBean

Convenience class for producing a Spring Rich Form based on a pre-generated form UI (typically, a form that has been created in a form designer such as Matisse or JFormDesigner). This implementation handles the most common case where a developer designs a form and wants to display it without any custom functionality beyond what Spring Rich already provides.

In order to better facilitate the common usage scenarios and to avoid developers having to subclass GeneratedForm, many convenience constructors are provided, along with making the setFormModel(ValidatingFormModel) and setId(String) methods public.

Author:

Andy DePue, Peter De Bruycker

Field Summary

Fields inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

logger

Constructor Summary

GeneratedForm()

GeneratedForm(FormModel pageFormModel)

GeneratedForm(FormModel pageFormModel, FormUIProvider formUIProvider)

GeneratedForm(FormModel formModel, String formId)

GeneratedForm(FormModel formModel, String formId, FormUIProvider formUIProvider)

GeneratedForm(FormUIProvider formUIProvider)

GeneratedForm(HierarchicalFormModel parentFormModel, String formId, String childFormObjectPropertyPath)

GeneratedForm(HierarchicalFormModel parentFormModel, String formId, String childFormObjectPropertyPath, FormUIProvider formUIProvider)

GeneratedForm(HierarchicalFormModel parentFormModel, String formId, ValueModel childFormObjectHolder)

GeneratedForm(HierarchicalFormModel parentFormModel, String formId, ValueModel childFormObjectHolder, FormUIProvider formUIProvider)

GeneratedForm(Object formObject)

GeneratedForm(Object formObject, FormUIProvider formUIProvider)

GeneratedForm(Object formObject, String formId, FormUIProvider formUIProvider)

GeneratedForm(String formId)

GeneratedForm(String formId, FormUIProvider formUIProvider)

Method Summary

void	afterPropertiesSet()
protected JComponent	createFormControl()
FormUIProvider	getFormUIProvider()
void	setFormModel(ValidatingFormModel formModel) Provides public access to this method as a convenience.
void	setFormUIProvider(FormUIProvider formUIProvider)
void	setId(String formId) Provides public access to this method as a convenience.

Methods inherited from class org.springframework.richclient.form.AbstractForm

addChildForm, addFormObjectChangeListener, addFormValueChangeListener, addGuarded, addGuarded, addValidationListener, addValidationResultsReporter, attachFormErrorGuard, attachFormGuard, commit, constructSecurityControllerId, createCommitButton, createControl, createNewFormObjectButton, createNewObject, detachFormGuard, getBindingFactory, getChildForm, getCommitCommand, getCommitCommandFaceDescriptorId, getCommitSecurityControllerId, getDefaultButton, getEditableFormObject, getEditingFormObjectIndex, getFormModel, getFormObject, getId, getNewFormObjectCommand, getNewFormObjectCommandId, getNewFormObjectSecurityControllerId, getParent, getRevertCommand, getRevertCommandFaceDescriptorId, getValidationResultsReporters, getValue, getValueModel, handleEnabledChange, hasErrors, init, isDirty, isEditingNewFormObject, isEnabled, newSingleLineResultsReporter, postCommit, preCommit, removeChildForm, removeFormObjectChangeListener, removeFormValueChangeListener, removeGuarded, removeValidationListener, removeValidationResultsReporter, reset, revert, setClearFormOnCommit, setDefaultButton, setEditableFormObjects, setEditingFormObjectIndexHolder, setEditingFormObjectIndexSilently, setEditingNewFormObject, setEnabled, setFormModelDefaultEnabledState, setFormObject

Methods inherited from class org.springframework.richclient.factory.AbstractControlFactory

createControlIfNecessary, getControl, isControlCreated, isSingleton, setSingleton

Methods inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

getActiveWindow, getApplication, getApplicationContext, getApplicationName, getApplicationServices, getCommandConfigurer, getComponentFactory, getConversionService, getIconSource, getImageSource, getMessage, getMessage, getMessage, getMessage, getMessages, getMessageSource, getObjectConfigurer, getService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.richclient.factory.ControlFactory

getControl

Constructor Detail

GeneratedForm

public GeneratedForm()

GeneratedForm

public GeneratedForm(String formId)

GeneratedForm

public GeneratedForm(Object formObject)

GeneratedForm

public GeneratedForm(FormModel pageFormModel)

GeneratedForm

public GeneratedForm(FormModel formModel,
                     String formId)

GeneratedForm

public GeneratedForm(HierarchicalFormModel parentFormModel,
                     String formId,
                     String childFormObjectPropertyPath)

GeneratedForm

public GeneratedForm(HierarchicalFormModel parentFormModel,
                     String formId,
                     ValueModel childFormObjectHolder)

GeneratedForm

public GeneratedForm(FormUIProvider formUIProvider)

GeneratedForm

public GeneratedForm(String formId,
                     FormUIProvider formUIProvider)

GeneratedForm

public GeneratedForm(Object formObject,
                     FormUIProvider formUIProvider)

GeneratedForm

public GeneratedForm(Object formObject,
                     String formId,
                     FormUIProvider formUIProvider)

GeneratedForm

public GeneratedForm(FormModel pageFormModel,
                     FormUIProvider formUIProvider)

GeneratedForm

public GeneratedForm(FormModel formModel,
                     String formId,
                     FormUIProvider formUIProvider)

GeneratedForm

public GeneratedForm(HierarchicalFormModel parentFormModel,
                     String formId,
                     String childFormObjectPropertyPath,
                     FormUIProvider formUIProvider)

GeneratedForm

public GeneratedForm(HierarchicalFormModel parentFormModel,
                     String formId,
                     ValueModel childFormObjectHolder,
                     FormUIProvider formUIProvider)

Method Detail

createFormControl

protected JComponent createFormControl()

Specified by:

createFormControl in class AbstractForm

setFormModel

public void setFormModel(ValidatingFormModel formModel)

Provides public access to this method as a convenience.

Overrides:

setFormModel in class AbstractForm

Parameters:

formModel -

setId

public void setId(String formId)

Provides public access to this method as a convenience.

Overrides:

setId in class AbstractForm

Parameters:

formId -

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

getFormUIProvider

public FormUIProvider getFormUIProvider()

setFormUIProvider

public void setFormUIProvider(FormUIProvider formUIProvider)