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

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

public class WcmEntryDesignerFolderWizardPage
extends WcmFolderSelectionWizardPage


Field Summary
protected  java.lang.String sMode
           
protected  java.lang.String subFolderBrowsing
           
protected  int type
           
protected  com.filenet.wcm.toolkit.util.WcmString wsBrowseMsg
           
protected  com.filenet.wcm.toolkit.util.WcmString wsDisplay
           
protected  com.filenet.wcm.toolkit.util.WcmString wsHideMsg
           
protected  com.filenet.wcm.toolkit.util.WcmString wsShowMsg
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.wizard.WcmFolderSelectionWizardPage
requireFolderSelection
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmEntryDesignerFolderWizardPage()
          Constructor calls base class constructor, then creates the required pages.
WcmEntryDesignerFolderWizardPage(int mode)
          Constructor calls base class constructor, then creates the required pages.
 
Method Summary
 void cleanup()
          Clean up
 WcmEditPage getEditPage()
          Get accessor returns WcmEditPage
 java.lang.String getFormName()
          Returns the form name to allow external links to submit it.
 void initialize()
          Initializes data providers, XSL parameters, the authoring state, and other state values.
 boolean isFinished()
          Indicates if the input is complete.
 void onPick(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler, This method use Chain of Responsibility pattern to route form data to related module.
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initialize the Classes
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Normally not called directly since this page should never show the Finish button.
 void panelInit()
          Called when this wizard page is first loaded to clear out any residual state information.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called to save the state of the page.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void render(java.io.Writer w)
          Renders the class data.
 void setMode(java.lang.String mode)
          Set moudle mode
 
Methods inherited from class com.filenet.wcm.apps.server.ui.wizard.WcmFolderSelectionWizardPage
getContainerContentsListView, getFolderNavigation, getValidationErrors, isRequireFolderSelection, panelCancel, setFolderNavigation, setRenderActionLinks
 
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

wsDisplay

protected com.filenet.wcm.toolkit.util.WcmString wsDisplay

wsHideMsg

protected com.filenet.wcm.toolkit.util.WcmString wsHideMsg

wsShowMsg

protected com.filenet.wcm.toolkit.util.WcmString wsShowMsg

wsBrowseMsg

protected com.filenet.wcm.toolkit.util.WcmString wsBrowseMsg

type

protected int type

sMode

protected java.lang.String sMode

subFolderBrowsing

protected java.lang.String subFolderBrowsing
Constructor Detail

WcmEntryDesignerFolderWizardPage

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


WcmEntryDesignerFolderWizardPage

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

Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes data providers, XSL parameters, the authoring state, and other state values.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmFolderSelectionWizardPage
Throws:
java.lang.Exception

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 WcmFolderSelectionWizardPage
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
render in class WcmFolderSelectionWizardPage
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

onPick

public void onPick(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Select event handler, This method use Chain of Responsibility pattern to route form data to related module.

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

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Select event handler. This method use Chain of Responsibility pattern to route form data to related module.

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

panelInit

public void panelInit()
               throws java.lang.Exception
Called when this wizard page is first loaded to clear out any residual state information.

Specified by:
panelInit in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Overrides:
panelInit in class WcmFolderSelectionWizardPage
Throws:
java.lang.Exception

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Called to save the state of the page. It calls wizardFinish to set the Authoring state using the chosen folder.

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

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Normally not called directly since this page should never show the Finish button. The wizardSave method forwards save requests here where it sets the Authoring state using the chosen folder.

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

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Called on a page to check any entered data to confirm that everything is valid.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Overrides:
panelValidate in class WcmFolderSelectionWizardPage
Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()
Returns the form name to allow external links to submit it.


isFinished

public boolean isFinished()
                   throws java.lang.Exception
Indicates if the input is complete. If a folder is selected, returns true. If an object store is selected and a folder is being added, returns true. Returns false otherwise.

Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Overrides:
isFinished in class WcmFolderSelectionWizardPage
Returns:
boolean indicating if the input is complete.
Throws:
java.lang.Exception

getEditPage

public WcmEditPage getEditPage()
                        throws java.lang.Exception
Get accessor returns WcmEditPage

Returns:
WcmEditPage
Throws:
java.lang.Exception

setMode

public void setMode(java.lang.String mode)
Set moudle mode

Parameters:
mode - - Modify or Add

cleanup

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

Specified by:
cleanup in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
cleanup in class WcmFolderSelectionWizardPage
Throws:
java.lang.Exception


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