com.filenet.wcm.apps.server.ui.list.compounddocument
Class ParentDocumentsListView

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.compounddocument.ParentDocumentsListView
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
ChildDocumentsListView

public class ParentDocumentsListView
extends WcmItemsListView

Displays the list of parent documents


Field Summary
protected  boolean ascending
           
protected  WcmAuthoringState aState
           
protected  com.filenet.wcm.toolkit.server.dp.CompoundDocumentDataProvider cddp
           
protected  CompoundDocumentState cdState
           
protected  java.util.List crList
           
protected  int currentPage
           
protected  int pageSize
           
protected  WcmObjectStorePrefs prefs
           
protected  java.lang.String stateKey
           
 
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
ParentDocumentsListView()
           
 
Method Summary
protected  void clearXML()
           
protected  void configureListView()
           
protected  java.util.List getComponentRelationshipItemList()
           
protected  com.filenet.api.collection.EngineSet getComponentRelationshipItems()
           
protected  CompoundDocumentState getCompoundDocumentState()
           
 java.lang.String getFormName()
           
protected  void getMoreItems()
           
protected  int getPageSize()
           
 void initialize()
          Initializes the class data.
 void onPageChange(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that occurs when user changes a page in the list view.
 void onPageSizeChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onSort(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Makes calls to the data provider to gather data required for rendering.
protected  void setComponentRelationshipXML()
           
 void setCurrentPage(int nPage)
          Sets the current page.
protected  void setListViewColumns()
           
 void setPageSize(int pagingSize)
          Sets the number of items displayed on one page.
 void setSortOrder(boolean ascendingOrder)
           
 void setStateKey(java.lang.String key)
           
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmItemsListView
configListViewPrefs, configNameProperties, configNameProperties, configureContextMenu, configureDateFormat, getXSLTemplate, onViewChange, setCustomObjectNameProperty, setDocumentNameProperty, setErrorMessage, setErrorMessage, setFolderNameProperty, setShowPageSizeDropDown, setShowReleaseOnly, setVersionSeriesMode
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.ItemsListView
configureDisplayNameUtil, getSortColumn, getSortOrder, 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, setStateIcons, setVersionNumbers, setVersionStatusLabels, setVersionStatusLabels, sort
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.GenericListView
getCurrentPage, setFirstDisplayedItem, setItemsCount, setLastDisplayedItem, setNameProperty, setNoItemsText, setNotItemsTextString, 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, 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

cddp

protected com.filenet.wcm.toolkit.server.dp.CompoundDocumentDataProvider cddp

cdState

protected CompoundDocumentState cdState

aState

protected WcmAuthoringState aState

crList

protected java.util.List crList

prefs

protected WcmObjectStorePrefs prefs

stateKey

protected java.lang.String stateKey

pageSize

protected int pageSize

currentPage

protected int currentPage

ascending

protected boolean ascending
Constructor Detail

ParentDocumentsListView

public ParentDocumentsListView()
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.

getCompoundDocumentState

protected CompoundDocumentState getCompoundDocumentState()
                                                  throws java.lang.Exception
Throws:
java.lang.Exception

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 JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

configureListView

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

setListViewColumns

protected void setListViewColumns()

setComponentRelationshipXML

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

getComponentRelationshipItems

protected com.filenet.api.collection.EngineSet getComponentRelationshipItems()
                                                                      throws java.lang.Exception
Throws:
java.lang.Exception

clearXML

protected void clearXML()

onSort

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

onPageChange

public void onPageChange(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Event that occurs when user changes a page in the list view.

Parameters:
request -
response -
Throws:
java.lang.Exception - when any errors occur

onPageSizeChange

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

getMoreItems

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

setCurrentPage

public void setCurrentPage(int nPage)
                    throws java.lang.Exception
Sets the current page.

Parameters:
nPage - current page number
Throws:
java.lang.Exception - when any errors occur

setPageSize

public void setPageSize(int pagingSize)
Sets the number of items displayed on one page.

Parameters:
pagingSize - page size

setSortOrder

public void setSortOrder(boolean ascendingOrder)
                  throws java.lang.Exception
Throws:
java.lang.Exception

getComponentRelationshipItemList

protected java.util.List getComponentRelationshipItemList()
                                                   throws java.lang.Exception
Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()

getPageSize

protected int getPageSize()
                   throws java.lang.Exception
Throws:
java.lang.Exception

setStateKey

public void setStateKey(java.lang.String key)


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