com.filenet.wcm.toolkit.server.ui
Class WcmMultiPanelSequenceModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
All Implemented Interfaces:
WcmModuleInterface, WcmUiModuleInterface

public abstract class WcmMultiPanelSequenceModule
extends WcmMultiPanelModule

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

sequenceInit

protected boolean sequenceInit
A flag that indicates the start of a wizard.


controller

protected WcmController controller
A controller class that registers ui modules and handles events.

Constructor Detail

WcmMultiPanelSequenceModule

public WcmMultiPanelSequenceModule()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the WcmMultiPanelSequenceModule module by initializing all panels in particapating in the sequence module.

Specified by:
initialize in interface WcmModuleInterface
Overrides:
initialize in class WcmMultiPanelModule
Throws:
java.lang.Exception - All Exceptions.

onNext

public void onNext(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Event that occurs when the user clicks Next.

  1. Get the page parameter from the request string.
  2. If page is defined in the request string and is not equal to the current panel number, selects a new sequence panel with the passed in page number. This saves the current panel data and switches the current panel to the passed in page number.
  3. Select the next panel (current panel number + 1).

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);
  

Parameters:
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.

onPrevious

public void onPrevious(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Event that occurs when the user clicks Previous.

  1. Get the page parameter from the request string.
  2. If page is defined in the request string and is not equal to the current panel number, select a new panel with the passed in page number. This saves the current panel data and switches the current panel to the passed in page number.
  3. Select the previous panel (current panel number - 1).

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);
  

Parameters:
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.

onFinish

public void onFinish(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event that occurs when the user clicks Finish.

Parameters:
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.

onCancel

public void onCancel(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event that occurs when the user clicks Exit or Cancel.

Parameters:
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.

selectPanel

public void selectPanel(int panelNumber,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Extends the behavior of WcmMultiPanelModule.

Overrides:
selectPanel in class WcmMultiPanelModule
Parameters:
panelNumber - The selected panel number.
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.

selectPanel

public void selectPanel(int currentPanelNbr,
                        int newPanelNbr,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Selects a new sequence panel relative to the passed in current panel number.

Parameters:
currentPanelNbr - The selected current panel number.
newPanelNbr - The new selected panel number.
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.

cancelAll

public void cancelAll(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Cancels all pending sequence panels.

Parameters:
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.