fr.paris.lutece.plugins.formengine.web

Class SubForm

java.lang.Object

fr.paris.lutece.plugins.formengine.web.SubForm

Direct Known Subclasses:

CaptchaSubForm

public abstract class SubForm
extends Object

This classe defines the main characteristics and methods of a subform

See Also:

getXslFilesNames()

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_XSL_BASE_URL

Constructor Summary

Constructors

Constructor and Description
SubForm() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileItem(javax.servlet.http.HttpServletRequest request, String strFieldName, org.apache.commons.fileupload.FileItem fileItem) Associates a newly uploaded file to the subform.
void	addFileItem(String strIdSession, String strFieldName, org.apache.commons.fileupload.FileItem fileItem) For asynchronous usage
void	addFileItemToUploadedFiles(javax.servlet.http.HttpServletRequest request, fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field field, org.apache.commons.fileupload.FileItem fileItem, FormErrorsList formErrorsList) Adds file item to uploaded files and field.getFileNames( ).getFileName( )
protected void	addNotices(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements) Adds notices to the elements
void	appendToChoiceList(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field field, fr.paris.lutece.util.ReferenceList referenceList) Add the elements in given reference list to given field's choice list.
String	buildHtmlForm(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements, Map params) Build the html code corresponding to the given form elements.
void	clearFormElements(javax.servlet.http.HttpServletRequest request) Remove the current formelement object from the session, which has an effect to reinit the later.
String	display(javax.servlet.http.HttpServletRequest request) This method should display.
protected String	displayForm(javax.servlet.http.HttpServletRequest request) This method provides a default implementation for the form display It might be overriden if needed : to initialize some fields from db (eg. combos) to pass parameters to the stylesheet
String	displayForMail(javax.servlet.http.HttpServletRequest request, String strMailTemplate) This method should display.
protected String	displayHeader(javax.servlet.http.HttpServletRequest request)
protected abstract String	displaySummary(javax.servlet.http.HttpServletRequest request) Displays the summary part of the screen.
protected String	displaySummaryForMail(javax.servlet.http.HttpServletRequest request) Display the summary for the mail
abstract String	doAction(String strActionName, javax.servlet.http.HttpServletRequest request) Performs an action depending on the given action name and possibly on other parameters in request
String	doUploadAction(javax.servlet.http.HttpServletRequest request, String strUploadAction) Performs an upload action.
void	fillFields(javax.servlet.http.HttpServletRequest request) Fill the fields with the parameters in request.
protected String	getDefaultUrlToExit() Defines the url used to exit the form
fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field	getFieldFromName(javax.servlet.http.HttpServletRequest request, String strName) Get a field of a given name from a given fields element
List<org.apache.commons.fileupload.FileItem>	getFileItems(javax.servlet.http.HttpServletRequest request, String strFieldName) Returns the files associated with an upload field of the subform.
List<org.apache.commons.fileupload.FileItem>	getFileItems(String strIdSession, String strFieldName) For asynchronous usage.
protected String	getFormattedErrors(javax.servlet.http.HttpServletRequest request) Returns a default Html code to display filling errors
fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements	getFormElements(javax.servlet.http.HttpServletRequest request) Returns the fields element associated with that subform.
protected String	getHtml(String strXmlCode, String strXslFileName) Util to convert Xml docs into Html docs using XSLT stylesheets
protected String	getHtml(String strXmlCode, String strXslFileName, Map params) Util to convert Xml docs into Html docs using XSLT stylesheets.
protected fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements	getinitializedFormElements() Create a new fields object initialised with the _initialFields values and elements
boolean	getIsSubFormAllowed(javax.servlet.http.HttpServletRequest request) Get the variable in session that states wether the access to the current subform is allowed
String	getName() Get the name of the subform
SubForm	getNextSubForm() Accessor to the next subform.
Form	getParentForm() Accessor to the parent form.
String	getPortalURI() Get the protal URI of subForm
SubForm	getPreviousSubForm() Accessor to the previous subform.
Object	getSessionAttribute(javax.servlet.http.HttpServletRequest request, String strAttributeName) Get an attribute in session.
String	getTitle() Get the title of the subform
List<fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field>	getUploadFields(javax.servlet.http.HttpServletRequest request) Gets all upload fields for the request
String[]	getXslFilesNames() Gets all XSL used by this subform.
protected abstract String	getXslFormElementsFileName() This method should be overriden.
void	initFormElements(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements) Set the initialFormElements.
void	mergeAsynchronousUploadedFiles(javax.servlet.http.HttpServletRequest request, String strFieldName) Merges asynchronous uploaded files with already session bounded ones.
void	mergeAsynchronousUploadedFiles(javax.servlet.http.HttpServletRequest request, String strFieldName, FormErrorsList formErrorsList) Merges asynchronous uploaded files with already session bounded ones.
void	removeFileItem(javax.servlet.http.HttpServletRequest request, String strFieldName, int iIndex) Deletes a file previously associated with the subform.
void	removeSessionAttribute(javax.servlet.http.HttpServletRequest request, String strAttributeName) Remove an attribute in session.
boolean	removeUploadedFileItem(javax.servlet.http.HttpServletRequest request, String strFieldName, int nIndex) Removes an uploaded fileitem using its index.
protected void	setBlobStoreFileItemsURL(javax.servlet.http.HttpServletRequest request, String strFieldName, List<String> listFilesUrl, fr.paris.lutece.plugins.blobstore.service.IBlobStoreService IBlobStoreService) Sets the file items url (stored in blobstore) to the list (which is cleared).
void	setChoiceList(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field field, fr.paris.lutece.util.ReferenceList referenceList) Build the choice list of a field from the given reference list.
void	setFormElements(javax.servlet.http.HttpServletRequest request, fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements) Modify the formelements objectt in session
void	setIsSubFormAllowed(javax.servlet.http.HttpServletRequest request, boolean bIsAllowed) Add a variable in session to state wether the access to the current subform is allowed
void	setName(String strName) Set the name of the subform
void	setNextSubForm(SubForm subFormNext) setter for the next subform.
void	setParentForm(Form formParent) setter for the parent form.
void	setPortalURI(String strPortalURI) Set the protal URI of subForm
void	setPreviousSubForm(SubForm subFormPrevious) setter for the previous subform.
void	setSessionAttribute(javax.servlet.http.HttpServletRequest request, String strAttributeName, Object attribute) Set a session attribute, with a name formatted to avoid conflicts between form and subform instances.
void	setTitle(String strTitle) Set the title of the subform
protected boolean	validate(Object objectToValidate) Validates an given object.
boolean	validateFields(javax.servlet.http.HttpServletRequest request) Validate the data stored in the fields element against the checkrules specified.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_XSL_BASE_URL

