|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
WcmMultiPanelSequenceModule acts as a container for one or more UI modules organized in sequential steps and presented in a wizard fashion.
Field Summary | |
protected WcmController |
controller
A controller class that registers ui modules and handles events. |
protected boolean |
sequenceInit
A flag that indicates the start of a wizard. |
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule |
currentModule, currentPanel, currentPanelNumber, panelList |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmMultiPanelSequenceModule()
|
Method Summary | |
void |
cancelAll(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Cancels all pending sequence panels. |
void |
initialize()
Initializes the WcmMultiPanelSequenceModule module by initializing all panels in particapating in the sequence module. |
void |
onCancel(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when the user clicks Exit or Cancel. |
void |
onFinish(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when the user clicks Finish. |
void |
onNext(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when the user clicks Next. |
void |
onPrevious(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when the user clicks Previous. |
void |
selectPanel(int panelNumber,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Extends the behavior of WcmMultiPanelModule. |
void |
selectPanel(int currentPanelNbr,
int newPanelNbr,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Selects a new sequence panel relative to the passed in current panel number. |
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule |
addPanel, addPanel, addPanel, addPanel, addPanelSelectionAnchor, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onExit, onSelectPanel, render, selectPanel, setCurrentPanelSelection, setMultiPanelModuleTitle, setMultiPanelModuleTitle |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule |
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP |
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule |
onStartPage, subscribeGlobalEvent |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer |
addDataProvider, addDataProvider |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface |
onStartPage |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Field Detail |
protected boolean sequenceInit
protected WcmController controller
Constructor Detail |
public WcmMultiPanelSequenceModule()
Method Detail |
public void initialize() throws java.lang.Exception
initialize
in interface WcmModuleInterface
initialize
in class WcmMultiPanelModule
java.lang.Exception
- All Exceptions.public void onNext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
Sample:
Current Panel Number = 3 page = 1 ... // Sets the current panel to panel 1 first. This will save panel 3 data prior to switching to panel 1. selectPanel(page, request, response); // Move to the next panel (Panel 2) selectPanel(currentPanelNumber + 1, request, response);
request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void onPrevious(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
Sample:
Current Panel Number = 3 page = 2 ... // Sets the current panel to panel 2 first. This will save panel 3 data prior to switching to panel 2. selectPanel(page, request, response); // Moves to the previous panel (Panel 1) selectPanel(currentPanelNumber - 1, request, response);
request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void onFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void selectPanel(int panelNumber, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
selectPanel
in class WcmMultiPanelModule
panelNumber
- The selected panel number.request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void selectPanel(int currentPanelNbr, int newPanelNbr, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
currentPanelNbr
- The selected current panel number.newPanelNbr
- The new selected panel number.request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void cancelAll(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |