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

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.WcmAddWizard
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmAddWizard
extends WcmWizardModule

This wizard is for adding a new document. It has four pages: The folder selection page for choosing which folder to place the document, the property page for selecting the document class and setting properties, the security page for setting security on the new document, and the file selection page for choosing the file to add.


Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
WcmWizardModule.WcmWizardPanel
 
Field Summary
 
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
WcmAddWizard()
          Constructor calls base class constructor, then creates the required pages.
 
Method Summary
protected  boolean canDeclare(boolean canDeclare, java.lang.String docClass, com.filenet.wcm.apps.server.presentation.util.ActionConfiguration ac, AccessRoles accessRoles)
           
 void cleanup()
          Clean it up
 void completeWizard(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
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
 WcmFileSelectWizardPage getFileSelectWizardPage()
          Get accessor returns WcmFileSelectWizardPage
 WcmFolderSelectionWizardPage getFolderSelectionWizardPage()
          Get accessor returns WcmFolderSelectionWizardPage
 WcmPropertiesWizardPage getPropertiesWizardPage()
          Get accessor returns WcmPropertiesWizardPage
 WcmSecurityWizardPage getSecurityWizardPage()
          Get accessor returns WcmSecurityWizardPage
 void initialize()
          This method queries for the Authoring and Navigation data providers, then adds each page to the wizard.
 void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called in response to a cancel wizard request.
 void onComplete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called in response to a finish wizard request.
 void onLocalCopyDeleted(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
protected  void setIsFinished()
          Goes through the pages and sets the isFinished member of WcmPage
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
addPanel, addPanelSelectionAnchor, addSummaryItem, addSummaryItem, getAnchor, getFooter, getPageBanner, getSummaryModule, getTabBar, getTextLinksBar, isBackEnabled, isFinishEnabled, isNextEnabled, isPanelEnabled, okayToProceed, onSelectPanel, onStartPage, 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
 

Constructor Detail

WcmAddWizard

public WcmAddWizard()
             throws java.lang.Exception
Constructor calls base class constructor, then creates the required pages.

Throws:
java.lang.Exception - If there were problems constructing the module.
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.

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 - if there were problems retrieving summary data.

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 - if there were problems completing the operation.

onFinish

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

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception - if there were problems completing the operation.

canDeclare

protected boolean canDeclare(boolean canDeclare,
                             java.lang.String docClass,
                             com.filenet.wcm.apps.server.presentation.util.ActionConfiguration ac,
                             AccessRoles accessRoles)

onComplete

public void onComplete(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Throws:
java.lang.Exception

onLocalCopyDeleted

public void onLocalCopyDeleted(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.lang.Exception
Throws:
java.lang.Exception

completeWizard

public void completeWizard(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Throws:
java.lang.Exception

getFolderSelectionWizardPage

public WcmFolderSelectionWizardPage getFolderSelectionWizardPage()
Get accessor returns WcmFolderSelectionWizardPage

Returns:
WcmFolderSelectionWizardPage

getPropertiesWizardPage

public WcmPropertiesWizardPage getPropertiesWizardPage()
Get accessor returns WcmPropertiesWizardPage

Returns:
WcmPropertiesWizardPage

getSecurityWizardPage

public WcmSecurityWizardPage getSecurityWizardPage()
Get accessor returns WcmSecurityWizardPage

Returns:
WcmSecurityWizardPage

getFileSelectWizardPage

public WcmFileSelectWizardPage getFileSelectWizardPage()
Get accessor returns WcmFileSelectWizardPage

Returns:
WcmFileSelectWizardPage

cleanup

public void cleanup()
             throws java.lang.Exception
Clean it up

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

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

Overrides:
getAnchor in class WcmWizardModule
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


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