public static final String PARAMETER_XSL_BASE_URL

See Also:

Constant Field Values

Constructor Detail

SubForm

public SubForm()

Constructor

Method Detail

getXslFormElementsFileName

protected abstract String getXslFormElementsFileName()

This method should be overriden. It defines the name of the file associated with this subform

Returns:

The absolute path for xsl stylesheets

doAction

public abstract String doAction(String strActionName,
              javax.servlet.http.HttpServletRequest request)

Performs an action depending on the given action name and possibly on other parameters in request

Parameters:

strActionName - the action to perform

request - the http request

Returns:

the name of the subform to display after the requested action is performed.

displaySummary

protected abstract String displaySummary(javax.servlet.http.HttpServletRequest request)

Displays the summary part of the screen.

Parameters:

request - the http request

Returns:

the html code corresponding to the summary

displayForm

protected String displayForm(javax.servlet.http.HttpServletRequest request)

This method provides a default implementation for the form display It might be overriden if needed :

• to initialize some fields from db (eg. combos)
• to pass parameters to the stylesheet

Parameters:

request - the http request

Returns:

the html code corresponding to the form part

displayHeader

protected String displayHeader(javax.servlet.http.HttpServletRequest request)

Parameters:

request - The HttpServletRequest

Returns:

The html code to display

display

public String display(javax.servlet.http.HttpServletRequest request)
               throws fr.paris.lutece.portal.service.security.UserNotSignedException

This method should display. This is the main method called to display a subform.

• the recap of what is already submitted
• the error list
• the form elements

Parameters:

request - the http request

Returns:

the html code to display

Throws:

fr.paris.lutece.portal.service.security.UserNotSignedException - if user is not signed on

