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

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

public class WcmPublishConfirmWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

This class is the second and last page of Publish Wizard. It displays selected operations and document information before user commits changes. WcmAuthoringState.publishType contains operation type, where value of 1 means republish source document and 2 means publish new document.


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmPublishConfirmWizardPage()
          Constructor initializes member variables.
 
Method Summary
 java.lang.String getFormName()
          This signals the wizard that there's a form embedded in the HTML; therefore, it will use different JavaScript to send form data back to the server.
 java.lang.String getSelectedTitle()
          Displays status line information on the bottom of screen.
 void initialize()
          Initializes module variables.
 boolean isFinished()
          Return "true" always since this is the last page of Publish wizard
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Catch submit information
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module that the user does not want to commit the current state to the underlying data store.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Gets document title from request's variable, publishDocName, packs it into XML format, and then sends it as an option parameter in call to WcmAuthoringDataProvider.doRepublish or WcmAuthoringDataProvider.setPublishingTemplate.
 void panelInit()
          Signals to the UI module that its wizard-specific behavior should be initialized (if any).
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module that the user wants to return to the previous page and that this module should use this event to save any persistant state.
 void render(java.io.Writer w)
          Renders publishing contents, including a text input field, publishDocName, for user to enter document title.
 
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
 

Constructor Detail

WcmPublishConfirmWizardPage

public WcmPublishConfirmWizardPage()
                            throws java.lang.Exception
Constructor initializes member variables.

Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes module variables. Call by Controller during page initialization

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelInit

public void panelInit()
               throws java.lang.Exception
Signals to the UI module that its wizard-specific behavior should be initialized (if any).

Specified by:
panelInit in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Signals the UI module that the user does not want to commit the current state to the underlying data store.

Specified by:
panelCancel in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Signals the UI module that the user wants to return to the previous page and that this module should use this event to save any persistant state.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Gets document title from request's variable, publishDocName, packs it into XML format, and then sends it as an option parameter in call to WcmAuthoringDataProvider.doRepublish or WcmAuthoringDataProvider.setPublishingTemplate.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onSubmit

public void onSubmit(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Catch submit information

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders publishing contents, including a text input field, publishDocName, for user to enter document title.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getSelectedTitle

public java.lang.String getSelectedTitle()
                                  throws java.lang.Exception
Displays status line information on the bottom of screen. It displays source doucument and selected object info. This method is called by Wizard in wizard mode.

Returns:
String status line
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

isFinished

public boolean isFinished()
Return "true" always since this is the last page of Publish wizard

Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

getFormName

public java.lang.String getFormName()
This signals the wizard that there's a form embedded in the HTML; therefore, it will use different JavaScript to send form data back to the server.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface


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