com.filenet.wcm.apps.server.ui.select
Class WcmFieldSelect

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.select.WcmFieldSelect
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmFieldSelect
extends WcmWorkplaceLayoutModule

Displays the Data Field selection module. This module allows user to specify multi-value information for a Data Field that has type IsArray=true.


Field Summary
 
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
WcmFieldSelect()
          Constructor
 
Method Summary
 java.lang.String getFormName()
          Returns the form name.
 void initialize()
          Initializes the class data
 void onAccept(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Save form data to XML document.
 void onAdd(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add a new entry at the end of the field element table
 void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
          Handle Banner Close event
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Cancel any changes and return to the previous page.
 void onSelectRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handle the Select Remove event triggered by the user selecting the Remove Checkbox.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add the appropriate command Button to the toolbar.
 void render(java.io.Writer w)
          Renders the class data.
 void setIsModified(boolean modified)
          Set the modified state.
 
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, 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, 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
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

WcmFieldSelect

public WcmFieldSelect()
               throws java.lang.Exception
Constructor

Throws:
java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data

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

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Add the appropriate command Button to the toolbar.

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

getFormName

public java.lang.String getFormName()
Returns the form name.

Returns:
form name

onAdd

public void onAdd(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.lang.Exception
Add a new entry at the end of the field element table

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

onSelectRemove

public void onSelectRemove(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Handle the Select Remove event triggered by the user selecting the Remove Checkbox.

The selected grantee is marked for removal if it is not yet marked. Otherwise the selected grantee is restored back to modified state.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onAccept

public void onAccept(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Save form data to XML document.

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

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Cancel any changes and return to the previous page.

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

onBannerClose

public void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                   throws java.lang.Exception
Handle Banner Close event

Parameters:
e - GlobalEvent
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

setIsModified

public void setIsModified(boolean modified)
                   throws java.lang.Exception
Set the modified state. Checks to see if the state is currently modified. If the state is currently modified, nothing is set, otherwise the value is set to what is being passed in.

Parameters:
modified - boolean flag holding modified state
Throws:
java.lang.Exception - If there are problems.


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