com.filenet.wcm.apps.server.ui.wizard.webcontent
Class WebContentEntryDesignerFolderWizardPage

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.webcontent.WebContentEntryDesignerFolderWizardPage
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
Direct Known Subclasses:
WebContentEntryFolderWizardPage

public class WebContentEntryDesignerFolderWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

This module displays the Folder hierarchy to allow the user to select the folder where they want the object being created to be placed.

See Also:
WcmObjectStoreNavigation

Field Summary
static int ADD_MODE
           
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider authoringDataProvider
           
protected  WcmAuthoringState authState
           
static int DELETE_MODE
           
protected  BrowseListView listView
           
static int MODIFY_MODE
           
protected  com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider navigationDataProvider
           
protected  WcmNavigationState navState
           
protected  int nMode
           
protected  WebContentSiteNavigation siteNavigation
           
protected  java.lang.String subFolderBrowsing
           
protected  com.filenet.wcm.toolkit.server.dp.WebContentDataProvider wcdp
           
protected  java.lang.String wcmType
           
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.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WebContentEntryDesignerFolderWizardPage(int mode, java.lang.String type)
          Constructor sets the operation type to one of the static int values defined above.
 
Method Summary
 void cleanup()
          Clean up
 BrowseListView getContainerContentsListView()
          Get accessor returns BrowseListView
 WcmEditPage getEditPage()
          Get accessor returns WcmEditPage
 WebContentSiteNavigation getFolderNavigation()
          Get accessor returns WebContentSiteNavigation
 java.lang.String getFormName()
          Returns the form name to allow external links to submit it.
 WebContentSiteNavigation getsiteNavigation()
          Get accessor returns WebContentSiteNavigation
 java.util.Iterator getValidationErrors()
           
 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)
           
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Clears state information.
 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 folder navigation hierarchy.
 
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

ADD_MODE

public static final int ADD_MODE
See Also:
Constant Field Values

MODIFY_MODE

public static final int MODIFY_MODE
See Also:
Constant Field Values

DELETE_MODE

public static final int DELETE_MODE
See Also:
Constant Field Values

authoringDataProvider

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider authoringDataProvider

navigationDataProvider

protected com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider navigationDataProvider

wcdp

protected com.filenet.wcm.toolkit.server.dp.WebContentDataProvider wcdp

authState

protected WcmAuthoringState authState

navState

protected WcmNavigationState navState

siteNavigation

protected WebContentSiteNavigation siteNavigation

listView

protected BrowseListView listView

subFolderBrowsing

protected java.lang.String subFolderBrowsing

nMode

protected int nMode

wcmType

protected java.lang.String wcmType
Constructor Detail

WebContentEntryDesignerFolderWizardPage

public WebContentEntryDesignerFolderWizardPage(int mode,
                                               java.lang.String type)
                                        throws java.lang.Exception
Constructor sets the operation type to one of the static int values defined above.

Parameters:
mode - One of the defined int field types.
Method Detail

getsiteNavigation

public WebContentSiteNavigation getsiteNavigation()
                                           throws java.lang.Exception
Get accessor returns WebContentSiteNavigation

Returns:
WebContentSiteNavigation
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the folder navigation hierarchy.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer object to write to.
Throws:
java.lang.Exception

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
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Throws:
java.lang.Exception

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
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
Throws:
java.lang.Exception

getValidationErrors

public java.util.Iterator getValidationErrors()
Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

getFormName

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

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

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
Returns:
boolean indicating if the input is complete.
Throws:
java.lang.Exception

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Clears state information.

Specified by:
panelCancel in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
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
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
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

cleanup

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

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

getFolderNavigation

public WebContentSiteNavigation getFolderNavigation()
                                             throws java.lang.Exception
Get accessor returns WebContentSiteNavigation

Returns:
WebContentSiteNavigation
Throws:
java.lang.Exception

getEditPage

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

Returns:
WcmEditPage
Throws:
java.lang.Exception

getContainerContentsListView

public BrowseListView getContainerContentsListView()
                                            throws java.lang.Exception
Get accessor returns BrowseListView

Returns:
BrowseListView
Throws:
java.lang.Exception


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