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

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.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.presentation.ui.GenericListView
                          extended bycom.filenet.wcm.apps.server.ui.WcmGenericListView
                              extended bycom.filenet.wcm.apps.server.ui.WcmNavigationListView
                                  extended bycom.filenet.wcm.apps.server.ui.WcmPathNavigation
                                      extended bycom.filenet.wcm.apps.server.ui.wizard.WcmUnfileWizardPage
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, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Direct Known Subclasses:
WcmMoveWizard.WcmMoveFromPage

public class WcmUnfileWizardPage
extends WcmPathNavigation
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

WcmUnfileWizardPage is used to perform the unfile operation, and the "move from" selection in the move operation.


Nested Class Summary
 class WcmUnfileWizardPage.WcmSpecialFolderContents
          Inner class that adds additional behavior to the class that it derives from.
 
Field Summary
static java.lang.String CURRENT_FOLDER_ID_KEY
          The module property key where the current selected folder ID is stored.
static java.lang.String CURRENT_FOLDER_NAME_KEY
          The module property key where the current selected folder name is stored.
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmNavigationListView
contextMenuHelper
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmGenericListView
config
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmUnfileWizardPage()
           
 
Method Summary
 java.lang.String getFormName()
           
 void initialize()
          Initializes module.
 boolean isApplyButtonRequired()
           
 boolean isFinished()
           
 boolean isModified()
           
 void onReset(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler to un-select any selected folder.
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler to select a folder.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The StartPage event handler.
 void onToggleContents(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler to show/hide the viewing of folder contents.
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void panelInit()
           
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void render(java.io.Writer w)
          Renders the class data.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmPathNavigation
getCommandBar, getPathView, setRenderNavigation, setRenderPath
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmNavigationListView
setColumns, setExtraURLParameters, setFormSubmitName, setMaxRows, setShowContextMenu, setShowNoItemsMessage, setTitle, setTitle
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmGenericListView
configNameProperties, configNameProperties, configNameProperties, configNameProperties, setCustomObjectNameProperty, setCustomObjectNameProperty, setDocumentNameProperty, setDocumentNameProperty, setFolderNameProperty, setFolderNameProperty
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.GenericListView
getCurrentPage, getXSLTemplate, onPageChange, setCurrentPage, setFirstDisplayedItem, setItemsCount, setLastDisplayedItem, setNameProperty, setNoItemsText, setNotItemsTextString, setPageSize, setPagingLabel, setSelectedObjects
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
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, 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.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

CURRENT_FOLDER_NAME_KEY

public static final java.lang.String CURRENT_FOLDER_NAME_KEY
The module property key where the current selected folder name is stored.

See Also:
Constant Field Values

CURRENT_FOLDER_ID_KEY

public static final java.lang.String CURRENT_FOLDER_ID_KEY
The module property key where the current selected folder ID is stored.

See Also:
Constant Field Values
Constructor Detail

WcmUnfileWizardPage

public WcmUnfileWizardPage()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Description copied from class: WcmPathNavigation
Initializes module. Does an addChild for the toolbar and pathView.

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

onToggleContents

public void onToggleContents(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
Event handler to show/hide the viewing of folder contents.

Parameters:
request - A reference to the HttpServletRequest.
response - A reference to the HttpServletResponse.
Throws:
java.lang.Exception

onReset

public void onReset(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Event handler to un-select any selected folder.

Parameters:
request - A reference to the HttpServletRequest.
response - A reference to the HttpServletResponse.
Throws:
java.lang.Exception

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event handler to select a folder.

Parameters:
request - A reference to the HttpServletRequest.
response - A reference to the HttpServletResponse.
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
The StartPage event handler. Performs final-pass initialization before rendering.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - A reference to the HttpServletRequest.
response - A reference to the HttpServletResponse.
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Description copied from class: WcmPathNavigation
Renders the class data.

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

panelFinish

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

panelInit

public void panelInit()
               throws java.lang.Exception
Specified by:
panelInit in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Throws:
java.lang.Exception

panelSave

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

panelCancel

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

isFinished

public boolean isFinished()
                   throws java.lang.Exception
Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()
Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Throws:
java.lang.Exception

isModified

public boolean isModified()
                   throws java.lang.Exception
Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Throws:
java.lang.Exception


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