com.filenet.wcm.apps.server.ui
Class WcmWizardModule

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
                          extended bycom.filenet.wcm.apps.server.ui.WcmWizardModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
AddChildDocumentWizard, CreateLinkWizard, DeclareRecordsWizard, RecordsTemplateDesignerWizard, SelectProfileWizard, WcmAddCustomObjectWizard, WcmAddFolderWizard, WcmAddObjectWizard, WcmAddWizard, WcmCheckinWizard, WcmEntryDesignerWizard, WcmEntryWizard, WcmMoveWizard, WcmPublishWizard, WcmSecurityPolicyWizard, WcmSecurityTemplateWizard, WcmWorkflowSubscription, WebContentEntryDesigner, WebContentEntryRunTime

public class WcmWizardModule
extends com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule

The WcmWizardModule class implements the base for all wizards, similarly to the way that the WcmInfoModule class implements the base for all Info bars. Derived classes can make calls to addPanel to have them appear in the wizard.


Nested Class Summary
protected static class WcmWizardModule.WcmWizardPanel
           
 
Field Summary
protected  WcmPageBanner bannerModule
           
protected  com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar footerLinksBarModule
           
protected  WcmFooter footerModule
           
protected  java.lang.String leftCSSClass
           
protected  com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode stepNode
           
protected  WcmTreeView stepTreeModule
           
protected  WcmSummaryModule summaryModule
           
protected  WcmLayoutTitleBar titleBarModule
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
controller, sequenceInit
 
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
WcmWizardModule()
          Constructor creates private fields and calls setName.
 
Method Summary
 int addPanel(com.filenet.wcm.toolkit.server.base.WcmUiModule module, com.filenet.wcm.toolkit.util.WcmString wsTitle, com.filenet.wcm.toolkit.util.WcmString wsToolTip)
          Adds a new module to the container.
protected  void addPanelSelectionAnchor(int panelNumber)
           
 void addSummaryItem(java.lang.String heading, java.lang.String text)
           
 void addSummaryItem(com.filenet.wcm.toolkit.util.WcmString heading, java.lang.String text)
           
protected  void configureSummary()
          Writes the actual contents of the status bar.
protected  java.lang.String getAnchor(java.lang.String eventName, java.lang.String sFormName, int nId)
          returns the javascript version of the submitForm tag
protected  java.lang.String getAnchor(java.lang.String eventName, java.lang.String sFormName, int nId, int nLinkId)
          returns the javascript version of the submitForm tag
 WcmFooter getFooter()
          Get accessor returns WcmFooter
 WcmPageBanner getPageBanner()
          Get accessor returns WcmPageBanner
 WcmSummaryModule getSummaryModule()
          Accessor method to return the WcmSummaryModule object.
 WcmLayoutTitleBar getTabBar()
          Get accessor returns WcmLayoutTitleBar
 WcmTextLinksBar getTextLinksBar()
          Accessor method to return the WcmTextLinksBar object.
 void initialize()
          Initializes the wizard state and registers all pages.
protected  boolean isBackEnabled(int nId)
          Checks the given page number and decides if the back button should be enabled.
protected  boolean isFinishEnabled(int nId)
          Checks the given page number and decides if the finish button should be enabled.
protected  boolean isNextEnabled(int panelNumber)
          Checks the given panel number and decides if the next button should be enabled.
protected  boolean isPanelEnabled(int panelNumber, boolean recursive)
           
protected  boolean okayToProceed(com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface panel)
          Deprecated.  
 void onSelectPanel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          When user selects a panel, calls wizardSave on the previous page and sets the new page to render.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event, calling WcmController.setHelpContext for the current page.
 void render(java.io.Writer w)
           
protected  void setCancelLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
           
protected  void setCurrentPanelSelection(int panelNumber)
           
protected  void setFinishLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
           
protected  void setIsFinished()
          Goes through the pages and sets the isFinished member of WcmPage
 void setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle, boolean primaryTitle)
           
protected  void setNextLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
           
protected  void setPreviousLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
           
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
cancelAll, onCancel, onFinish, onNext, onPrevious, selectPanel, selectPanel
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onExit, selectPanel, 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
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.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

titleBarModule

protected WcmLayoutTitleBar titleBarModule

bannerModule

protected WcmPageBanner bannerModule

footerModule

protected WcmFooter footerModule

footerLinksBarModule

protected com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar footerLinksBarModule

summaryModule

protected WcmSummaryModule summaryModule

stepTreeModule

protected WcmTreeView stepTreeModule

stepNode

protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode stepNode

leftCSSClass

protected java.lang.String leftCSSClass
Constructor Detail

WcmWizardModule

public WcmWizardModule()
Constructor creates private fields and calls setName.

Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the wizard state and registers all pages.

Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
The default event, calling WcmController.setHelpContext for the current page.

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

setIsFinished

