com.jalios.jcms.handler

Class JcmsFormHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

Direct Known Subclasses:

AbstractCaddyManagerHandler, AbstractQueryHandler, AdminHandler, AdminSearchEnginesHandler, AssociatedPDFUploadHandler, AuthKeyGeneratorHandler, CacheManagerHandler, CheckRightsHandler, DeployManagerDownloadHandler, DeployManagerUpgradeHandler, DeployManagerUpgradeUploadHandler, DisplayPluginHandler, EditDataFormHandler, EditDataHandler, EditImageHandler, EditPluginHandler, ExportRawStatDataHandler, FileProcessorAdminHandler, FriendlyURLsHandler, ImportCatListHandler, ImportConflictHandler, ImportManagerHandler, JSyncManagerHandler, LegacyWitnessFileImportHandler, MailEditHandler, MailPasswordHandler, MemberListHandler, MergeCategoryHandler, PortletWorkflowHandler, ProfilerHandler, PropertiesHandler, PubBrowserHandler, RecommendationHandler, ReportHandler, ResetPasswordHandler, SendAlertHandler, StoreCleanerHandler, SwitchAccessibilityContextHandler, SyncLdapHandler, TypeEditorHandler, TypeListEditorHandler, UpgradeManagerHandler, WFEditorHandler, WorkReportHandler, WorkspaceWizardHandler, ZipFilesHandler

public abstract class JcmsFormHandler
extends JcmsJspContext
implements JcmsConstants

This abstract class is the super class of all the Form Handler classes (i.e. JavaBean classes used in JSP pages for processing form).

To implement a custom form handler :

• Add setters to trigger custom operations,
• Add setters for receive optionnal parameters,
• Implement processAction() to check for any operation, validate precondition and perform action,
• Create a JSP :
  • with the handler as a JavaBean
  • for which you'll invoke the validate() method

The following example demonstrate uses of a form handler to receive a firstname as an input and when validated display a Hello World message to the user

Java file com.example.jcmsplugin.hello.HelloWorldHandler.java:

 package com.example.jcmsplugin.hello;
 
 import java.io.IOException;
 
 import com.jalios.jcms.HttpUtil;
 import com.jalios.jcms.context.JcmsMessage;
 import com.jalios.jcms.context.JcmsMessage.Level;
 import com.jalios.jcms.handler.JcmsFormHandler;
 import com.jalios.util.Util;
 
 public class HelloWorldHandler extends JcmsFormHandler {
 
   // Possible operations
   private boolean opSayHello = false;
   private boolean opCancel = false;
 
   // Member variables
   private String firstname = null; 
 
   @Override
   public boolean processAction() throws IOException {
     
     if (validateSayHello()) {
       return performSayHello();
     }
 
     if (validateCancel()) {
       return performCancel();
     }
 
     return false;
   }
 
   // ---------------------------------------------------------------
   // Say Hello
   // ---------------------------------------------------------------
 
   public boolean validateSayHello() {
     if (!opSayHello) {
       return false;
     }
     if (Util.isEmpty(this.firstname)) {
       addMsg(new JcmsMessage(Level.WARN, glp("jcmsplugin.myplugin.myhandler.missing-firsname")));
       return false;
     }
     return true;
   }
 
   public boolean performSayHello() throws IOException {
     // In I18N properties : 
     //   jcmsplugin.myplugin.myhandler.say-hello: Hello {0} !
     //
     addMsgSession(request, new JcmsMessage(Level.INFO,  glp("jcmsplugin.myplugin.myhandler.say-hello", HttpUtil.encodeForHTML(firstname))));
     return false;
   }
 
   // ---------------------------------------------------------------
   // Cancel
   // ---------------------------------------------------------------
 
   public boolean validateCancel() {
     return opCancel;
   }
 
   public boolean performCancel() throws IOException {
     sendRedirect(Util.notEmpty(redirect) ? redirect : "index.jsp");
     return true;
   }
 
   // ---------------------------------------------------------------
   // Setters
   // ---------------------------------------------------------------
 
   public void setOpSayHello(String opSayHello) {
     this.opSayHello = true;
   }
 
   public void setOpCancel(String opCancel) {
     this.opCancel = true;
   }
 
 
   public String getFirstname() {
     return this.firstname;
   }
   public void setFirstname(String firstname) {
     this.firstname = firstname;
   }
 }
 