displayForMail

public String displayForMail(javax.servlet.http.HttpServletRequest request,
                    String strMailTemplate)
                      throws fr.paris.lutece.portal.service.security.UserNotSignedException

This method should display. This is the main method called to display a subform.

• the recap of what is already submitted
• the error list
• the form elements

Parameters:

request - the http request

strMailTemplate - template for mail

Returns:

the html code to display

Throws:

fr.paris.lutece.portal.service.security.UserNotSignedException - if user is not signed on

displaySummaryForMail

protected String displaySummaryForMail(javax.servlet.http.HttpServletRequest request)

Display the summary for the mail

Parameters:

request - the HTTP request

Returns:

the summary for mail

getTitle

public String getTitle()

Get the title of the subform

Returns:

the subform title

setTitle

public void setTitle(String strTitle)

Set the title of the subform

Parameters:

strTitle - the title to set

getName

public String getName()

Get the name of the subform

Returns:

the subform name

setName

public void setName(String strName)

Set the name of the subform

Parameters:

strName - the name to set

getPortalURI

public String getPortalURI()

Get the protal URI of subForm

Returns:

the portal URI

setPortalURI

public void setPortalURI(String strPortalURI)

Set the protal URI of subForm

Parameters:

strPortalURI - the new portal URI

setParentForm

public void setParentForm(Form formParent)

setter for the parent form.

Parameters:

formParent - The parent Form

getParentForm

public Form getParentForm()

Accessor to the parent form.

Returns:

the parent form

setNextSubForm

public void setNextSubForm(SubForm subFormNext)

setter for the next subform.

Parameters:

subFormNext - tje next subform

getNextSubForm

public SubForm getNextSubForm()

Accessor to the next subform.

Returns:

the next subform

setPreviousSubForm

public void setPreviousSubForm(SubForm subFormPrevious)

setter for the previous subform.

Parameters:

subFormPrevious - the previous subform

getPreviousSubForm

public SubForm getPreviousSubForm()

Accessor to the previous subform.

Returns:

the previous subform

getHtml

protected String getHtml(String strXmlCode,
             String strXslFileName,
             Map params)

Util to convert Xml docs into Html docs using XSLT stylesheets. Will try to use existing database file BEFORE the given xsl file name. Physical file is kept for compatibility.

Parameters:

strXmlCode - The Xml

strXslFileName - The Xsl stylesheet filename. Note that the path is retrieved from the getXslDirectoryPath method of the parent form

params - a map of parameters to pass to the stylesheet

Returns:

The Html code

getHtml

protected String getHtml(String strXmlCode,
             String strXslFileName)

Util to convert Xml docs into Html docs using XSLT stylesheets

Parameters:

strXmlCode - The Xml

strXslFileName - The Xsl stylesheet filename. Note that the path is retrieved from the getXslDirectoryPath method of the parent form

Returns:

The Html code

getFormattedErrors

protected String getFormattedErrors(javax.servlet.http.HttpServletRequest request)

Returns a default Html code to display filling errors

Parameters:

request - The HTTP requesr

Returns:

Errors presented in HTML

validate

protected boolean validate(Object objectToValidate)

Validates an given object. Before to add an object to the session, it should be validated. This method check the given object against the associated schema.t

Parameters:

objectToValidate - the object on which validation should be performed

Returns:

true if validation has been successfull, false otherwise.

setIsSubFormAllowed

public void setIsSubFormAllowed(javax.servlet.http.HttpServletRequest request,
                       boolean bIsAllowed)

Add a variable in session to state wether the access to the current subform is allowed

Parameters:

request - the http request

bIsAllowed - true to allow access to the form, false otherwise

getIsSubFormAllowed

public boolean getIsSubFormAllowed(javax.servlet.http.HttpServletRequest request)

Get the variable in session that states wether the access to the current subform is allowed

Parameters:

request - the http request

Returns:

true if the subform access is allowed, false otherwise

fillFields

public void fillFields(javax.servlet.http.HttpServletRequest request)

Fill the fields with the parameters in request. This method should be called before performing any action, to update the fields with the new values passed in request.

Parameters:

request - the http request

mergeAsynchronousUploadedFiles

