com.filenet.wcm.apps.server.ui.list
Class TaskAttachmentsListView

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.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.presentation.ui.GenericListView
                          extended bycom.filenet.wcm.apps.server.presentation.ui.ItemsListView
                              extended bycom.filenet.wcm.apps.server.ui.WcmItemsListView
                                  extended bycom.filenet.wcm.apps.server.ui.list.TaskAttachmentsListView
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class TaskAttachmentsListView
extends WcmItemsListView

Displays the list of attachments of a workflow item. The attachments may be documents, folders, or stored searches.


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmItemsListView
config, contextMenuHelper, contextMenuVersionSeriesMode, showPageSizeDropDown, showReleaseOnly, sitePrefs
 
Fields inherited from class com.filenet.wcm.apps.server.presentation.ui.ItemsListView
KEY_COLUMN, KEY_DIRECTION, sortEvent
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
TaskAttachmentsListView(java.lang.String formName)
          Constructor
 
Method Summary
 com.filenet.wcm.toolkit.server.util.WcmEProcessUtil getEProcessUtil()
          Accessor method to return the WcmEProcessUtil object.
 void initialize()
          Initializes the class data.
 void onRefresh(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set the Refresh flag to cause the list view data to be re-retrieved.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Makes calls to the data provider to gather data required for rendering.
 void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent globalEvent)
          The state just changed on an attachment item, don't know which one, reload the attachments item data.
 void render(java.io.Writer w)
          Renders the class data.
 void selectAttachment(java.lang.String mode, java.lang.String attachmentName)
          Helper method that retrieves the attachment items for the selected attachment if expanding.
 void setAddFormTemplateLinkURL(java.lang.String url)
          Helper method that sets the Add New using Form Template Link URL parameter in the XSL file.
 void setAddTemplateLinkURL(java.lang.String url)
          Helper method that sets the Add New using Entry Template Link URL parameter in the XSL file.
 void setAssignExternalLinkURL(java.lang.String url)
          Helper method that sets the Assign External Link URL parameter in the XSL file.
 void setAssignLinkURL(java.lang.String url)
          Helper method that sets the Assign Link URL parameter in the XSL file.
 void setDocmentFormTemplateXML(org.w3c.dom.Document formTemplateXML)
          Helper method that sets the Replace item using Form Template Link URL parameter in the XSL file.
 void setRefresh(boolean refresh)
          Helper method the set the refresh flag.
 void setRemoveLinkURL(java.lang.String url)
          Helper method that sets the Remove Link URL parameter in the XSL file.
 void setReplaceFormTemplateLinkURL(java.lang.String url)
          Helper method that sets the Replace item using Form Template Link URL parameter in the XSL file.
 void setReplaceTemplateLinkURL(java.lang.String url)
          Helper method that sets the Add New and Replace item using Entry Template Link URL parameter in the XSL file.
 void setUnassignLinkURL(java.lang.String url)
          Helper method that sets the Unassign Link URL parameter in the XSL file.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmItemsListView
configListViewPrefs, configNameProperties, configNameProperties, configureContextMenu, configureDateFormat, getXSLTemplate, onPageSizeChange, onViewChange, setCustomObjectNameProperty, setDocumentNameProperty, setErrorMessage, setErrorMessage, setFolderNameProperty, setShowPageSizeDropDown, setShowReleaseOnly, setVersionSeriesMode
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.ItemsListView
configureDisplayNameUtil, getSortColumn, getSortOrder, onSort, setAddItemLinkUrl, setAvailablePageSizes, setColumnAlignments, setColumnAlignments, setColumnLabels, setColumnLabels, setCurrentPageURL, setDefaultPropertyFormatString, setDetailedView, setDisableViewFormatDropDown, setDisplayedProperties, setDisplayedProperties, setEnableSorting, setHideButtonsInInfo, setIncludeIdForGetContent, setInfoLinkMode, setMagazineViewDefaultProperty, setMagazineViewFormatString, setMimeIcons, setMode, setMultiSelectLinkHTML, setSelectLinkEventURL, setSelectLinkTitle, setSelectLinkURL, setSelectVersionLinkURL, setShowItemsFound, setShowRankingColumn, setShowSelectCurrentVersionLink, setShowSelectReleasedVersionLink, setShowStripesInMagazineView, setShowSummary, setShowSummaryViewOption, setShowViewFormatDropDown, setSortColumn, setSortOrder, setStateIcons, setVersionNumbers, setVersionStatusLabels, setVersionStatusLabels, sort
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.GenericListView
getCurrentPage, onPageChange, setCurrentPage, setFirstDisplayedItem, setItemsCount, setLastDisplayedItem, setNameProperty, setNoItemsText, setNotItemsTextString, setPageSize, setPagingLabel, setSelectedObjects
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
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, 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
 

