com.filenet.wcm.apps.server.ui.wizard
Class WcmEntryDesignerWizard

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
                              extended bycom.filenet.wcm.apps.server.ui.wizard.WcmEntryDesignerWizard
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmEntryDesignerWizard
extends WcmWizardModule


Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
WcmWizardModule.WcmWizardPanel
 
Field Summary
static java.lang.String MODE_ADD
           
static java.lang.String MODE_MODIFY
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
bannerModule, footerLinksBarModule, footerModule, leftCSSClass, stepNode, stepTreeModule, summaryModule, 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
WcmEntryDesignerWizard()
           
 
Method Summary
protected  void addPanelSelectionAnchor(int panelNumber)
           
 void cleanup()
          Clean up module cached data.
protected  void configureAddEntryFolderSelectionPage()
          Setup the Add Entry folder selection page
protected  void configureAddEntryPropertiesSelectionPage()
          Setup the Add Entry properties selection page
protected  void configureAddEntrySecuritySelectionPage()
          Setup the Add Entry security selection page
protected  void configureFolderSelectionPage()
          Setup the Folder selection page
protected  void configurePropertiesSelectionPage()
          Setup the Properties page
protected  void configureRecordsTemplateSelectionPage()
          Setup the EntryDesignerRecordsWizardPage
protected  void configureSecuritySelectionPage()
          Setup the Security selection page
protected  void configureSummary()
          Writes the actual contents of the status bar.
protected  void configureWorkflowPropsSelectionPage()
          Setup the Workflow properties selection page
protected  void configureWorkflowSelectionPage()
          Setup the Workflow selection page
 WcmEntryDesignerFolderWizardPage getEntryDesignerFolderWizardPage()
          Get accessor returns WcmEntryDesignerFolderWizardPage
 WcmEntryDesignerPropertiesWizardPage getEntryDesignerPropertiesWizardPage()
          Get accessor returns WcmEntryDesignerPropertiesWizardPage
 EntryDesignerRecordsWizardPage getEntryDesignerRecordsWizardPage()
          Get accessor returns EntryDesignerRecordsWizardPage
 WcmEntryDesignerSecurityWizardPage getEntryDesignerSecurityWizardPage()
          Get accessor returns WcmEntryDesignerSecurityWizardPage
 WcmEntryDesignerWorkflowPropsWizardPage getEntryDesignerWorkflowPropsWizardPage()
          Get accessor returns WcmEntryDesignerWorkflowPropsWizardPage
 WcmEntryDesignerWorkflowWizardPage getEntryDesignerWorkflowWizardPage()
          Get accessor returns WcmEntryDesignerWorkflowWizardPage
 void initialize()
          This method queries for the Authoring and Navigation data providers, then adds each page to the wizard.
protected  void initialStateData()
          Initialize state data
 void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called in response to a cancel wizard request.
 void onFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          When Finish button is pressed, add the folder as requested.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initialize the Classes
protected  boolean saveModuleProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int panelNumber, boolean skip)
          Save module properties if user did not select those page then we have force to save its content back to entry template
protected  void setIsFinished()
          Goes through the pages and sets the isFinished member of WcmPage
 void setMode(java.lang.String mode)
          Indicate what mode this module is working at
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
addPanel, addSummaryItem, addSummaryItem, getAnchor, getAnchor, getFooter, getPageBanner, getSummaryModule, getTabBar, getTextLinksBar, isBackEnabled, isFinishEnabled, isNextEnabled, isPanelEnabled, okayToProceed, onSelectPanel, render, setCancelLinkText, setCurrentPanelSelection, setFinishLinkText, setMultiPanelModuleTitle, setNextLinkText, setPreviousLinkText
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
cancelAll, 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, 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, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

MODE_ADD

public static final java.lang.String MODE_ADD
See Also:
Constant Field Values

MODE_MODIFY

public static final java.lang.String MODE_MODIFY
See Also:
Constant Field Values
Constructor Detail

WcmEntryDesignerWizard

public WcmEntryDesignerWizard()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
This method queries for the Authoring and Navigation data providers, then adds each page to the wizard. It also sets the wizard tab and the done URL.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmWizardModule
Throws:
java.lang.Exception - If a data provider was not found.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Initialize the Classes

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class WcmWizardModule
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

configureSummary

protected void configureSummary()
                         throws java.lang.Exception
Writes the actual contents of the status bar.

Overrides:
configureSummary in class WcmWizardModule
Throws:
java.lang.Exception

configureFolderSelectionPage

protected void configureFolderSelectionPage()
                                     throws java.lang.Exception