JSP sayHello.jsp:

 <%@ include file='/jcore/doInitPage.jspf' %><%
 %><jsp:useBean id="formHandler" scope="page" class="com.example.jcmsplugin.hello.HelloWorldHandler"><%
  %><jsp:setProperty name="formHandler" property="request" value="<%= request %>" /><%
  %><jsp:setProperty name="formHandler" property="response" value="<%= response %>" /><%
  %><jsp:setProperty name="formHandler" property="*" /><%
 %></jsp:useBean><%
 
   if (formHandler.validate()) {
     return;
   }
 
 
 %><%@ include file='/jcore/doEmptyHeader.jspf' %><%
 %><%@ include file='/jcore/doMessageBox.jspf' %>
 
 <div id='hello'>
  <form action="sayHello.jsp" name="sayHelloForm" method="post">
   <%-- Inputs --%>
   <jalios:field name="firstname" formHandler="<%= formHandler %>">
     <jalios:control />
   </jalios:field>
   <%-- Hidden Inputs --%>
   <% if (Util.notEmpty(formHandler.getRedirect())) { %>
   <input type="hidden" name="redirect" value="<%= encodeForHTMLAttribute(formHandler.getRedirect()) %>" />
   <% } %>
   <%-- Buttons --%>
   <%= WidgetUtil.printHtmlButton("opSayHello", glp("jcmsplugin.btn.sayhello"), true, null, true) %>
   <%= WidgetUtil.printHtmlButton("opCancel", glp("ui.com.btn.cancel"), true, null, false) %>
  </form>
 </div>
 

Data Handlers (handlers inheriting from EditDataHandler) must perform additionnal operation, see corresponding JavaDoc.

Version:

