com.filenet.wcm.apps.server.ui
Class PortalPagePreviewModule

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.PortalModule
                      extended bycom.filenet.wcm.apps.server.ui.PortalPagePreviewModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class PortalPagePreviewModule
extends PortalModule

This UI Module lets users add, checkin, cancel checkout, and publish documents, as well as create folders.


Field Summary
protected  java.lang.String groupId
           
protected  java.lang.String returnUrl
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.PortalModule
config, currentPage, groupPageList, homePagePortletsList, homePageSettings, mode, noModules, nSelectedTab, portalPages, registeredPortletsList, sitePages, sitePrefs, treeModule, userPrefs
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PortalPagePreviewModule()
           
 
Method Summary
 java.lang.String constructPortletURL(PrefsHomePagePortlet p, java.lang.String baseUrl, java.lang.String inUrl, java.lang.String mode)
          construct a full path url with portletUrl, controllerName, and mode embedded.
 void initialize()
          Initializes module variables.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures the pages required for the different modes.
 void setReturnUrl(java.lang.String returnUrl)
          This is specially done to deal with edit page needs to know where to to return.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.PortalModule
addSitePrefPages, compareTwoList, compareTwoPage, constructURL, findPageInList, findSitePortlet, findUserPortlet, getHomePagePortlets, getHomePagePortlets, getHomePageSettings, getMode, getModuleName, getRegisteredPortlets, integretyCheck, onReset, onSelectTab, onSelectTab, render, setTree
 
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, getFormName, 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

groupId

protected java.lang.String groupId

returnUrl

protected java.lang.String returnUrl
Constructor Detail

PortalPagePreviewModule

public PortalPagePreviewModule()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes module variables. Called by Controller during page initialization. State information will be filled by Controller's page parameter provided by selected object's JSP if it exists.

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

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Configures the pages required for the different modes.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class PortalModule
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

constructPortletURL

public java.lang.String constructPortletURL(PrefsHomePagePortlet p,
                                            java.lang.String baseUrl,
                                            java.lang.String inUrl,
                                            java.lang.String mode)
construct a full path url with portletUrl, controllerName, and mode embedded.

Overrides:
constructPortletURL in class PortalModule
Parameters:
p - - portlet
baseUrl - - base URL
inUrl - - Portlet URL location
mode - - mode of execution.
Returns:
constructed URL with portlet id embedded to configure controller.

setReturnUrl

public void setReturnUrl(java.lang.String returnUrl)
                  throws java.lang.Exception
This is specially done to deal with edit page needs to know where to to return. Default is return to homepage.jsp since preview and setup operation also let user to set perferences it needs to return to different location

Parameters:
returnUrl -
Throws:
java.lang.Exception


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