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

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
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
PortalPagePreviewModule

public class PortalModule
extends com.filenet.wcm.toolkit.server.base.WcmUiModule

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


Field Summary
protected  WcmWorkplaceConfig config
           
protected  PrefPortalPage currentPage
           
protected  java.util.List groupPageList
           
protected  java.util.List homePagePortletsList
           
protected  PrefsHomePageSettings homePageSettings
           
protected  java.lang.String mode
           
protected  boolean noModules
           
protected  int nSelectedTab
           
protected  java.util.List portalPages
           
protected  java.util.List registeredPortletsList
           
protected  java.util.List sitePages
           
protected  WcmSitePrefs sitePrefs
           
protected  com.filenet.wcm.toolkit.server.ui.WcmAnchorTree treeModule
           
protected  WcmUserPrefs userPrefs
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PortalModule()
           
 
Method Summary
protected  void addSitePrefPages()
          Adds all pages defined in site prefs that this user has access to.
protected  boolean compareTwoList(java.util.List source, java.util.List target)
           
protected  boolean compareTwoPage(PrefPortalPage sourcePage, PrefPortalPage targetPage)
           
 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.
 java.lang.String constructURL(PrefsHomePagePortlet p, java.lang.String inUrl)
          construct a URL with portlet id embedded.
protected  PrefPortalPage findPageInList(java.util.List source, java.lang.String id)
           
 PrefsRegisteredPortlet findSitePortlet(java.util.List searchList, java.lang.String id)
          Find portlet in site registered portlets list.
 PrefsHomePagePortlet findUserPortlet(java.util.List searchList, java.lang.String id)
          Find portlet in user registered portlets list.
 java.util.List getHomePagePortlets()
          return user's home page portlets list, used in JSP
 java.util.List getHomePagePortlets(java.lang.String placement)
          return home page portlets list in specific placement, used in JSP.
 PrefsHomePageSettings getHomePageSettings()
          return the home page settings.
 java.lang.String getMode()
           
 java.lang.String getModuleName()
          return module name, used in jsp.
 java.util.List getRegisteredPortlets()
          return site prefs registered portlets list, used in jsp
 void initialize()
          Initializes module variables.
protected  void integretyCheck(java.util.List groupPageList, java.lang.String id)
           
 void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
          global event handler.
 void onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
           
 void onSelectTab(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles user selection of General Tools or Advanced Tools option.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures the pages required for the different modes.
 void render(java.io.Writer w)
          Renders its content based on selected option: General or Advanced.
 void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
          Setup an external tree if pass in.
 
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

treeModule

protected com.filenet.wcm.toolkit.server.ui.WcmAnchorTree treeModule

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs

userPrefs

protected WcmUserPrefs userPrefs

portalPages

protected java.util.List portalPages

currentPage

protected PrefPortalPage currentPage

homePageSettings

protected PrefsHomePageSettings homePageSettings

homePagePortletsList

protected java.util.List homePagePortletsList

registeredPortletsList

protected java.util.List registeredPortletsList

groupPageList

protected java.util.List groupPageList

sitePages

protected java.util.List sitePages

nSelectedTab

protected int nSelectedTab

noModules

protected boolean noModules

mode

protected java.lang.String mode
Constructor Detail

PortalModule

public PortalModule()
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.

Throws:
java.lang.Exception

onReset

public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
             throws java.lang.Exception
global event handler. indicates that user clicked their Home Link so this page needs to be reset to the top level and state information cleared.

Parameters:
evt - - GlobalEven handler
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.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

getMode

public java.lang.String getMode()

addSitePrefPages

protected void addSitePrefPages()
                         throws java.lang.Exception
Adds all pages defined in site prefs that this user has access to.

Throws:
java.lang.Exception

integretyCheck

protected void integretyCheck(java.util.List groupPageList,
                              java.lang.String id)
                       throws java.lang.Exception
Throws:
java.lang.Exception

compareTwoList

protected boolean compareTwoList(java.util.List source,
                                 java.util.List target)
                          throws java.lang.Exception
Throws:
java.lang.Exception

findPageInList

protected PrefPortalPage findPageInList(java.util.List source,
                                        java.lang.String id)

compareTwoPage

protected boolean compareTwoPage(PrefPortalPage sourcePage,
                                 PrefPortalPage targetPage)
                          throws java.lang.Exception
Throws:
java.lang.Exception

onSelectTab

public void onSelectTab(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles user selection of General Tools or Advanced Tools option.

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

onSelectTab

public void onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
                 throws java.lang.Exception
Throws:
java.lang.Exception

setTree

public void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
Setup an external tree if pass in.

Parameters:
tree -

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders its content based on selected option: General or Advanced.

Parameters:
w - Output device.
Throws:
java.lang.Exception - If there are problems with retrieving data or with an invalid parameter.

getHomePagePortlets

public java.util.List getHomePagePortlets()
return user's home page portlets list, used in JSP


getHomePagePortlets

public java.util.List getHomePagePortlets(java.lang.String placement)
return home page portlets list in specific placement, used in JSP.

Parameters:
placement - (1 - left, 2 - right)
Returns:

getRegisteredPortlets

public java.util.List getRegisteredPortlets()
return site prefs registered portlets list, used in jsp


getModuleName

public java.lang.String getModuleName()
return module name, used in jsp.


getHomePageSettings

public PrefsHomePageSettings getHomePageSettings()
return the home page settings. this defined the layout of the page and the width of each column, used in jsp


findSitePortlet

public PrefsRegisteredPortlet findSitePortlet(java.util.List searchList,
                                              java.lang.String id)
Find portlet in site registered portlets list.

Parameters:
searchList - site registered portlets list
id - portelt id.
Returns:
PrefsRegisteredPortlet if found, null otherwise.

findUserPortlet

public PrefsHomePagePortlet findUserPortlet(java.util.List searchList,
                                            java.lang.String id)
Find portlet in user registered portlets list.

Parameters:
searchList - user registered portlets list
id - portelt id.
Returns:
PrefsRegisteredPortlet if found, null otherwise.

constructURL

public java.lang.String constructURL(PrefsHomePagePortlet p,
                                     java.lang.String inUrl)
construct a URL with portlet id embedded.

Parameters:
p - - portlet
inUrl - - URL
Returns:
constructed URL with portlet id embedded to configure controller.

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.

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


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