$Revision: 88465 $

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.Object>	contextMap
protected java.util.HashSet	editFieldSet
protected int	formStep
protected boolean	noRedirect
protected boolean	noSendRedirect
protected boolean	popupEdition
protected java.lang.String	redirect
protected boolean	redirectOnClosePopup
static java.lang.String	REVISION
protected boolean	workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
JcmsFormHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	afterValidation(boolean result)
protected boolean	checkMissingField(java.lang.Object obj, java.lang.String prop)
java.lang.String	getAvailableMainLanguage()
protected java.lang.String	getClosePopupUrl()
protected java.util.HashMap<java.lang.String,java.lang.Object>	getControllerContext() Build a controller context.
java.util.HashSet	getEditFieldSet()
int	getFormStep() Retrieve the current step of edition when invoking this form handler.
int	getFormStepCount() Retrieve the total number of steps used for edition when invoking this form handler.
java.lang.String	getFormStepFinishLabel()
java.lang.String	getFormStepHiddenFields()
java.lang.String[]	getFormStepLabels(java.lang.String userLang) Returns the label array for the steps.
java.lang.String	getFormStepPrefixProp()
java.lang.String	getHiddenField(java.lang.String name, boolean value)
java.lang.String	getHiddenField(java.lang.String name, boolean[] array)
java.lang.String	getHiddenField(java.lang.String name, Data value)
java.lang.String	getHiddenField(java.lang.String name, Data[] datas)
java.lang.String	getHiddenField(java.lang.String name, java.util.Date value)
java.lang.String	getHiddenField(java.lang.String name, java.util.Date[] array)
java.lang.String	getHiddenField(java.lang.String name, double value)
java.lang.String	getHiddenField(java.lang.String name, double[] array)
java.lang.String	getHiddenField(java.lang.String name, int value)
java.lang.String	getHiddenField(java.lang.String name, int[] array)
java.lang.String	getHiddenField(java.lang.String name, long value)
java.lang.String	getHiddenField(java.lang.String name, long[] array)
<T extends Data> java.lang.String	getHiddenField(java.lang.String name, java.util.Set<T> set)
java.lang.String	getHiddenField(java.lang.String name, java.lang.String value)
java.lang.String	getHiddenField(java.lang.String name, java.lang.String[] array)
java.lang.String	getHiddenFieldML(java.lang.String name, java.util.HashMap<java.lang.String,java.lang.String> map)
protected java.lang.String	getMainLangValue(java.lang.String[] array, boolean trim, boolean escape) Returns the first value (i.e.
protected java.lang.String[]	getMainLangValueArray(java.lang.String[] array, boolean trim, boolean escape) Returns the first values (i.e.
protected java.util.HashMap<java.lang.String,java.lang.String>	getMLMap(java.lang.String[] array, boolean trim, boolean escape) Returns the ML map (i.e.
protected java.util.HashMap<java.lang.String,java.lang.String[]>	getMLMapArray(java.lang.String[] array, boolean trim, boolean escape) Returns the ML map (i.e.
java.lang.String	getRedirect() Get the value of redirect.
boolean	getRedirectOnClosePopup() Return the value indicating whether the redirect value should be applied to the opener when closing the popup edition.
Workspace	getWorkspace() Retrieve the current Workspace variable for this context either from request if inFO or from session if in back office.
protected void	init() Method to implement if you need to initialize your handler from parameter received, prior to all security validation.
boolean	isFieldEdition(java.lang.String field)
protected boolean	isFieldMissing(java.lang.String field) Check if the given parameter is present in the query parameters
boolean	isPartialFieldEdition() Returns true if this is a partial field edition (i.e.
boolean	isPopupEdition()
boolean	isWorkspaceForced()
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
protected boolean	processStatus(ControllerStatus status) Process the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.
void	sendRedirect(java.lang.String url) Redirect current request to given URL. Overrides JcmsContext.sendRedirect(String) to use behavior provided by sendRedirect(String, boolean).
void	sendRedirect(java.lang.String url, boolean checkRedirect) Set the redirect in the response.
void	setEditField(java.lang.String[] v)
void	setFormStep(int step) Set the current step of edition when invoking this form handler.
void	setNoRedirect(boolean noRedirect) Set the value of noRedirect.
void	setNoSendRedirect(boolean noSendRedirect) Set the value of noSendRedirect.
void	setPopupEdition(boolean v) Set where this form handler is being invoked in a popup.
void	setRedirect(java.lang.String url) Set the value of redirect.
void	setRedirectOnClosePopup(boolean redirectOnClosePopup) Set whether the redirect value should be applied to the opener when closing the popup edition. The value set by this method will be used only when using popup edition (setPopupEdition(boolean)).
void	setWorkspace(Workspace wspc)
void	setWs(java.lang.String v)
boolean	showCancelButton() Check if the "Cancel" button should be displayed in step modal form.
boolean	showFinishButton() Check if the "Finish" button should be displayed in step modal form.
boolean	showNextButton() Check if the "Next" button should be displayed in step modal form.
boolean	showPreviousButton() Check if the "Previous" button should be displayed in step modal form.
protected java.lang.String	updateUploadedField(java.lang.String fieldName, java.lang.String value, boolean isFileDocument, boolean override) Perform upload then, return value of the real File realtive path.
protected void	updateUploadedFields(java.lang.String fieldName, java.lang.String[] values, boolean isFileDocument, boolean override) Perform upload then, replace all values with value MultipartRequest.MULTIPART_UPLOAD with the real File realtive path.
boolean	validate() Method invoked by JSP to validate all conditions (authorization, parameters, ...), and eventualy trigger the action that was requested to the handler.

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

redirect

protected java.lang.String redirect

noRedirect

protected boolean noRedirect

noSendRedirect

protected boolean noSendRedirect

redirectOnClosePopup

protected boolean redirectOnClosePopup

workspaceForced

protected boolean workspaceForced

popupEdition

protected boolean popupEdition

editFieldSet

protected java.util.HashSet editFieldSet

contextMap

protected java.util.HashMap<java.lang.String,java.lang.Object> contextMap

formStep

protected int formStep

Constructor Detail

JcmsFormHandler

public JcmsFormHandler()

Method Detail

init

protected void init()

Method to implement if you need to initialize your handler from parameter received, prior to all security validation.

You must absolutely not perform any action which modify data or site configuration.

Therefore it is strongly recommend NOT TO implement this method, or use very wisely.

validate

public boolean validate()
                 throws java.io.IOException

Method invoked by JSP to validate all conditions (authorization, parameters, ...), and eventualy trigger the action that was requested to the handler.

You MUST not override this method to validate and perform your action, instead implement processAction() if you need to provide custom actions.

As of current implementation, this method is NOT final to ensure backward compatibility with older handler which may have had a validate() method. But it WILL end as a final method.

Returns:

true if a redirect was done, false otherwise

Throws:

java.io.IOException - if error occured during validate

Since:

jcms-7.1 in JcmsFormHandler (was in EditDataHandler),

afterValidation

protected boolean afterValidation(boolean result)
                           throws java.io.IOException

Throws:

java.io.IOException

processAction

public boolean processAction()
                      throws java.io.IOException

Method to be implemented to check/validate action to be performed and process them.

Default implementation is to return false. No need to call super method.

This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException - IO Exception

getAvailableMainLanguage

public java.lang.String getAvailableMainLanguage()

showCancelButton

public boolean showCancelButton()

Check if the "Cancel" button should be displayed in step modal form.

The default implementation of this method is to always return true.
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Cancel" button, false to hide it

Since:

jcms-7.1.2 jcms-7.2 as requested by issue JCMS-3057

showNextButton

public boolean showNextButton()

Check if the "Next" button should be displayed in step modal form.

The default implementation of this method is to return true unless the finish button is being displayed by method showFinishButton().
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Next" button, false to hide it

showPreviousButton

public boolean showPreviousButton()

Check if the "Previous" button should be displayed in step modal form.

The default implementation of this method is to return true if the current step (as returned by getFormStep() is higher than 0.
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Previous" button, false to hide it

showFinishButton

public boolean showFinishButton()

Check if the "Finish" button should be displayed in step modal form.

The default implementation of this method is to return true if the current step (as returned by getFormStep() is the last one (as compared with getFormStepCount().
You can provide a custom FormHandler to override this behavior.

See jcore/doStepButtons.jspf for use of this method.

Returns:

true to display the "Finish" button, false to hide it

getFormStepCount

public int getFormStepCount()

Retrieve the total number of steps used for edition when invoking this form handler.

The default implementation of this method is to return 1, corresponding to one step (which means only 1 screen being displayed).
You can provide a custom FormHandler to override this behavior.

See jcore/doSteps.jspf for use of this method.

Returns:

the total number of steps in this formhandler

getFormStepPrefixProp

public java.lang.String getFormStepPrefixProp()

Returns:

the prefix prop for the steps

Since:

jcms-9.0.0

getFormStepFinishLabel

public java.lang.String getFormStepFinishLabel()

Returns:

the label of the Finish button

Since:

jcms-9.0.0

getFormStepLabels

public java.lang.String[] getFormStepLabels(java.lang.String userLang)

Returns the label array for the steps.

Parameters:

userLang - the language

Returns:

the label array for the steps.

Since:

jcms-9.0.0

getFormStepHiddenFields

public java.lang.String getFormStepHiddenFields()

getFormStep

public int getFormStep()

Retrieve the current step of edition when invoking this form handler.

See jcore/doSteps.jspf for use of this method.

Returns:

the current steps in this formhandler (starting at 0 and ending at getFormStepCount() - 1)

setFormStep

public void setFormStep(int step)

Set the current step of edition when invoking this form handler.

Parameters:

step - the current step (0 being the first one and getFormStepCount() - 1 being the last one)

getWorkspace

public Workspace getWorkspace()

Description copied from class: JcmsContext

Retrieve the current Workspace variable for this context either from request if inFO or from session if in back office. Fast: this method is cached using initDone (it is recomputed only on forceUpdate() or setRequest()).

Overrides:

getWorkspace in class JcmsContext

Returns:

the workspace (the one set by doInitPage.jsp)

isWorkspaceForced

public boolean isWorkspaceForced()

setWorkspace

public void setWorkspace(Workspace wspc)

setWs

public void setWs(java.lang.String v)

sendRedirect

public void sendRedirect(java.lang.String url,
                boolean checkRedirect)
                  throws java.io.IOException

Set the redirect in the response. If noRedirect has been set, this method set no redirection. If noSendRedirect has been set, put the request attribute "redirect" but do not call response.sendRedirect(). This may be useful when redirecting from a dynamically included JSP in the front-office (some AppServer throw an exception when setting/getting request attribute once the redirect has been put.)

Parameters:

url - the url to redirect to.

checkRedirect - if true and if redirect attribute has been set, redirect on this url

Throws:

java.io.IOException - IO Exception

Since:

jcms-4.0

getClosePopupUrl

protected java.lang.String getClosePopupUrl()

sendRedirect

public void sendRedirect(java.lang.String url)
                  throws java.io.IOException

Redirect current request to given URL.
Overrides JcmsContext.sendRedirect(String) to use behavior provided by sendRedirect(String, boolean).

Overrides:

sendRedirect in class JcmsContext

Parameters:

url - the url to redirect to.

Throws:

java.io.IOException - if an error occured while writing in response headers

Since:

jcms-4.0

See Also:

JcmsContext.sendRedirect(String, HttpServletRequest, HttpServletResponse)

getRedirect

public java.lang.String getRedirect()

Get the value of redirect.

Returns:

Value of redirect.

setRedirect

public void setRedirect(java.lang.String url)

Set the value of redirect.

Parameters:

url - Value to assign to redirect.

setNoRedirect

public void setNoRedirect(boolean noRedirect)

Set the value of noRedirect.

Parameters:

noRedirect - Value to assign to noRedirect.

Since:

jcms-4.0

setNoSendRedirect

public void setNoSendRedirect(boolean noSendRedirect)

Set the value of noSendRedirect.

Parameters:

noSendRedirect - Value to assign to noSendRedirect.

Since:

jcms-4.0

setRedirectOnClosePopup

public final void setRedirectOnClosePopup(boolean redirectOnClosePopup)

Set whether the redirect value should be applied to the opener when closing the popup edition.
The value set by this method will be used only when using popup edition (setPopupEdition(boolean)).

Parameters:

redirectOnClosePopup - if true, the redirect value (setRedirect(String)) will be provided to closePopup.jsp to redirect the opener. if false, the popup will simply be closed and the opener refreshed.

Since:

jcms-5.7

getRedirectOnClosePopup

public final boolean getRedirectOnClosePopup()

Return the value indicating whether the redirect value should be applied to the opener when closing the popup edition.

Returns:

true, when redirect value (setRedirect(String)) will be provided to closePopup.jsp to redirect the opener. false, if the popup will simply be closed and the opener refreshed.

Since:

jcms-5.7

processStatus

protected boolean processStatus(ControllerStatus status)
                         throws java.io.IOException

Process the ControllerStatus: do nothing if OK, or send on forbidden, or put a warning message in the request.

Parameters:

status - the ControllerStatus to be processed

Returns:

true when status is OK, false if status was a failure (forbidden or anything else)

Throws:

java.io.IOException - if an error occurs

Since:

jcms-5.0.0

getControllerContext

protected java.util.HashMap<java.lang.String,java.lang.Object> getControllerContext()

Build a controller context. I.E. add request, response and loggedMember.

Returns:

the HashMap which contains the context

Since:

jcms-5.0.0

isFieldMissing

protected boolean isFieldMissing(java.lang.String field)

Check if the given parameter is present in the query parameters

Parameters:

field - the field to be checked

Returns:

true if this field is present in the query parameters

Since:

jcms-5.0.0

setPopupEdition

public void setPopupEdition(boolean v)

Set where this form handler is being invoked in a popup.

Parameters:

v - true if handler is invoked in popup, false otherwise

Since:

jcms-5.0.0

isPopupEdition

public boolean isPopupEdition()

Returns:

true if this form handler is invoked through a popup

Since:

jcms-5.0.0

setEditField

public void setEditField(java.lang.String[] v)

Parameters:

v - a set of field names to edit

Since:

jcms-5.0.0

getEditFieldSet

public java.util.HashSet getEditFieldSet()

Returns:

a set of field names being edited

Since:

jcms-5.0.0

isFieldEdition

public boolean isFieldEdition(java.lang.String field)

Parameters:

field - field name

Returns:

true if this handler is invoked to edit only some fields of the data

Since:

jcms-5.0.0

See Also:

getEditFieldSet()

isPartialFieldEdition

public boolean isPartialFieldEdition()

Returns true if this is a partial field edition (i.e. front edition)

Returns:

true if this is a partial field edition.

Since:

jcms-5.5.0

updateUploadedField

protected java.lang.String updateUploadedField(java.lang.String fieldName,
                                   java.lang.String value,
                                   boolean isFileDocument,
                                   boolean override)

Perform upload then, return value of the real File realtive path. if value is equal to MultipartRequest.MULTIPART_UPLOAD

Parameters:

fieldName - the field name

value - the field fake value

isFileDocument - is file document

override - override file

Returns:

String

Since:

jcms-5.7.0

updateUploadedFields

protected void updateUploadedFields(java.lang.String fieldName,
                        java.lang.String[] values,
                        boolean isFileDocument,
                        boolean override)

Perform upload then, replace all values with value MultipartRequest.MULTIPART_UPLOAD with the real File realtive path.

Parameters:

fieldName - the field name

values - the field fake values

isFileDocument - is file document

override - override file

Since:

jcms-5.7.0

getMainLangValue

protected java.lang.String getMainLangValue(java.lang.String[] array,
                                boolean trim,
                                boolean escape)

Returns the first value (i.e. the main language value) from the given array (monovalued ML fields).

Parameters:

array - the array

trim - if true trim the value

escape - if true escape the value

Returns:

the first value from the array.

Since:

jcms-6.0.0

getMLMap

protected java.util.HashMap<java.lang.String,java.lang.String> getMLMap(java.lang.String[] array,
                                                            boolean trim,
                                                            boolean escape)

Returns the ML map (i.e. the additionnal languages) filled with the values contained in the given array (monovalued ML fields).

Parameters:

array - the array

trim - if true trim the values

escape - if true escape the values

Returns:

the ML map filled with the values contained in the given array.

Since:

jcms-6.0.0

getMainLangValueArray

protected java.lang.String[] getMainLangValueArray(java.lang.String[] array,
                                       boolean trim,
                                       boolean escape)

Returns the first values (i.e. the main language value) from the given array (multivalued ML fields).

Parameters:

array - the array

trim - if true trim the values

escape - if true escape the values

Returns:

the first values from the array (i.e. the main language value) from the given array.

Since:

jcms-6.0.0

getMLMapArray

protected java.util.HashMap<java.lang.String,java.lang.String[]> getMLMapArray(java.lang.String[] array,
                                                                   boolean trim,
                                                                   boolean escape)

Returns the ML map (i.e. the additionnal languages) filled with the values contained in the given array (multivalued ML fields).

Parameters:

array - the array

trim - if true trim the values

escape - if true escape the values

Returns:

the ML map filled with the values contained in the given array.

Since:

jcms-6.0.0

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              java.lang.String value)

getHiddenFieldML

public java.lang.String getHiddenFieldML(java.lang.String name,
                                java.util.HashMap<java.lang.String,java.lang.String> map)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              Data value)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              boolean value)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              int value)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              double value)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              long value)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              java.util.Date value)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              Data[] datas)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              boolean[] array)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              int[] array)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              long[] array)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              double[] array)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              java.lang.String[] array)

getHiddenField

public java.lang.String getHiddenField(java.lang.String name,
                              java.util.Date[] array)

getHiddenField

public <T extends Data> java.lang.String getHiddenField(java.lang.String name,
                                               java.util.Set<T> set)

checkMissingField

protected boolean checkMissingField(java.lang.Object obj,
                        java.lang.String prop)