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

Class WcmAddObjectWizard

  1. java.lang.Object
  2. extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
  3. extended bycom.filenet.wcm.toolkit.server.base.WcmModule
  4. extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
  5. extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
  6. extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
  7. extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
  8. extended bycom.filenet.wcm.apps.server.ui.WcmWizardModule
  9. extended bycom.filenet.wcm.apps.server.ui.wizard.WcmAddObjectWizard
All implemented interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
  1. public class WcmAddObjectWizard
  2. 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/interfaces 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

Constructor and Description
WcmAddObjectWizard()
Constructor calls base class constructor, then creates the required pages.

Method Summary

Modifier and Type Method and Description
  1. void
 cleanup()
Clean it up
  1. protected
  2. void
 configureSummary()
Writes the actual contents of the status bar.
  1. WcmFileSelectWizardPage
 getFileSelectWizardPage()
Get accessor returns WcmFileSelectWizardPage
  1. WcmFolderSelectionWizardPage
 getFolderSelectionWizardPage()
Get accessor returns WcmFolderSelectionWizardPage
  1. WcmPropertiesWizardPage
 getPropertiesWizardPage()
Get accessor returns WcmPropertiesWizardPage
  1. WcmSecurityWizardPage
 getSecurityWizardPage()
Get accessor returns WcmSecurityWizardPage
  1. void
 initialize()
This method queries for the Authoring and Navigation data providers, then adds each page to the wizard.
  1. void
 onCancel(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Called in response to a cancel wizard request.
  1. void
 onComplete(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
  1. void
 onFinish(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Called in response to a finish wizard request.
  1. void
 onFinishAddCustomObject(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
  1. void
 onFinishAddDocument(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
  1. void
 onFinishAddFolder(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
addPanel, addPanelSelectionAnchor, addSummaryItem, addSummaryItem, getAnchor, getAnchor, getFooter, getPageBanner, getSummaryModule, getTabBar, getTextLinksBar, isBackEnabled, isFinishEnabled, isNextEnabled, isPanelEnabled, okayToProceed, onSelectPanel, onStartPage, render, setCancelLinkText, setCurrentPanelSelection, setFinishLinkText, setIsFinished, 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

WcmAddObjectWizard

  1. public WcmAddObjectWizard()
  2. 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

  1. public void initialize()
  2. 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

  1. protected void configureSummary( )
  2. 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

  1. public void onCancel(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Called in response to a cancel wizard request. It releases module properties and calls the base class method.
Overrides:
onCancel in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception - if there were problems completing the operation.

onFinish

  1. public void onFinish(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Called in response to a finish wizard request. It releases module properties and calls the base class method.
Overrides:
onFinish in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception - if there were problems completing the operation.

onFinishAddDocument

  1. public void onFinishAddDocument( javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Throws:
java.lang.Exception

onFinishAddFolder

  1. public void onFinishAddFolder(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Throws:
java.lang.Exception

onFinishAddCustomObject

  1. public void onFinishAddCustomObject( javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Throws:
java.lang.Exception

onComplete

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

getFolderSelectionWizardPage

  1. public WcmFolderSelectionWizardPage getFolderSelectionWizardPage( )
Get accessor returns WcmFolderSelectionWizardPage
Returns:
WcmFolderSelectionWizardPage

getPropertiesWizardPage

  1. public WcmPropertiesWizardPage getPropertiesWizardPage( )
Get accessor returns WcmPropertiesWizardPage
Returns:
WcmPropertiesWizardPage

getSecurityWizardPage

  1. public WcmSecurityWizardPage getSecurityWizardPage( )
Get accessor returns WcmSecurityWizardPage
Returns:
WcmSecurityWizardPage

getFileSelectWizardPage

  1. public WcmFileSelectWizardPage getFileSelectWizardPage( )
Get accessor returns WcmFileSelectWizardPage
Returns:
WcmFileSelectWizardPage

cleanup

  1. public void cleanup()
  2. throws java.lang.Exception
Clean it up
Specified by:
cleanup in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
cleanup in class com.filenet.wcm.toolkit.server.base.WcmModule
Throws:
java.lang.Exception