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

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

public class WcmMultiValueParameterSelect
extends WcmWorkplaceLayoutModule


Field Summary
static java.lang.String TYPE_ATTACHMENTS
           
static java.lang.String TYPE_FIELDS
           
 
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
WcmMultiValueParameterSelect()
           
 
Method Summary
 java.util.ArrayList getAvailableParameters()
          Returns the available parameters
 java.util.ArrayList getCurrentParameters()
          Returns the current parameters
 java.lang.String getFormName()
          Returns the form name used by WcmMultiValueParameterSelect.
 java.lang.String getParameterType()
          Returns the parameter type
 java.lang.String getStepName()
          Returns the current step name.
 void initialize()
          Initialize this UI module.
 void onAccept(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Save changes to XML document.
 void onAdd(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add a selected parameter to the current step list.
 void onAddAll(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add all the selected parameters to the current step list.
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Cancel any changes and return to the previous page.
 void onRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Remove a selected parameter from the current step list.
 void onRemoveAll(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Remove all the selected parameters to the current step list.
 
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, render, 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
onStartPage, 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.WcmUiModuleInterface
onStartPage
 
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

TYPE_FIELDS

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

TYPE_ATTACHMENTS

public static final java.lang.String TYPE_ATTACHMENTS
See Also:
Constant Field Values
Constructor Detail

WcmMultiValueParameterSelect

public WcmMultiValueParameterSelect()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initialize this UI module.

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

onAdd

public void onAdd(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.lang.Exception
Add a selected parameter to the current step list.

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

onAddAll

public void onAddAll(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Add all the selected parameters to the current step list.

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

onRemove

public void onRemove(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Remove a selected parameter from the current step list.

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

onRemoveAll

public void onRemoveAll(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Remove all the selected parameters to the current step list.

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

onAccept

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

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

getStepName

public java.lang.String getStepName()
Returns the current step name.

Returns:
The step name.

getAvailableParameters

public java.util.ArrayList getAvailableParameters()
                                           throws java.lang.Exception
Returns the available parameters

Returns:
The list.
Throws:
java.lang.Exception

getParameterType

public java.lang.String getParameterType()
                                  throws java.lang.Exception
Returns the parameter type

Returns:
The list.
Throws:
java.lang.Exception

getCurrentParameters

public java.util.ArrayList getCurrentParameters()
                                         throws java.lang.Exception
Returns the current parameters

Returns:
The list.
Throws:
java.lang.Exception

getFormName

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

Returns:
The form name, returns null if no form is used.


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