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

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.WcmMultiPanelModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
                          extended bycom.filenet.wcm.apps.server.ui.WcmInfoModule
                              extended bycom.filenet.wcm.apps.server.ui.info.prefs.PrefUserInfo
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class PrefUserInfo
extends WcmInfoModule

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


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmInfoModule
actionButtons, bannerModule, collapseInstructions, config, displayDefaultButtons, footerLinksBarModule, footerModule, HideApplyButton, instructionsModule, instructionsText, isPrimaryTitle, layout, pathModule, renderBannerModule, renderFooterLinksBarModule, renderFooterModule, renderTopTabBarModule, renderTreeView, sitePrefs, sObjectTypeLabel, textLinksBarModule, titleBarModule, topTabBarModule, treeModule, viewsNode, wsClickApply, wsClickSelectProperties
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
modified, MODIFIED_FLAGS_KEY
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
currentModule, currentPanel, currentPanelNumber, panelList
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PrefUserInfo()
           
 
Method Summary
protected  void addApplyButton()
           
protected  void configureTreeView()
          Overwrite this method in your subclass
 void initialize()
          Initializes the class data
 void onApply(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onExit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the onExit event.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void selectPanel(int panelNumber)
          Does the work of onSelectTab.
 void setInstructionText(java.lang.String instruction)
          Return instruction object This allow child module of this to dynamically set up instruction area.
 void setValid(boolean newValue)
           
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmInfoModule
addActionButton, addActionButton, addActionButtons, addDefaultButtons, addFooterModules, addPanelSelectionAnchor, addSelectPropertiesButton, addTabBar, configRootViewsNode, getDefaultInstructionsMode, getPathView, onCollapse, onExpand, render, setCurrentPanelSelection, setDefaultInstructionsMode, setDisplayDefaultButtons, setExitLinkText, setHideApplyButton, setInstructionsText, setInstructionsText, setMultiPanelModuleTitle, setMultiPanelModuleTitle, setPath, setPath, setPath, setRenderBannerModule, setRenderFooterLinksBarModule, setRenderFooterModule, setRenderTopTabBarModule, setRenderTreeView, setRootNodeLabel, setTopTabBarLinks
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
getCurrentViewPanel, isPanelModified, selectPanel, setPanelModified
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
addPanel, addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onSelectPanel, setMultiPanelModuleTitle, setMultiPanelModuleTitle
 
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
 

Constructor Detail

PrefUserInfo

public PrefUserInfo()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Description copied from class: WcmInfoModule
Initializes the class data

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmInfoModule
Throws:
java.lang.Exception - If there were problems.

selectPanel

public void selectPanel(int panelNumber)
                 throws java.lang.Exception
Does the work of onSelectTab. Can be called from outside as well.

Parameters:
panelNumber - Value representing the zero-based index of the panel to select.
Throws:
java.lang.Exception - All Exceptions.

addApplyButton

protected void addApplyButton()
                       throws java.lang.Exception
Overrides:
addApplyButton in class WcmInfoModule
Throws:
java.lang.Exception

onExit

public void onExit(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Handles the onExit event. When extending this method, call super.onExit() in the end.

Parameters:
request - HttpServletRequest object.
response - HttpServletResponse object.
Throws:
java.lang.Exception - All Exceptions.

onApply

public void onApply(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Throws:
java.lang.Exception

onStartPage

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

configureTreeView

protected void configureTreeView()
                          throws java.lang.Exception
Description copied from class: WcmInfoModule
Overwrite this method in your subclass

Overrides:
configureTreeView in class WcmInfoModule
Throws:
java.lang.Exception

setInstructionText

public void setInstructionText(java.lang.String instruction)
Return instruction object This allow child module of this to dynamically set up instruction area.


setValid

public void setValid(boolean newValue)


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