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

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.PrefRegisterPortletsInfoPage
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 PrefRegisterPortletsInfoPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

Site Preferences Register Portlets info page.


Field Summary
protected  WcmWorkplaceConfig config
           
static java.lang.String ELEM_PORTLET
           
static java.lang.String ELEM_PORTLETS
           
protected  WcmItemsListView portletsListView
           
protected  java.util.List registerPortletsList
           
protected  java.lang.String returnUrl
           
protected  WcmSitePrefs sitePrefs
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PrefRegisterPortletsInfoPage()
           
 
Method Summary
 java.lang.String getFormName()
           
protected  java.lang.String getThisPageURL()
          return this page event URL with page id.
 void initialize()
          This method create a new registered portlets list if list is empty.
protected  void initList(com.filenet.wcm.toolkit.server.util.WcmDataStore ds)
           
 boolean isApplyButtonRequired()
          Need apply button in this case.
 boolean isModified()
          check to see if contents is modified.
 void onAdd(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler for the Add command.
 void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that occurs when the user clicks Exit or Cancel.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures the pages required for the Wizard.
 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.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Panel save event handler.
 void render(java.io.Writer w)
          Render is called from UI jsp pages to render the specified UI module's content onto the page.
 
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

ELEM_PORTLET

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

ELEM_PORTLETS

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

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs

registerPortletsList

protected java.util.List registerPortletsList

returnUrl

protected java.lang.String returnUrl

portletsListView

protected WcmItemsListView portletsListView
Constructor Detail

PrefRegisterPortletsInfoPage

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

initialize

public void initialize()
                throws java.lang.Exception
This method create a new registered portlets list if list is empty.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - If a data provider was not found.

initList

protected void initList(com.filenet.wcm.toolkit.server.util.WcmDataStore ds)
                 throws java.lang.Exception
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 Java™Server Pages (JSP) request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Configures the pages required for the Wizard. setup portletsListView reuired parameters and insert add command to parent moudle.

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Render is called from UI jsp pages to render the specified UI module's content onto the page.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - A Writer instance where the HTML will be written.
Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()
Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

onAdd

public void onAdd(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.lang.Exception
Event handler for the Add command.

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.

onCancel

public void onCancel(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event that occurs when the user clicks Exit or Cancel.

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

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

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

isModified

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

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
true if contents is modified, false otherwise.

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

getThisPageURL

protected java.lang.String getThisPageURL()
                                   throws java.lang.Exception
return this page event URL with page id.

Returns:
this page event URL with page id.
Throws:
java.lang.Exception


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