protected void setIsFinished()
                      throws java.lang.Exception
Goes through the pages and sets the isFinished member of WcmPage

Throws:
java.lang.Exception

onSelectPanel

public void onSelectPanel(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
When user selects a panel, calls wizardSave on the previous page and sets the new page to render.

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

isBackEnabled

protected boolean isBackEnabled(int nId)
Checks the given page number and decides if the back button should be enabled.

Parameters:
nId - the panel Id.
Returns:
boolean indicating if the previous button should be enabled.

isNextEnabled

protected boolean isNextEnabled(int panelNumber)
                         throws java.lang.Exception
Checks the given panel number and decides if the next button should be enabled.

Parameters:
panelNumber - the panel Id.
Returns:
boolean indicating if the next button should be enabled.
Throws:
java.lang.Exception

isFinishEnabled

protected boolean isFinishEnabled(int nId)
                           throws java.lang.Exception
Checks the given page number and decides if the finish button should be enabled.

Parameters:
nId - the page Id.
Returns:
boolean indicating if the finish button should be enabled.
Throws:
java.lang.Exception

isPanelEnabled

protected boolean isPanelEnabled(int panelNumber,
                                 boolean recursive)
                          throws java.lang.Exception
Throws:
java.lang.Exception

getAnchor

protected java.lang.String getAnchor(java.lang.String eventName,
                                     java.lang.String sFormName,
                                     int nId)
                              throws java.lang.Exception
returns the javascript version of the submitForm tag

Parameters:
eventName - The eventName this Anchor should call.
sFormName - The form that should be submitted by this Anchor.
nId - The Page number that this event refers to.
Returns:
The href to use for the specified anchor.
Throws:
java.lang.Exception

getAnchor

protected java.lang.String getAnchor(java.lang.String eventName,
                                     java.lang.String sFormName,
                                     int nId,
                                     int nLinkId)
                              throws java.lang.Exception
returns the javascript version of the submitForm tag

Parameters:
eventName - The eventName this Anchor should call.
sFormName - The form that should be submitted by this Anchor.
nId - The Page number that this event refers to.
nLinkId - The page number that this event links to.
Returns:
The href to use for the specified anchor.
Throws:
java.lang.Exception

addPanelSelectionAnchor

protected void addPanelSelectionAnchor(int panelNumber)
                                throws java.lang.Exception
Throws:
java.lang.Exception

setCurrentPanelSelection

protected void setCurrentPanelSelection(int panelNumber)

addPanel

public int addPanel(com.filenet.wcm.toolkit.server.base.WcmUiModule module,
                    com.filenet.wcm.toolkit.util.WcmString wsTitle,
                    com.filenet.wcm.toolkit.util.WcmString wsToolTip)
             throws java.lang.Exception
Adds a new module to the container.

Parameters:
module - a module to add
wsTitle - a label for the module that will be displayed in the tab bar
wsToolTip - tooltip for the tab label
Throws:
java.lang.Exception

okayToProceed

protected boolean okayToProceed(com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface panel)
                         throws java.lang.Exception
Deprecated.  

Throws:
java.lang.Exception

setMultiPanelModuleTitle

public void setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle,
                                     boolean primaryTitle)

configureSummary

protected void configureSummary()
                         throws java.lang.Exception
Writes the actual contents of the status bar. Intended to be overwritten in derived wizard classes

Throws:
java.lang.Exception

addSummaryItem

public void addSummaryItem(com.filenet.wcm.toolkit.util.WcmString heading,
                           java.lang.String text)
                    throws java.lang.Exception
Throws:
java.lang.Exception

addSummaryItem

public void addSummaryItem(java.lang.String heading,
                           java.lang.String text)
                    throws java.lang.Exception
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Throws:
java.lang.Exception

getTabBar

public WcmLayoutTitleBar getTabBar()
                            throws java.lang.Exception
Get accessor returns WcmLayoutTitleBar

Returns:
WcmLayoutTitleBar
Throws:
java.lang.Exception

getPageBanner

public WcmPageBanner getPageBanner()
                            throws java.lang.Exception
Get accessor returns WcmPageBanner

Returns:
WcmPageBanner
Throws:
java.lang.Exception

getTextLinksBar

public WcmTextLinksBar getTextLinksBar()
Accessor method to return the WcmTextLinksBar object.

Returns:
WcmTextLinksBar object.

getSummaryModule

public WcmSummaryModule getSummaryModule()
Accessor method to return the WcmSummaryModule object.

Returns:
WcmSummaryModule object.

getFooter

public WcmFooter getFooter()
                    throws java.lang.Exception
Get accessor returns WcmFooter

Returns:
WcmFooter
Throws:
java.lang.Exception

setPreviousLinkText

protected void setPreviousLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)

setNextLinkText

protected void setNextLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)

setCancelLinkText

protected void setCancelLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)

setFinishLinkText

protected void setFinishLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)


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