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

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

User Preferences Register Portlets info page.


Field Summary
protected  WcmWorkplaceConfig config
           
protected static java.lang.String formName
           
protected  java.util.List homePagePortletsList
           
protected  PrefsHomePageSettings homePageSettings
           
protected  com.filenet.wcm.toolkit.server.ui.WcmXSLModule inputForm
           
protected  java.lang.String label
           
protected  PrefPortalPage page
           
static java.lang.String PLACEMENT_BOTTOM
           
static java.lang.String PLACEMENT_LEFT
           
static java.lang.String PLACEMENT_RIGHT
           
static java.lang.String PLACEMENT_TOP
           
protected  WcmItemsListView portletsListView
           
protected  boolean readonly
           
protected  java.util.List registerPortletsList
           
protected  java.lang.String returnUrl
           
protected  WcmSitePrefs sitePrefs
           
protected  WcmUserPrefs userPrefs
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PrefPortletsManagementInfoPage()
           
 
Method Summary
protected  void getColumnWidth(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          get the column width from request.
 java.lang.String getFormName()
          return form name back.
 java.util.List getHomePagePortletsList()
           
 PrefsHomePageSettings getHomePageSettings()
           
protected  int getLastPortletIndex(java.lang.String placement)
          Return last found portlet by placement.
protected  PrefsHomePagePortlet getPortletById(java.lang.String id)
          return portlet by id.
 void initialize()
          Initialized variables.
 boolean isApplyButtonRequired()
          We need apply button therefore always return true back
 boolean isModified()
          return true if contents is modified.
 void onAddToLayout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler for the Add command.
 void onChangeTitle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler for the changing title.
 void onLeftEdit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle left column edit event.
 void onLeftRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle left column remove event.
 void onLeftShuffleDown(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle left column shuffle down event.
 void onLeftShuffleUp(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle left column shuffle up event.
 void onMiddleMoveLeft(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          move selected portlet to left column.
 void onMiddleMoveRight(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          move selected portlet to right column.
 void onPageChange(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler for the changing title.
 void onRightEdit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle left column edit event.
 void onRightRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle right column remove event.
 void onRightShuffleDown(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle right column shuffle down event.
 void onRightShuffleUp(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          handle right column shuffle up event.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures listview and layout sections
 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)
          Save module data
 void render(java.io.Writer w)
          render module information.
 void setLabel(java.lang.String label)
           
 void setReadonly(boolean value)
           
 
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

PLACEMENT_LEFT

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

PLACEMENT_RIGHT

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

PLACEMENT_TOP

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

PLACEMENT_BOTTOM

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

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs

userPrefs

protected WcmUserPrefs userPrefs

registerPortletsList

protected java.util.List registerPortletsList

homePagePortletsList

protected java.util.List homePagePortletsList

returnUrl

protected java.lang.String returnUrl

label

protected java.lang.String label

readonly

protected boolean readonly

homePageSettings

protected PrefsHomePageSettings homePageSettings

page

protected PrefPortalPage page

formName

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

portletsListView

protected WcmItemsListView portletsListView

inputForm

protected com.filenet.wcm.toolkit.server.ui.WcmXSLModule inputForm
Constructor Detail

PrefPortletsManagementInfoPage

public PrefPortletsManagementInfoPage()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initialized variables.

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
Configures listview and layout sections

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 module information.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - writer
Throws:
java.lang.Exception

onLeftShuffleUp

public void onLeftShuffleUp(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
handle left column shuffle up event. This move selected portlet one position up.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onLeftShuffleDown

public void onLeftShuffleDown(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
handle left column shuffle down event. This move selected portlet one position down.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onLeftRemove

public void onLeftRemove(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
handle left column remove event. This remove selected portlet.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onLeftEdit

public void onLeftEdit(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
handle left column edit event. This change portlet title.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onRightShuffleUp

public void onRightShuffleUp(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
handle right column shuffle up event. This move selected portlet one position up.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onRightShuffleDown

public void onRightShuffleDown(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.lang.Exception
handle right column shuffle down event. This move selected portlet one position down.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onRightRemove

public void onRightRemove(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
handle right column remove event. This remove selected portlet.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onRightEdit

public void onRightEdit(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
handle left column edit event. This change portlet title.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onMiddleMoveLeft

public void onMiddleMoveLeft(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
move selected portlet to left column.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onMiddleMoveRight

public void onMiddleMoveRight(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
move selected portlet to right column.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

getPortletById

protected PrefsHomePagePortlet getPortletById(java.lang.String id)
return portlet by id.

Parameters:
id - portlet id
Returns:
Portket object if found, null otherwise

getLastPortletIndex

protected int getLastPortletIndex(java.lang.String placement)
Return last found portlet by placement.

Parameters:
placement -
Returns:
Portket object if found, null otherwise

getColumnWidth

protected void getColumnWidth(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
get the column width from request.

Parameters:
request -
response -
Throws:
java.lang.Exception

onAddToLayout

public void onAddToLayout(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.

onChangeTitle

public void onChangeTitle(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Event handler for the changing title.

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.

onPageChange

public void onPageChange(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Event handler for the changing title.

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.

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Save module data

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. Save data back to user preferences.

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

getHomePageSettings

public PrefsHomePageSettings getHomePageSettings()

getHomePagePortletsList

public java.util.List getHomePagePortletsList()

isModified

public boolean isModified()
return true if contents is modified.

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
We need apply button therefore always return true back

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

getFormName

public java.lang.String getFormName()
return form name back.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

setLabel

public void setLabel(java.lang.String label)

setReadonly

public void setReadonly(boolean value)


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