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

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
                                      extended bycom.filenet.wcm.apps.server.ui.list.compounddocument.ChildDocumentsListView
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
RemoveChildrenOperation.RemoveChildrenListView

public class ChildDocumentsListView
extends ParentDocumentsListView

Displays the list of child document items.


Nested Class Summary
static class ChildDocumentsListView.MultiCDSelectMenu
           
 
Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.list.compounddocument.ParentDocumentsListView
ascending, aState, cddp, cdState, crList, currentPage, pageSize, prefs, 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
ChildDocumentsListView()
           
 
Method Summary
protected  void clearXML()
           
protected  java.util.List getComponentRelationshipItemList()
           
protected  com.filenet.api.collection.EngineSet getComponentRelationshipItems()
           
protected  CompoundDocumentState getCompoundDocumentState()
           
 void initialize()
          Initializes the class data.
 void onAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onMoveDown(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onMoveFirst(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onMoveLast(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onMoveUp(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onRemoved(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 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()
           
protected  void setListViewColumns()
           
 
Methods inherited from class com.filenet.wcm.apps.server.ui.list.compounddocument.ParentDocumentsListView
configureListView, getFormName, getMoreItems, getPageSize, onPageChange, onPageSizeChange, onSort, setCurrentPage, setPageSize, setSortOrder, setStateKey
 
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
 

Constructor Detail

ChildDocumentsListView

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

setListViewColumns

protected void setListViewColumns()
Overrides:
setListViewColumns in class ParentDocumentsListView

setComponentRelationshipXML

protected void setComponentRelationshipXML()
                                    throws java.lang.Exception
Overrides:
setComponentRelationshipXML in class ParentDocumentsListView
Throws:
java.lang.Exception

getComponentRelationshipItems

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

clearXML

protected void clearXML()
Overrides:
clearXML in class ParentDocumentsListView

getComponentRelationshipItemList

protected java.util.List getComponentRelationshipItemList()
                                                   throws java.lang.Exception
Overrides:
getComponentRelationshipItemList in class ParentDocumentsListView
Throws:
java.lang.Exception

onAction

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

onMoveFirst

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

onMoveUp

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

onMoveDown

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

onMoveLast

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

onRemoved

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

getCompoundDocumentState

protected CompoundDocumentState getCompoundDocumentState()
                                                  throws java.lang.Exception
Overrides:
getCompoundDocumentState in class ParentDocumentsListView
Throws:
java.lang.Exception


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