public void mergeAsynchronousUploadedFiles(javax.servlet.http.HttpServletRequest request,
                                  String strFieldName)

Merges asynchronous uploaded files with already session bounded ones.

Parameters:

request - the request

strFieldName - the upload field name

mergeAsynchronousUploadedFiles

public void mergeAsynchronousUploadedFiles(javax.servlet.http.HttpServletRequest request,
                                  String strFieldName,
                                  FormErrorsList formErrorsList)

Merges asynchronous uploaded files with already session bounded ones.

Parameters:

request - the request

strFieldName - the upload field name

formErrorsList - fills the formErrorsList if not null.

validateFields

public boolean validateFields(javax.servlet.http.HttpServletRequest request)

Validate the data stored in the fields element against the checkrules specified. This method should be called when submitting a form, in order to check the validity of the data submitted. If a field is not valid, a list of errors is returned.

Parameters:

request - the http request

Returns:

true if all the fields are valid. If false, errors are written to the parent form's array of errors.

getFormElements

public fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements getFormElements(javax.servlet.http.HttpServletRequest request)

Returns the fields element associated with that subform.
If the element is not found in session, a new one is created from the init element "_initialFields" and added to the session.
The formelements element in session is returned

Parameters:

request - the http request

Returns:

the formelements object in session

setFormElements

public void setFormElements(javax.servlet.http.HttpServletRequest request,
                   fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements)

Modify the formelements objectt in session

Parameters:

request - the http request

formElements - the element to add in session

clearFormElements

public void clearFormElements(javax.servlet.http.HttpServletRequest request)

Remove the current formelement object from the session, which has an effect to reinit the later.

Parameters:

request - the http request

initFormElements

public void initFormElements(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements)

Set the initialFormElements. This is called by the form registration service.

Parameters:

formElements - the elemnts of forms

getinitializedFormElements

protected fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements getinitializedFormElements()

Create a new fields object initialised with the _initialFields values and elements

Returns:

a copy of _initialFields

getFieldFromName

public fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field getFieldFromName(javax.servlet.http.HttpServletRequest request,
                                                                                     String strName)

Get a field of a given name from a given fields element

Parameters:

request - the HttpServletRequest

strName - the name of the field to find

Returns:

the field of name given in parameter. If nothing is found, return null. If one of the parameters is null, return null.

setChoiceList

public void setChoiceList(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field field,
                 fr.paris.lutece.util.ReferenceList referenceList)

Build the choice list of a field from the given reference list. This is useful when the content of a combo field has to be loaded from a database

Parameters:

field - the field whose choice list should be set

referenceList - the list containing the data to load into the choice list

appendToChoiceList

public void appendToChoiceList(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field field,
                      fr.paris.lutece.util.ReferenceList referenceList)

Add the elements in given reference list to given field's choice list.

Parameters:

field - the field whose choice list should be updated

referenceList - the list containing the data to load into the choice list

buildHtmlForm

public String buildHtmlForm(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements,
                   Map params)

