| org.jaffa.presentation.portlet.FormBase
All known Subclasses: org.jaffa.presentation.portlet.widgets.tests.CheckBoxForm, org.jaffa.presentation.portlet.widgets.tests.DropDownForm, org.jaffa.presentation.portlet.widgets.tests.LookupClientForm, org.jaffa.presentation.portlet.widgets.tests.EditBoxForm, org.jaffa.presentation.portlet.widgets.tests.TextForm, org.jaffa.presentation.portlet.widgets.tests.GridForm, org.jaffa.components.finder.FinderCriteriaForm, org.jaffa.presentation.portlet.widgets.tests.FoldingSectionForm, org.jaffa.applications.test.modules.material.components.itemfinder.ui.ItemFinderResultsForm, org.jaffa.components.maint.MaintForm, org.jaffa.presentation.portlet.session.ui.ComponentDetailsForm, org.jaffa.presentation.portlet.widgets.tests.UserGridForm, org.jaffa.components.finder.FinderForm, org.jaffa.presentation.portlet.widgets.tests.RadioButtonForm, org.jaffa.presentation.portlet.widgets.tests.LabelForm, org.jaffa.presentation.portlet.widgets.tests.TreeForm, org.jaffa.presentation.portlet.session.ui.ComponentExplorerForm, org.jaffa.presentation.portlet.session.ui.SessionExplorerForm, org.jaffa.presentation.portlet.widgets.tests.ImageForm, org.jaffa.presentation.portlet.widgets.tests.LookupForm, org.jaffa.applications.test.modules.security.components.test1.ui.Page1Form, org.jaffa.presentation.portlet.widgets.tests.ButtonForm, org.jaffa.presentation.portlet.widgets.tests.DateTimeForm, org.jaffa.presentation.portlet.widgets.tests.TableForm,
| FormBase | | public class FormBase extends ActionForm (Code) | | This is the base class for all the 'Form' classes
|
| Method Summary | |
| public void | cleanup()
| | public void | clearErrors(HttpServletRequest request)
| | public Component | getComponent()
| | public ActionErrors | getErrors(HttpServletRequest request)
| | public WidgetCache | getWidgetCache()
| | public boolean | hasErrors(HttpServletRequest request)
| | public void | initForm()
| | public void | raiseError(HttpServletRequest request, String property, ActionError error)
| | public void | raiseError(HttpServletRequest request, String property, String key)
Record an error. | | public void | raiseError(HttpServletRequest request, String property, String key, Object value0)
Record an error. | | public void | raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1)
Record an error. | | public void | raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1, Object value2)
Record an error. | | public void | raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1, Object value2, Object value3)
Record an error. | | public void | raiseError(HttpServletRequest request, String property, String key, Object[] values)
Record an error. | | public void | raiseError(HttpServletRequest request, String property, ApplicationException appExp)
Record an error. | | public void | raiseError(HttpServletRequest request, String property, ApplicationExceptions appExps)
Record an error. | | public void | reset(ActionMapping mapping, HttpServletRequest request)
| | public void | setComponent(Component component)
|
| cleanup | | public void cleanup()(Code) | | The form should override this method for destroying any references that it holds
|
| clearErrors | | public void clearErrors(HttpServletRequest request)(Code) | | This clears all the errors generated while processing this Form
Parameters:
request - The servlet request we are processing |
| getComponent | | public Component getComponent()(Code) | | Returns the Component to which this Form belongs
The Component for this Form |
| getErrors | | public ActionErrors getErrors(HttpServletRequest request)(Code) | | Returns the errors generated while processing this Form
Parameters:
request - The servlet request we are processing If no errors are found, return null or an ActionErrors object with recorded error messages |
| getWidgetCache | | public WidgetCache getWidgetCache()(Code) | | Returns the WidgetCache of all the models for the Component
The WidgetCache object |
| hasErrors | | public boolean hasErrors(HttpServletRequest request)(Code) | | Checks if any errors have been generated
Parameters:
request - The servlet request we are processing true if errors exist |
| initForm | | public void initForm()(Code) | | The form should override this method for defaulting the data in the form-bean
|
| raiseError | | public void raiseError(HttpServletRequest request, String property, ActionError error)(Code) | | Record an error
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
error - The error message to be added |
| raiseError | | public void raiseError(HttpServletRequest request, String property, String key)(Code) | | Record an error. This implicitly creates an ActionError for the input key
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
key - Message key for this error message |
| raiseError | | public void raiseError(HttpServletRequest request, String property, String key, Object value0)(Code) | | Record an error. This implicitly creates an ActionError for the input key & replacement values
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
key - Message key for this error message
Parameters:
value0 - First replacement value |
| raiseError | | public void raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1)(Code) | | Record an error. This implicitly creates an ActionError for the input key & replacement values
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
key - Message key for this error message
Parameters:
value0 - First replacement value
Parameters:
value1 - Second replacement value |
| raiseError | | public void raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1, Object value2)(Code) | | Record an error. This implicitly creates an ActionError for the input key & replacement values
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
key - Message key for this error message
Parameters:
value0 - First replacement value
Parameters:
value1 - Second replacement value
Parameters:
value2 - Third replacement value |
| raiseError | | public void raiseError(HttpServletRequest request, String property, String key, Object value0, Object value1, Object value2, Object value3)(Code) | | Record an error. This implicitly creates an ActionError for the input key & replacement values
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
key - Message key for this error message
Parameters:
value0 - First replacement value
Parameters:
value1 - Second replacement value
Parameters:
value2 - Third replacement value
Parameters:
value3 - Fourth replacement value |
| raiseError | | public void raiseError(HttpServletRequest request, String property, String key, Object[] values)(Code) | | Record an error. This implicitly creates an ActionError for the input key & replacement values
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
key - Message key for this error message
Parameters:
values - Array of replacement values |
| raiseError | | public void raiseError(HttpServletRequest request, String property, ApplicationException appExp)(Code) | | Record an error. This implicitly creates an ActionError for the input key & replacement values.
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
appExp - the exception against which the error is being raised. This exception will have the errorToken and arguments, if any. |
| raiseError | | public void raiseError(HttpServletRequest request, String property, ApplicationExceptions appExps)(Code) | | Record an error. This implicitly creates an ActionError for the input key & replacement values.
Parameters:
request - The servlet request we are processing
Parameters:
property - Property name (or ActionErrors.GLOBAL_ERROR)
Parameters:
appExps - Error will raised against each ApplicationException passed in this parameter. |
| reset | | public void reset(ActionMapping mapping, HttpServletRequest request)(Code) | | This sets the Component & the WidgetCache fields
Parameters:
mapping - The mapping used to select this instance
Parameters:
request - The servlet request we are processing |
| setComponent | | public void setComponent(Component component)(Code) | | Sets the Component for the Form
Parameters:
component - The Component object |
|
|