Setup the Folder selection page

Throws:
java.lang.Exception

configurePropertiesSelectionPage

protected void configurePropertiesSelectionPage()
                                         throws java.lang.Exception
Setup the Properties page

Throws:
java.lang.Exception

configureSecuritySelectionPage

protected void configureSecuritySelectionPage()
                                       throws java.lang.Exception
Setup the Security selection page

Throws:
java.lang.Exception

configureWorkflowSelectionPage

protected void configureWorkflowSelectionPage()
                                       throws java.lang.Exception
Setup the Workflow selection page

Throws:
java.lang.Exception

configureWorkflowPropsSelectionPage

protected void configureWorkflowPropsSelectionPage()
                                            throws java.lang.Exception
Setup the Workflow properties selection page

Throws:
java.lang.Exception

configureRecordsTemplateSelectionPage

protected void configureRecordsTemplateSelectionPage()
                                              throws java.lang.Exception
Setup the EntryDesignerRecordsWizardPage

Throws:
java.lang.Exception

configureAddEntryFolderSelectionPage

protected void configureAddEntryFolderSelectionPage()
                                             throws java.lang.Exception
Setup the Add Entry folder selection page

Throws:
java.lang.Exception

configureAddEntryPropertiesSelectionPage

protected void configureAddEntryPropertiesSelectionPage()
                                                 throws java.lang.Exception
Setup the Add Entry properties selection page

Throws:
java.lang.Exception

configureAddEntrySecuritySelectionPage

protected void configureAddEntrySecuritySelectionPage()
                                               throws java.lang.Exception
Setup the Add Entry security selection page

Throws:
java.lang.Exception

getEntryDesignerFolderWizardPage

public WcmEntryDesignerFolderWizardPage getEntryDesignerFolderWizardPage()
Get accessor returns WcmEntryDesignerFolderWizardPage

Returns:
WcmEntryDesignerFolderWizardPage

getEntryDesignerPropertiesWizardPage

public WcmEntryDesignerPropertiesWizardPage getEntryDesignerPropertiesWizardPage()
Get accessor returns WcmEntryDesignerPropertiesWizardPage

Returns:
WcmEntryDesignerPropertiesWizardPage

getEntryDesignerSecurityWizardPage

public WcmEntryDesignerSecurityWizardPage getEntryDesignerSecurityWizardPage()
Get accessor returns WcmEntryDesignerSecurityWizardPage

Returns:
WcmEntryDesignerSecurityWizardPage

getEntryDesignerWorkflowWizardPage

public WcmEntryDesignerWorkflowWizardPage getEntryDesignerWorkflowWizardPage()
Get accessor returns WcmEntryDesignerWorkflowWizardPage

Returns:
WcmEntryDesignerWorkflowWizardPage

getEntryDesignerWorkflowPropsWizardPage

public WcmEntryDesignerWorkflowPropsWizardPage getEntryDesignerWorkflowPropsWizardPage()
Get accessor returns WcmEntryDesignerWorkflowPropsWizardPage

Returns:
WcmEntryDesignerWorkflowPropsWizardPage

getEntryDesignerRecordsWizardPage

public EntryDesignerRecordsWizardPage getEntryDesignerRecordsWizardPage()
Get accessor returns EntryDesignerRecordsWizardPage

Returns:
EntryDesignerRecordsWizardPage

onCancel

public void onCancel(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Called in response to a cancel wizard request. It releases module properties and calls the base class method.

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

saveModuleProperties

protected boolean saveModuleProperties(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       int panelNumber,
                                       boolean skip)
                                throws java.lang.Exception
Save module properties if user did not select those page then we have force to save its content back to entry template

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
panelNumber - Module panel number
Throws:
java.lang.Exception

onFinish

public void onFinish(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
When Finish button is pressed, add the folder as requested. Then cancels all pages, resets the PageId to null, and redirects.

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

addPanelSelectionAnchor

protected void addPanelSelectionAnchor(int panelNumber)
                                throws java.lang.Exception
Overrides:
addPanelSelectionAnchor in class WcmWizardModule
Throws:
java.lang.Exception

setIsFinished

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

Overrides:
setIsFinished in class WcmWizardModule
Throws:
java.lang.Exception

setMode

public void setMode(java.lang.String mode)
Indicate what mode this module is working at

Parameters:
mode - String Add or Modify.

cleanup

public void cleanup()
             throws java.lang.Exception
Clean up module cached data.

Throws:
java.lang.Exception

initialStateData

protected void initialStateData()
                         throws java.lang.Exception
Initialize state data

Throws:
java.lang.Exception


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