public class PageLayoutFormHandler extends PageFormHandler
Everytime the previewLayout property is changed the handlePreviewLayout method will be called to rearrange the gears in the region definition(s) of the layout associated with the Page property of this form handler. The new arrangement of gears is available in a Map previewGearArrangement keyed by gear definition ids, which can be used by the page which is using this form handler to display the arrangement to the end user. finalLayout and finalGearArrangement properties are used to store the layout and gear arrangement for the page when handleUpdateLayout is called.
All handle methods in this form handler mirror a similiar pattern.
Each handleXXX process, some have an associated preXXX and postXXX method.
For example, the handleUpdateLayout
has an associated
preUpdateLayout
and postUpdateLayout
.
These pre/post methods provide an easy way for customer's to extend the
functionality of this form handler.
TransactionalFormHandler
,
PortalGenericFormHandler
,
PageFormHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
PageLayoutFormHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getFinalGearArrangement() |
java.lang.String[] |
getFinalRegionOrder() |
java.lang.String |
getGearArrangementListSeperator() |
java.util.Map |
getPreviewGearArrangement() |
java.lang.String |
getPreviewLayout() |
int |
getPreviewRegDefSize() |
boolean |
handlePreviewLayout(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Updates the arrangement of gears after a layout change in the
previewGearArrangement property
|
boolean |
handleUpdateLayoutAdminMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to update the layout of to a page in admin mode
|
boolean |
handleUpdateLayoutUserMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to update the layout of to a personalized page.
|
void |
postUpdateLayoutAdminMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component update is finished
|
void |
postUpdateLayoutUserMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component update is finished
|
void |
preUpdateLayoutAdminMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component update is started
|
void |
preUpdateLayoutUserMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component update is started
|
protected java.util.Map |
rearrangeGears(Page pPage,
Layout pNewLayout)
Create a map of gears list keyed on gear definition ids for the given page
using the layout associated with the given pNewLayout.
|
protected void |
resetBean()
Reset this bean set properties to null
|
void |
setFinalGearArrangement(int index,
java.lang.String pFinalGearArrangementList) |
void |
setFinalRegionOrder(int index,
java.lang.String pFinalRegionOrderList) |
void |
setGearArrangementListSeperator(java.lang.String pGearArrangementListSeperator) |
void |
setPreviewGearArrangement(java.util.Map pPreviewGearArrangement) |
void |
setPreviewLayout(java.lang.String pPreviewLayout) |
void |
setPreviewRegDefSize(int pPreviewLayoutSize) |
protected boolean |
updateLayoutAdminMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
updateLayout is called by the handlers to update the layout of the page.
|
protected boolean |
updateLayoutUserMode(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
updateLayout is called by the handlers to update the layout of the page.
|
createPageAdminMode, createPageUserMode, deletePageAdminMode, deletePageUserMode, getAccessLevel, getAllowLayoutChanges, getColorPalette, getCommunity, getCommunityId, getDescription, getFixed, getGears, getLayoutTemplate, getMakeDefault, getName, getPage, getPageId, getParentCommunity, getParentFolder, getPortal, getPosition, getProfile, getRegions, getUrl, getWirelessEnabled, handleCreatePageAdminMode, handleCreatePageUserMode, handleDeletePageAdminMode, handleDeletePageUserMode, handleReset, handleUpdatePageAdminMode, handleUpdatePageUserMode, postCreatePageAdminMode, postCreatePageUserMode, postDeletePageAdminMode, postDeletePageUserMode, postUpdatePageAdminMode, postUpdatePageUserMode, preCreatePageAdminMode, preCreatePageUserMode, preDeletePageAdminMode, preDeletePageUserMode, preUpdatePageAdminMode, preUpdatePageUserMode, setAccessLevel, setAllowLayoutChanges, setColorPalette, setCommunity, setCommunityId, setDescription, setFixed, setGears, setLayoutTemplate, setMakeDefault, setName, setPage, setPageId, setParentCommunity, setParentFolder, setPortal, setPosition, setProfile, setRegions, setUrl, setWirelessEnabled, updatePageAdminMode, updatePageUserMode
addFormException, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, getDefaultLocale, getFailureMessageProcessor, getFailureURL, getFormError, getFormInfo, getFormMessages, getLocale, getPublisher, getSuccessMessageProcessor, getSuccessURL, getUserLocale, handleResetFormExceptions, handleResetFormMessages, handleSetLocale, isUseRequestLocale, processException, processException, processException, processException, processSuccess, processSuccess, processSuccess, resetFormMessages, sendAlertMessage, setDefaultLocale, setFailureMessageProcessor, setFailureURL, setPublisher, setSuccessMessageProcessor, setSuccessURL, setUseRequestLocale
afterSet, beforeSet, checkFormRedirect, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation
addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards
afterGet, beforeGet
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public java.lang.String getPreviewLayout()
public void setPreviewLayout(java.lang.String pPreviewLayout)
public int getPreviewRegDefSize()
public void setPreviewRegDefSize(int pPreviewLayoutSize)
public java.lang.String[] getFinalGearArrangement()
public void setFinalGearArrangement(int index, java.lang.String pFinalGearArrangementList)
public java.util.Map getPreviewGearArrangement()
public void setPreviewGearArrangement(java.util.Map pPreviewGearArrangement)
public java.lang.String[] getFinalRegionOrder()
public void setFinalRegionOrder(int index, java.lang.String pFinalRegionOrderList)
public java.lang.String getGearArrangementListSeperator()
public void setGearArrangementListSeperator(java.lang.String pGearArrangementListSeperator)
public boolean handleUpdateLayoutAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected boolean updateLayoutAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException, SecurityException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongSecurityException
public void preUpdateLayoutAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postUpdateLayoutAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic boolean handleUpdateLayoutUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected boolean updateLayoutUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException, SecurityException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongSecurityException
public void preUpdateLayoutUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postUpdateLayoutUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic boolean handlePreviewLayout(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected java.util.Map rearrangeGears(Page pPage, Layout pNewLayout) throws PortalException
PortalException
protected void resetBean()
resetBean
in class PageFormHandler