Build the html code corresponding to the given form elements. If you want your form to support HTTPS, you will have to put secured "baseUrl" in params. Example : params.put( PARAMETER_XSL_BASE_URL, "https://www.my-host.com/my-webapp/ );

Parameters:

formElements - the fields and buttons to display

params - additional params that might need to be passed to the stylesheet

Returns:

the html code for the subform fields

See Also:

PARAMETER_XSL_BASE_URL

addNotices

protected void addNotices(fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.FormElements formElements)

Adds notices to the elements

Parameters:

formElements - the elements

getDefaultUrlToExit

protected String getDefaultUrlToExit()

Defines the url used to exit the form

Returns:

the url

getUploadFields

public final List<fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field> getUploadFields(javax.servlet.http.HttpServletRequest request)

Gets all upload fields for the request

Parameters:

request - the request

Returns:

upload fields list

setSessionAttribute

public void setSessionAttribute(javax.servlet.http.HttpServletRequest request,
                       String strAttributeName,
                       Object attribute)

Set a session attribute, with a name formatted to avoid conflicts between form and subform instances.

Parameters:

request - the http request

strAttributeName - the name of the variable to put in session

attribute - the object to put in session

getSessionAttribute

public Object getSessionAttribute(javax.servlet.http.HttpServletRequest request,
                         String strAttributeName)

Get an attribute in session. This method is to use to avoid conflicts between form and subform instances.

Parameters:

request - The Http Request

strAttributeName - the name of the variable to retrieve from session

Returns:

the corresponding object in session

removeSessionAttribute

public void removeSessionAttribute(javax.servlet.http.HttpServletRequest request,
                          String strAttributeName)

Remove an attribute in session. This method is to use to avoid conflicts between form and subform instances.

Parameters:

request - The HttpServlerRequest

strAttributeName - the name of the variable to remove from session

doUploadAction

public String doUploadAction(javax.servlet.http.HttpServletRequest request,
                    String strUploadAction)

Performs an upload action.

Parameters:

request - the HTTP request

strUploadAction - the name of the upload action

Returns:

the name of the subform to display after having performed the requested action

addFileItemToUploadedFiles

public final void addFileItemToUploadedFiles(javax.servlet.http.HttpServletRequest request,
                              fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.Field field,
                              org.apache.commons.fileupload.FileItem fileItem,
                              FormErrorsList formErrorsList)

Adds file item to uploaded files and field.getFileNames( ).getFileName( )

Parameters:

request - the request

field - the field

fileItem - the file item

formErrorsList - the list of error which is filled if not null. Usefull for asynchronous upload. Classic validation should set it to null since the error list is bound to the session.

addFileItem

public final void addFileItem(javax.servlet.http.HttpServletRequest request,
               String strFieldName,
               org.apache.commons.fileupload.FileItem fileItem)

Associates a newly uploaded file to the subform. This method is used by FormEngineApp and need not be overriden nor called from child classes.

Parameters:

request - the HTTP request

strFieldName - the name of the upload field

fileItem - the File object

addFileItem

public final void addFileItem(String strIdSession,
               String strFieldName,
               org.apache.commons.fileupload.FileItem fileItem)

For asynchronous usage

Parameters:

strIdSession - session id

strFieldName - field name

fileItem - fileitem

getFileItems

public final List<org.apache.commons.fileupload.FileItem> getFileItems(String strIdSession,
                                                        String strFieldName)

For asynchronous usage. Does not provide all uploaded file.

Parameters:

strIdSession - session id

strFieldName - field name

Returns:

the asynchronous uploaded files

removeUploadedFileItem

public final boolean removeUploadedFileItem(javax.servlet.http.HttpServletRequest request,
                             String strFieldName,
                             int nIndex)

Removes an uploaded fileitem using its index.

Parameters:

request - the request

strFieldName - the field name

nIndex - the index

Returns:

true if file is removed, false otherwise.

removeFileItem

public final void removeFileItem(javax.servlet.http.HttpServletRequest request,
                  String strFieldName,
                  int iIndex)

Deletes a file previously associated with the subform. This method is used by FormEngineApp and need not be overriden nor called from child classes.

Parameters:

request - the HTTP request

strFieldName - the name of the upload field

iIndex - the index of the file to remove

getFileItems

public final List<org.apache.commons.fileupload.FileItem> getFileItems(javax.servlet.http.HttpServletRequest request,
                                                        String strFieldName)

Returns the files associated with an upload field of the subform. This method can be used by output processors to access the uploaded files' data.

Parameters:

request - the HTTP request

strFieldName - the name of the upload field

Returns:

a java.util.List containing UploadedFiles objects. Returns null if no file was uploaded for this field.

setBlobStoreFileItemsURL

protected void setBlobStoreFileItemsURL(javax.servlet.http.HttpServletRequest request,
                            String strFieldName,
                            List<String> listFilesUrl,
                            fr.paris.lutece.plugins.blobstore.service.IBlobStoreService IBlobStoreService)

Sets the file items url (stored in blobstore) to the list (which is cleared). If the file items are already BlobStored, they are not reuploaded to keep file from the draft (if supported).

Parameters:

request - the request

strFieldName - the field name

listFilesUrl - the list of url

IBlobStoreService - the blobstore service where to store/restore files

getXslFilesNames

public String[] getXslFilesNames()

Gets all XSL used by this subform.
This method actually return an array with one value : getXslFormElementsFileName(). It should be overriden if all XSL is managed by this subform.

Returns:

XSL infos