org.springframework.richclient.form
Class FormModelHelper

java.lang.Object
  org.springframework.richclient.form.FormModelHelper

public class FormModelHelper
extends Object

This provides a collection of useful functions for working with FormModels.

Author:

Keith Donald, Jim Moore

Constructor Summary

FormModelHelper()

Method Summary

static FormModel	createChildPageFormModel(HierarchicalFormModel parentModel)
static ValidatingFormModel	createChildPageFormModel(HierarchicalFormModel parentModel, String childPageName)
static ValidatingFormModel	createChildPageFormModel(HierarchicalFormModel parentModel, String childPageName, String childFormObjectPropertyPath) Create a child form model nested by this form model identified by the provided name.
static ValidatingFormModel	createChildPageFormModel(HierarchicalFormModel parentModel, String childPageName, ValueModel childFormObjectHolder)
static HierarchicalFormModel	createCompoundFormModel(Object formObject)
static ValidatingFormModel	createCompoundFormModel(Object formObject, String formId)
static ValidatingFormModel	createCompoundFormModel(ValueModel formObjectHolder, String formId)
static ValidatingFormModel	createFormModel(Object formObject)
static ValidatingFormModel	createFormModel(Object formObject, boolean bufferChanges)
static ValidatingFormModel	createFormModel(Object formObject, boolean bufferChanges, RulesSource rulesSource, String formId)
static ValidatingFormModel	createFormModel(Object formObject, boolean bufferChanges, String formId)
static ValidatingFormModel	createFormModel(Object formObject, String formId)
static ValidatingFormModel	createFormModel(ValueModel formObjectHolder)
static ValidatingFormModel	createFormModel(ValueModel formObjectHolder, boolean bufferChanges, String formId)
static ValidatingFormModel	createFormModel(ValueModel formObjectHolder, String formId)
static ValidationResultsReporter	createSingleLineResultsReporter(ValidatingFormModel formModel, Messagable messageReceiver)
static ValidatingFormModel	createUnbufferedFormModel(Object formObject)
static ValidatingFormModel	createUnbufferedFormModel(Object formObject, String formId)
static ValidatingFormModel	createUnbufferedFormModel(ValueModel formObjectHolder, String formId)
static FormModel	getChild(HierarchicalFormModel formModel, String childPageName) Returns the child of the formModel with the given page name.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormModelHelper

public FormModelHelper()

Method Detail

createFormModel

public static ValidatingFormModel createFormModel(Object formObject,
                                                  String formId)

createUnbufferedFormModel

public static ValidatingFormModel createUnbufferedFormModel(Object formObject,
                                                            String formId)

createFormModel

public static ValidatingFormModel createFormModel(Object formObject,
                                                  boolean bufferChanges,
                                                  String formId)

createFormModel

public static ValidatingFormModel createFormModel(Object formObject,
                                                  boolean bufferChanges,
                                                  RulesSource rulesSource,
                                                  String formId)

createCompoundFormModel

public static ValidatingFormModel createCompoundFormModel(Object formObject,
                                                          String formId)

createFormModel

public static ValidatingFormModel createFormModel(ValueModel formObjectHolder)

createFormModel

public static ValidatingFormModel createFormModel(ValueModel formObjectHolder,
                                                  String formId)

createUnbufferedFormModel

public static ValidatingFormModel createUnbufferedFormModel(ValueModel formObjectHolder,
                                                            String formId)

createFormModel

public static ValidatingFormModel createFormModel(ValueModel formObjectHolder,
                                                  boolean bufferChanges,
                                                  String formId)

createCompoundFormModel

public static ValidatingFormModel createCompoundFormModel(ValueModel formObjectHolder,
                                                          String formId)

createFormModel

public static ValidatingFormModel createFormModel(Object formObject)

createUnbufferedFormModel

public static ValidatingFormModel createUnbufferedFormModel(Object formObject)

createFormModel

public static ValidatingFormModel createFormModel(Object formObject,
                                                  boolean bufferChanges)

createCompoundFormModel

public static HierarchicalFormModel createCompoundFormModel(Object formObject)

createChildPageFormModel

public static FormModel createChildPageFormModel(HierarchicalFormModel parentModel)

createChildPageFormModel

public static ValidatingFormModel createChildPageFormModel(HierarchicalFormModel parentModel,
                                                           String childPageName)

createChildPageFormModel

public static ValidatingFormModel createChildPageFormModel(HierarchicalFormModel parentModel,
                                                           String childPageName,
                                                           String childFormObjectPropertyPath)

Create a child form model nested by this form model identified by the provided name. The form object associated with the created child model is the value model at the specified parent property path.

Parameters:

parentModel - the model to create the FormModelHelper in

childPageName - the name to associate the created FormModelHelper with in the groupingModel

childFormObjectPropertyPath - the path into the groupingModel that the FormModelHelper is for

Returns:

The child form model

createChildPageFormModel

public static ValidatingFormModel createChildPageFormModel(HierarchicalFormModel parentModel,
                                                           String childPageName,
                                                           ValueModel childFormObjectHolder)

createSingleLineResultsReporter

public static ValidationResultsReporter createSingleLineResultsReporter(ValidatingFormModel formModel,
                                                                        Messagable messageReceiver)

getChild

public static FormModel getChild(HierarchicalFormModel formModel,
                                 String childPageName)

Returns the child of the formModel with the given page name.

Parameters:

formModel - the parent model to get the child from

childPageName - the name of the child to retrieve

Returns:

null the child can not be found

Throws:

IllegalArgumentException - if childPageName or formModel are null