com.filenet.wcm.apps.server.ui.info.prefs
Class PrefPortalInfo

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.info.prefs.PrefPortalInfo
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

public class PrefPortalInfo
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

This is the main info class for site preferences, serving as a container class for the various preference information pages.


Field Summary
protected static java.lang.String DESIGN_GROUP_PAGE_PREFS
           
static java.lang.String PAGE_ID
           
protected  PrefPortalPagesInfo pageManager
           
protected static java.lang.String REGISTER_PORTLETS_PREFS
           
protected  PrefRegisterPortletsInfoPage registerPortlets
           
protected static java.lang.String SELECTED_TAB_KEY
           
protected  java.lang.String selectedTab
           
protected  WcmTreeView treeModule
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PrefPortalInfo()
           
 
Method Summary
 void configureTree(int panelNumber)
          Setup tree module with sub-modules tabs and selected one.
 java.lang.String getFormName()
          Returns form name.
 void initialize()
           
 boolean isApplyButtonRequired()
          Need apply button in this case.
 boolean isModified()
          Returns true if the information displayed by this panel was modifies by user
 void onSelectTab(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Sets initial values for rendering of one of the main options (Object Stores, My Shortcuts, Site Shortcuts)
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Retrieve tree module from parent moudule and configure it.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Panel finish event handler.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Panel save event handler.
 void render(java.io.Writer w)
           
 void setTree(WcmTreeView treeModule)
           
 
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

PAGE_ID

public static final java.lang.String PAGE_ID
See Also:
Constant Field Values

SELECTED_TAB_KEY

protected static final java.lang.String SELECTED_TAB_KEY
See Also:
Constant Field Values

REGISTER_PORTLETS_PREFS

protected static final java.lang.String REGISTER_PORTLETS_PREFS
See Also:
Constant Field Values

DESIGN_GROUP_PAGE_PREFS

protected static final java.lang.String DESIGN_GROUP_PAGE_PREFS
See Also:
Constant Field Values

registerPortlets

protected PrefRegisterPortletsInfoPage registerPortlets

pageManager

protected PrefPortalPagesInfo pageManager

selectedTab

protected java.lang.String selectedTab

treeModule

protected WcmTreeView treeModule
Constructor Detail

PrefPortalInfo

public PrefPortalInfo()
               throws java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
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
Retrieve tree module from parent moudule and configure it.

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

setTree

public void setTree(WcmTreeView treeModule)

configureTree

public void configureTree(int panelNumber)
                   throws java.lang.Exception
Setup tree module with sub-modules tabs and selected one.

Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()
Returns form name. Base behavior returns null.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Returns:
The String value of the form name or null.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Throws:
java.lang.Exception

onSelectTab

public void onSelectTab(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Sets initial values for rendering of one of the main options (Object Stores, My Shortcuts, Site Shortcuts)

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.

panelFinish

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

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Panel save event handler. Taking care of it in panelFinish

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception

isModified

public boolean isModified()
                   throws java.lang.Exception
Returns true if the information displayed by this panel was modifies by user

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
Throws:
java.lang.Exception

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Need apply button in this case.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
- always return true.
Throws:
java.lang.Exception


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