Constructor Detail

TaskAttachmentsListView

public TaskAttachmentsListView(java.lang.String formName)
                        throws java.lang.Exception
Constructor

Parameters:
formName - String holding the html form name
Throws:
java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data. Initializes the XSL parameters for styling the list view in the appropriate way.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmItemsListView
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
Makes calls to the data provider to gather data required for rendering.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class WcmItemsListView
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.

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.

onRefresh

public void onRefresh(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Set the Refresh flag to cause the list view data to be re-retrieved.

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.

onStateChanged

public void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent globalEvent)
                    throws java.lang.Exception
The state just changed on an attachment item, don't know which one, reload the attachments item data.

Parameters:
globalEvent - GlobalEvent object.
Throws:
java.lang.Exception - If there are problems retrieving data.

selectAttachment

public void selectAttachment(java.lang.String mode,
                             java.lang.String attachmentName)
                      throws java.lang.Exception
Helper method that retrieves the attachment items for the selected attachment if expanding. Also, sets the isdisplayed bit in the attachmant list.

Parameters:
mode - String specifying whether to expand or collapse attachment list
attachmentName - String holding select attachment
Throws:
java.lang.Exception

setAssignLinkURL

public void setAssignLinkURL(java.lang.String url)
Helper method that sets the Assign Link URL parameter in the XSL file.

Parameters:
url - String specifying the Assign Link URL parameter.

setAssignExternalLinkURL

public void setAssignExternalLinkURL(java.lang.String url)
Helper method that sets the Assign External Link URL parameter in the XSL file.

Parameters:
url - String specifying the Assign Link URL parameter.

setUnassignLinkURL

public void setUnassignLinkURL(java.lang.String url)
Helper method that sets the Unassign Link URL parameter in the XSL file.

Parameters:
url - String specifying the Unassign Link URL parameter.

setRemoveLinkURL

public void setRemoveLinkURL(java.lang.String url)
Helper method that sets the Remove Link URL parameter in the XSL file.

Parameters:
url - String specifying the Remove Link URL parameter.

setAddTemplateLinkURL

public void setAddTemplateLinkURL(java.lang.String url)
Helper method that sets the Add New using Entry Template Link URL parameter in the XSL file.

Parameters:
url - String specifying the Add Link URL parameter.

setReplaceTemplateLinkURL

public void setReplaceTemplateLinkURL(java.lang.String url)
Helper method that sets the Add New and Replace item using Entry Template Link URL parameter in the XSL file.

Parameters:
url - String specifying the Add Link URL parameter.

setAddFormTemplateLinkURL

public void setAddFormTemplateLinkURL(java.lang.String url)
Helper method that sets the Add New using Form Template Link URL parameter in the XSL file.

Parameters:
url - String specifying the Add Link URL parameter.

setReplaceFormTemplateLinkURL

public void setReplaceFormTemplateLinkURL(java.lang.String url)
Helper method that sets the Replace item using Form Template Link URL parameter in the XSL file.

Parameters:
url - String specifying the Add Link URL parameter.

setDocmentFormTemplateXML

public void setDocmentFormTemplateXML(org.w3c.dom.Document formTemplateXML)
Helper method that sets the Replace item using Form Template Link URL parameter in the XSL file.

Parameters:
formTemplateXML - Document specifying the Document Form Template attachment XML.

setRefresh

public void setRefresh(boolean refresh)
Helper method the set the refresh flag.

Parameters:
refresh - Flag to indicate whether to re-retrieve the data from the data provider

getEProcessUtil

public com.filenet.wcm.toolkit.server.util.WcmEProcessUtil getEProcessUtil()
Accessor method to return the WcmEProcessUtil object.

Returns:
WcmEProcessUtil object.


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