com.filenet.wcm.apps.server.ui
Class WcmItemsListView

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
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
BrowseListView, ConvertListView, LinkListView, MultiSelectOperationListView, MultiTransferItemsListView, ParentDocumentsListView, PrefAuthorLinksInfoPage, PrefProcessDesignerInfoPage, PrefReferenceServicesInfoPage, SearchResultsListView, SearchTemplatePrintViewModule.SearchResultsPrintViewListView, SecurityPolicyListView, SelectedCategoriesListView, SelectedClassificationListView, SelectedObjectsListView, ShortcutListView, SimpleSearchPrintViewModule.SearchResultsPrintViewListView, SimpleSearchResultsListView, TaskAttachmentsListView, TasksListView, WcmAttachmentsListView, WcmFoldersFiledInInfoPage, WcmMilestonesListView, WcmSearchPrintViewContentsListView, WcmStepHistoryListView, WcmSubscriptionsListView, WcmTemplatesInfoPage, WcmVersionSeriesInfoPage, WcmWorkflowDefinitionsListView, WcmWorkflowLinksListView

public class WcmItemsListView
extends com.filenet.wcm.apps.server.presentation.ui.ItemsListView

List view that displays XML returned by Content Java API.


Field Summary
protected  WcmWorkplaceConfig config
           
protected  com.filenet.wcm.apps.server.presentation.util.ActionConfiguration contextMenuHelper
           
protected  boolean contextMenuVersionSeriesMode
           
protected  boolean showPageSizeDropDown
           
protected  boolean showReleaseOnly
           
protected  WcmSitePrefs 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
WcmItemsListView()
           
 
Method Summary
 WcmObjectStorePrefs configListViewPrefs(java.lang.String objectStoreName, boolean detailedView)
          Configures document, custom object and folder name properties, sets detailed/magazine view, sets the page size
 WcmObjectStorePrefs configNameProperties(java.lang.String objectStoreName)
           
 void configNameProperties(WcmObjectStorePrefs osp)
           
protected  void configureContextMenu()
           
protected  void configureDateFormat()
           
protected  java.lang.String getXSLTemplate()
          Return the XSL template to use for rendering this listview.
 void initialize()
           
 void onPageSizeChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onViewChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void setCustomObjectNameProperty(java.lang.String sSymbolicName)
          Sets the property to be used as a title for custom objects.
 void setDocumentNameProperty(java.lang.String sSymbolicName)
          Sets the property to be used as a title for document objects.
 void setErrorMessage(java.lang.String errorMessage)
           
 void setErrorMessage(com.filenet.wcm.toolkit.util.WcmString errorMessage)
           
 void setFolderNameProperty(java.lang.String sSymbolicName)
          Sets the property to be used as a title for folder objects.
 void setShowPageSizeDropDown(boolean on)
           
 void setShowReleaseOnly(boolean on)
          set release only
 void setVersionSeriesMode(boolean on)
           
 
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, render, 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
 

Field Detail

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs

contextMenuVersionSeriesMode

protected boolean contextMenuVersionSeriesMode

contextMenuHelper

protected com.filenet.wcm.apps.server.presentation.util.ActionConfiguration contextMenuHelper

showReleaseOnly

protected boolean showReleaseOnly

showPageSizeDropDown

protected boolean showPageSizeDropDown
Constructor Detail

WcmItemsListView

public WcmItemsListView()
Method Detail

setShowReleaseOnly

public void setShowReleaseOnly(boolean on)
set release only

Parameters:
on - sets value

onStartPage

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

onViewChange

public void onViewChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                  throws java.lang.Exception
Throws:
java.lang.Exception

onPageSizeChange

public void onPageSizeChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                      throws java.lang.Exception
Throws:
java.lang.Exception

setShowPageSizeDropDown

public void setShowPageSizeDropDown(boolean on)

getXSLTemplate

protected java.lang.String getXSLTemplate()
Return the XSL template to use for rendering this listview.

Returns:
The location relative to WEB-INF/xsl of the template file.

configListViewPrefs

public WcmObjectStorePrefs configListViewPrefs(java.lang.String objectStoreName,
                                               boolean detailedView)
Configures document, custom object and folder name properties, sets detailed/magazine view, sets the page size

Parameters:
objectStoreName -
detailedView -
Returns:
WcmObjectStorePrefs object for the current object store

configureDateFormat

protected void configureDateFormat()
                            throws java.lang.Exception
Throws:
java.lang.Exception

setVersionSeriesMode

public void setVersionSeriesMode(boolean on)

configureContextMenu

protected void configureContextMenu()

initialize

public void initialize()
                throws java.lang.Exception
Throws:
java.lang.Exception

setErrorMessage

public void setErrorMessage(com.filenet.wcm.toolkit.util.WcmString errorMessage)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

setDocumentNameProperty

public final void setDocumentNameProperty(java.lang.String sSymbolicName)
Sets the property to be used as a title for document objects.

Parameters:
sSymbolicName - symbolic name of the title property

setCustomObjectNameProperty

public final void setCustomObjectNameProperty(java.lang.String sSymbolicName)
Sets the property to be used as a title for custom objects.

Parameters:
sSymbolicName - symbolic name of the title property

setFolderNameProperty

public final void setFolderNameProperty(java.lang.String sSymbolicName)
Sets the property to be used as a title for folder objects.

Parameters:
sSymbolicName - symbolic name of the title property

configNameProperties

public void configNameProperties(WcmObjectStorePrefs osp)

configNameProperties

public WcmObjectStorePrefs configNameProperties(java.lang.String objectStoreName)


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