com.filenet.wcm.apps.server.ui.operation.select
Class MultiSelectOperation

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

public class MultiSelectOperation
extends WcmWorkplaceLayoutModule


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
static java.lang.String ALTERNATE_NAME_PROPERTY
           
protected  WcmAuthoringState authorState
           
protected  com.filenet.wcm.toolkit.server.base.WcmController controller
           
protected  org.w3c.dom.Document domTempSelectedObjects
           
protected  java.lang.String eventTargetName
           
protected  com.filenet.wcm.toolkit.util.WcmURLBuilder infoUrl
           
protected  SelectedObjectsListView itemsListView
           
protected  java.util.Locale locale
           
protected  java.lang.String objectsListKey
           
static java.lang.String PARAM_OBJECT_STORE_NAME
           
static java.lang.String PARAM_SELECTED_OBJECTS
           
protected  java.lang.String refreshUrl
           
protected  java.lang.String selectPageUrl
           
protected  com.filenet.wcm.toolkit.util.WcmURLBuilder selectUrl
           
protected  boolean showClearButton
           
protected  WcmTextLinksBar textLinksBarModule
           
protected  com.filenet.wcm.toolkit.util.WcmString wsNotSelected
           
protected static com.filenet.wcm.toolkit.util.WcmString wsTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsVersionInfo
           
 
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
NAME_DELIMITER
 
Constructor Summary
MultiSelectOperation()
          Create a new SelectObjectModule object for displaying the selected object returned from the select operation page.
 
Method Summary
protected  java.lang.String getIconUrl()
           
protected  java.lang.String getMimeType()
           
 void initialize()
          Initializes the wizard state and registers all pages.
 void onAccept(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse rewponse)
           
 void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse rewponse)
           
 void onClearObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the ClearObject event.
 void onDown(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse rewponse)
           
 void onRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onReplace(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse rewponse)
           
 void onSelectObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the SelectObject event.
 void onSelectReplacementObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the SelectReplacementObject event.
 void onSetObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the SetObject event.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse rewponse)
           
 void onUp(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse rewponse)
           
 void render(java.io.Writer w)
          Renders the SelectObjectModule in HTML.
 void setClearLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
          Sets the Clear link label
 void setEventTargetName(java.lang.String value)
          Set event target name.
 void setLabel(com.filenet.wcm.toolkit.util.WcmString label)
          Sets the Select Module label
 void setNotSelectedMessage(com.filenet.wcm.toolkit.util.WcmString newMessage)
           
 void setRefreshUrl(java.lang.String refreshUrl)
          Sets the refresh url
 void setSelectLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
          Sets the Select link label
 void setSelectPageUrl(java.lang.String url)
          Set the url to the select operation page.
 void setShowClearButton(boolean showClearButton)
          Sets to true to show the Clear Object link
 
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, getFormName, 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
 

Field Detail

wsTitle

protected static final com.filenet.wcm.toolkit.util.WcmString wsTitle

wsVersionInfo

protected static final com.filenet.wcm.toolkit.util.WcmString wsVersionInfo

wsNotSelected

protected com.filenet.wcm.toolkit.util.WcmString wsNotSelected

PARAM_SELECTED_OBJECTS

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

ALTERNATE_NAME_PROPERTY

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

adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

authorState

protected WcmAuthoringState authorState

textLinksBarModule

protected WcmTextLinksBar textLinksBarModule

controller

protected com.filenet.wcm.toolkit.server.base.WcmController controller

selectUrl

protected com.filenet.wcm.toolkit.util.WcmURLBuilder selectUrl

infoUrl

protected com.filenet.wcm.toolkit.util.WcmURLBuilder infoUrl

itemsListView

protected SelectedObjectsListView itemsListView

domTempSelectedObjects

protected org.w3c.dom.Document domTempSelectedObjects

showClearButton

protected boolean showClearButton

eventTargetName

protected java.lang.String eventTargetName

objectsListKey

protected java.lang.String objectsListKey

refreshUrl

protected java.lang.String refreshUrl

selectPageUrl

protected java.lang.String selectPageUrl

PARAM_OBJECT_STORE_NAME

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

locale

protected java.util.Locale locale
Constructor Detail

MultiSelectOperation

public MultiSelectOperation()
Create a new SelectObjectModule object for displaying the selected object returned from the select operation page.

Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the wizard state and registers all pages.

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

onStartPage

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

onSubmit

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

onCancel

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

onAccept

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the SelectObjectModule in HTML.

Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

onUp

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

onDown

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

onReplace

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

onSelectReplacementObject

public void onSelectReplacementObject(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws java.lang.Exception
Handles the SelectReplacementObject event.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onRemove

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

onSelectObject

public void onSelectObject(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Handles the SelectObject event.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onSetObject

public void onSetObject(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles the SetObject event.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onClearObject

public void onClearObject(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Handles the ClearObject event.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

setLabel

public void setLabel(com.filenet.wcm.toolkit.util.WcmString label)
Sets the Select Module label

Parameters:
label - WcmString The Select Module label. The default is set to "Selected Object"

setSelectLinkLabel

public void setSelectLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
Sets the Select link label

Parameters:
label - WcmString The Select link label. The default is set to "Select Object"

setClearLinkLabel

public void setClearLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
Sets the Clear link label

Parameters:
label - WcmString The Clear link label. The default is set to "Clear Object"

setShowClearButton

public void setShowClearButton(boolean showClearButton)
Sets to true to show the Clear Object link

Parameters:
showClearButton - boolean True to show the Clear Object link.

setRefreshUrl

public void setRefreshUrl(java.lang.String refreshUrl)
                   throws java.lang.Exception
Sets the refresh url

Parameters:
refreshUrl - String the refresl url
Throws:
java.lang.Exception

setEventTargetName

public void setEventTargetName(java.lang.String value)
Set event target name.

Parameters:
value - Event target name

setNotSelectedMessage

public void setNotSelectedMessage(com.filenet.wcm.toolkit.util.WcmString newMessage)

setSelectPageUrl

public void setSelectPageUrl(java.lang.String url)
Set the url to the select operation page. The default value is the url to the select object opeartion page

Parameters:
url - String url to the select operation page.

getIconUrl

protected java.lang.String getIconUrl()

getMimeType

protected java.lang.String getMimeType()


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