com.filenet.wcm.apps.server.ui.operation.prefs
Class PrefPortletSettingsOperation

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.WcmJSPModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmLayoutModule
                          extended bycom.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
                              extended bycom.filenet.wcm.apps.server.ui.operation.prefs.PrefPortletSettingsOperation
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class PrefPortletSettingsOperation
extends WcmWorkplaceLayoutModule

Site Preferences Register Portlets info page.


Nested Class Summary
protected  class PrefPortletSettingsOperation.PortletSettingsInfo
          UI module that display portlet settings
 
Field Summary
protected  WcmWorkplaceConfig config
           
protected  java.lang.String description
           
protected  java.lang.String eventUrl
           
protected  java.lang.String imageURL
           
protected  WcmTextLinksBar linksBar
           
protected  java.lang.String mode
           
protected  java.lang.String portletServlet
           
protected  PrefPortletSettingsOperation.PortletSettingsInfo portletSettings
           
protected  java.util.List registerPortletsList
           
protected  java.lang.String returnUrl
           
protected  PrefsRegisteredPortlet selectedPortlet
           
protected  WcmSitePrefs sitePrefs
           
protected  java.lang.String title
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
bannerModule, contextMenu, footerLinksBarModule, footerModule, leftCSSClass, MAIN_MODE, multiSelectMenu, OPERATION_MODE, renderLeftBar, showFooterLinksBar, tabBarModule, treeModule
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
jspMode, layout
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PrefPortletSettingsOperation()
           
 
Method Summary
protected  void addToSitePreference()
          Save portlet settings to registered portlet list.
 void initialize()
           
 boolean isApplyButtonRequired()
          Don't need apply button in this case.
 boolean isModified()
          check to see if contents is modified.
 void onAccept(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Validate and save the registered portlet entrys.
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Exit page
 void onUnregister(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Unregister portlet
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Panel finish event handler.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
addModule, addModule, addPrimaryPageAnchors, createLayout, getAnchorTree, getBannerBar, getFooter, getFooterLinksBar, getOperationTitle, getPageTabId, getPrimaryPageAnchors, getTabBar, isAdminLinkAvailable, registerAddedModules, renderLayout, resetPrimaryPageAnchors, setAddContextMenu, setMode, setOperationTitle, setOperationTitle, setOperationTitle, setOperationTitle, setRemoveTreeModule, setShowFooterLinksBar, setTabBarSelection
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
getLayout, render, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmJSPModule
getCurrentModule
 
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
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
onStartPage, 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.WcmUiModuleInterface
onStartPage
 
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

eventUrl

protected java.lang.String eventUrl

returnUrl

protected java.lang.String returnUrl

portletSettings

protected PrefPortletSettingsOperation.PortletSettingsInfo portletSettings

linksBar

protected WcmTextLinksBar linksBar

title

protected java.lang.String title

portletServlet

protected java.lang.String portletServlet

imageURL

protected java.lang.String imageURL

description

protected java.lang.String description

mode

protected java.lang.String mode

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs

registerPortletsList

protected java.util.List registerPortletsList

selectedPortlet

protected PrefsRegisteredPortlet selectedPortlet
Constructor Detail

PrefPortletSettingsOperation

public PrefPortletSettingsOperation()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmWorkplaceLayoutModule
Throws:
java.lang.Exception

onAccept

public void onAccept(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Validate and save the registered portlet entrys.

Parameters:
request - HttpServletRequest is the Java™Server Pages (JSP) request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - if any entries were incorrectly entered.

addToSitePreference

protected void addToSitePreference()
                            throws java.lang.Exception
Save portlet settings to registered portlet list.

Throws:
java.lang.Exception

onUnregister

public void onUnregister(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Unregister portlet

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

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Exit page

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

isModified

public boolean isModified()
check to see if contents is modified.

Returns:
true if contents is modified, false otherwise.

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Don't need apply button in this case.

Returns:
- always return false.
Throws:
java.lang.Exception

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Panel finish event handler.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception


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