|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.droplet.EmptyFormHandler atg.droplet.GenericFormHandler atg.droplet.TransactionalFormHandler atg.portal.admin.PortalGenericFormHandler atg.portal.admin.PageFormHandler atg.portal.admin.PageLayoutFormHandler
public class PageLayoutFormHandler
This form handler provides convenient methods for updating a community page's layout
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
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.droplet.GenericFormHandler |
---|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
PageLayoutFormHandler()
|
Method Summary | |
---|---|
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. |
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet, beforeGet |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public PageLayoutFormHandler()
Method Detail |
---|
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 response
javax.servlet.ServletException
- if there was an error while executing the code
java.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 object
javax.servlet.ServletException
- if something went wrong
java.io.IOException
- if something went wrong
SecurityException
public void preUpdateLayoutAdminMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response object
javax.servlet.ServletException
- if something went wrong
java.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 object
javax.servlet.ServletException
- if something went wrong
java.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 response
javax.servlet.ServletException
- if there was an error while executing the code
java.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 object
javax.servlet.ServletException
- if something went wrong
java.io.IOException
- if something went wrong
SecurityException
public void preUpdateLayoutUserMode(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response object
javax.servlet.ServletException
- if something went wrong
java.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 object
javax.servlet.ServletException
- if something went wrong
java.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 response
javax.servlet.ServletException
- if there was an error while executing the code
java.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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |