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

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.BrowseListView
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
SelectOperation.SelectionBrowseListView, WcmFileWizardPage.WcmSpecialFolderContents, WcmUnfileWizardPage.WcmSpecialFolderContents

public class BrowseListView
extends WcmItemsListView

WcmContainerContentsListView is derived from the WcmItemsListView object. This object will show a list usually made up of documents. This object uses the WcmNavigationDataProvider to get an XML list of documents from a folder or stored search. WcmConfiguration is used to get viewing mode (detail or magazine) and properties.


Nested Class Summary
 class BrowseListView.FolderNavSimpleSearch
           
 
Field Summary
protected  org.w3c.dom.Document resultsDocument
           
protected  boolean showCustomObjects
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmItemsListView
config, contextMenuHelper, contextMenuVersionSeriesMode, showPageSizeDropDown, showReleaseOnly
 
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
BrowseListView()
           
 
Method Summary
protected  void addAdditionalDocumentProps(com.filenet.wcm.toolkit.server.util.FilterData filterData)
          Overrides by sub classes to add addtional criteria to the search criteria.
 java.lang.String getFormName()
           
protected  int getListViewMode()
          Returns the list view mode (detail or magazine) to be used.
protected  boolean getShowMultiSelectOperations()
           
 WcmNavigationState getState()
           
 void initialize()
           
 void onAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onPageChange(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onPrintView(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event called for printView
 void onSort(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onViewChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void render(java.io.Writer w)
           
 void setCustomObjectTypes(java.lang.String[] newCustomObjectTypes)
          Sets CustomObjectTypes for getResults
 void setFilterClass(java.lang.String newFilterClass)
          Sets filter class for getResults
 void setLinkName(java.lang.String linkName)
           
 void setLinkType(java.lang.String objectType)
           
 void setMimeTypes(java.lang.String[] newMimeTypes)
          Sets mimetypes for getResults
 void setNoDocuments(boolean on)
          When true, only custom objects returned
 void setShowFilterClass(boolean on)
          When false, filter class will not be shown at all
 void setShowMultiActions(boolean on)
          When true, only document caching will be done
 void setTextProp(java.lang.String textProp)
           
 void sort(java.lang.String sortProperty, boolean order)
           
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmItemsListView
configListViewPrefs, configNameProperties, configNameProperties, configureContextMenu, configureDateFormat, getXSLTemplate, onPageSizeChange, 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, setSortOrder, setStateIcons, setVersionNumbers, setVersionStatusLabels, setVersionStatusLabels
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.GenericListView
getCurrentPage, 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, 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

resultsDocument

protected org.w3c.dom.Document resultsDocument

showCustomObjects

protected boolean showCustomObjects
Constructor Detail

BrowseListView

public BrowseListView()
Method Detail

setShowMultiActions

public void setShowMultiActions(boolean on)
When true, only document caching will be done

Parameters:
on - sets value

setShowFilterClass

public void setShowFilterClass(boolean on)
When false, filter class will not be shown at all

Parameters:
on - sets value

setFilterClass

public void setFilterClass(java.lang.String newFilterClass)
Sets filter class for getResults

Parameters:
newFilterClass - sets value

setMimeTypes

public void setMimeTypes(java.lang.String[] newMimeTypes)
Sets mimetypes for getResults

Parameters:
newMimeTypes - sets value

setCustomObjectTypes

public void setCustomObjectTypes(java.lang.String[] newCustomObjectTypes)
Sets CustomObjectTypes for getResults

Parameters:
newCustomObjectTypes - sets value

setLinkType

public void setLinkType(java.lang.String objectType)

setLinkName

public void setLinkName(java.lang.String linkName)

setTextProp

public void setTextProp(java.lang.String textProp)

onStateChanged

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

setNoDocuments

public void setNoDocuments(boolean on)
When true, only custom objects returned

Parameters:
on - sets value

initialize

public void initialize()
                throws java.lang.Exception
Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmItemsListView
Throws:
java.lang.Exception

getShowMultiSelectOperations

protected boolean getShowMultiSelectOperations()

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Throws:
java.lang.Exception

getListViewMode

protected int getListViewMode()
                       throws java.lang.Exception
Returns the list view mode (detail or magazine) to be used. Overwrite this method to force a certain view.

Returns:
WcmConfiguration.LIST_VIEW_MODE_DETAIL or WcmConfiguration.LIST_VIEW_MODE_MAGAZINE
Throws:
java.lang.Exception - If any problems occur

onViewChange

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

getState

public WcmNavigationState getState()

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
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class WcmItemsListView
Throws:
java.lang.Exception

onPrintView

public void onPrintView(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Event called for printView

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.

getFormName

public java.lang.String getFormName()

onAction

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

sort

public void sort(java.lang.String sortProperty,
                 boolean order)

addAdditionalDocumentProps

protected void addAdditionalDocumentProps(com.filenet.wcm.toolkit.server.util.FilterData filterData)
                                   throws java.lang.Exception
Overrides by sub classes to add addtional criteria to the search criteria.

Throws:
java.lang.Exception


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