com.filenet.wcm.apps.server.presentation.ui
Class ItemsListView

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
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public abstract class ItemsListView
extends GenericListView


Field Summary
protected static java.lang.String KEY_COLUMN
           
protected static java.lang.String KEY_DIRECTION
           
protected  boolean 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
ItemsListView()
           
 
Method Summary
protected abstract  void configureContextMenu()
           
protected  void configureDateFormat()
           
 void configureDisplayNameUtil()
          Sets displayNameUtil parameter in the XSL.
 java.lang.String getSortColumn()
           
 boolean getSortOrder()
           
protected  java.lang.String getXSLTemplate()
          Return the XSL template to use for rendering this listview.
 void initialize()
           
 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 setAddItemLinkUrl(boolean on)
          Sets the flag to add the Item link Url.
 void setAvailablePageSizes(java.lang.String[] availablePageSizes)
           
 void setColumnAlignments(org.w3c.dom.NodeList oAlignmentNodes)
          Sets the column alignments used in detailed view.
 void setColumnAlignments(java.lang.String[] sAlignments)
          Sets the column alignments used in detailed view.
 void setColumnLabels(org.w3c.dom.NodeList oLabelNodes)
          Sets the column labels used in detailed view.
 void setColumnLabels(java.lang.String[] sLabels)
          Sets the column labels used in detailed view.
 void setCurrentPageURL(java.lang.String sURL)
          Sets the current page URL (The URL of the page containing the list view).
 void setDefaultPropertyFormatString(java.lang.String sName)
          Sets the default property format string in magazine view.
 void setDetailedView(boolean on)
          Sets the detailed view.
 void setDisableViewFormatDropDown(boolean on)
           
 void setDisplayedProperties(org.w3c.dom.NodeList oNameNodes)
          Same as setDisplayedProperties(String), except that it takes NodeList of Text nodes as a parameter.
 void setDisplayedProperties(java.lang.String[] sNames)
          Sets the properties that will be displayed in the list view, either in detail or magazine views.
 void setEnableSorting(boolean on)
          Sets the parameter to enable sorter
 void setHideButtonsInInfo(boolean on)
          Sets the flag to hide buttons in info pages.
 void setIncludeIdForGetContent(boolean on)
          This is add id={GUID} for getContent link on list views.
 void setInfoLinkMode(boolean on)
          Sets the flag to show Info Link.
 void setMagazineViewDefaultProperty(java.lang.String sName)
          Sets the default property used by the default property format string in magazine view.
 void setMagazineViewFormatString(java.lang.String sFormatString)
          Sets the magazine view format string.
 void setMimeIcons(boolean on)
          Sets the flag to show Mime Icons.
 void setMode(java.lang.String sMode)
          Sets the mode parameter added to the info link.
 void setMultiSelectLinkHTML(java.lang.String html)
          Adds multiselect link in the bottom of the list view to the left of paging buttons
 void setSelectLinkEventURL(java.lang.String sURL)
          Sets the event URL for select link.
 void setSelectLinkTitle(java.lang.String title)
          Sets the title for the select link.
 void setSelectLinkURL(java.lang.String sURL)
          Sets the URL for the select link.
 void setSelectVersionLinkURL(java.lang.String sURL)
          Sets the URL for the select from versions link.
 void setShowItemsFound(boolean on)
          Sets the flag to show "Items Found" text before the list view.
 void setShowRankingColumn(boolean on)
          Sets the flag for showing ranking column.
 void setShowSelectCurrentVersionLink(boolean on)
          Sets the flag to show the Select Release Version Link.
 void setShowSelectReleasedVersionLink(boolean on)
          Sets the flag to show the Select Release Version Link.
 void setShowStripesInMagazineView(boolean on)
          Sets the flag for using stripes in magazine view.
 void setShowSummary(boolean on)
          Sets the flag to show summary in magazine view.
 void setShowSummaryViewOption(boolean on)
           
 void setShowViewFormatDropDown(boolean on)
          Sets a flag to display a drop down "magazine", "detailed" and "summary" views
 void setSortColumn(java.lang.String sortColumn)
           
 void setSortOrder(boolean accending)
           
 void setStateIcons(boolean on)
          Sets the flag to show state icons.
 void setVersionNumbers(boolean on)
          Sets the flag to show version numbers in magazine view.
 void setVersionSeriesMode(boolean on)
          If this is true, info link will have versionSeriesMode=true and id will be included on getContent links
 void setVersionStatusLabels(org.w3c.dom.NodeList oLabelNodes)
          Sets the version status labels used in detailed view.
 void setVersionStatusLabels(java.lang.String[] sLabels)
          Sets the version status labels used in detailed view.
 void sort(java.lang.String sortProperty, boolean order)
          Implement this method in a subclass
 
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

KEY_COLUMN

protected static final java.lang.String KEY_COLUMN
See Also:
Constant Field Values

KEY_DIRECTION

protected static final java.lang.String KEY_DIRECTION
See Also:
Constant Field Values

sortEvent

protected boolean sortEvent
Constructor Detail

ItemsListView

public ItemsListView()
Method Detail

getXSLTemplate

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

Overrides:
getXSLTemplate in class GenericListView
Returns:
The location relative to WEB-INF/xsl of the template file.

configureDateFormat

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

configureContextMenu

protected abstract void configureContextMenu()

initialize

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

onSort

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

setShowViewFormatDropDown

public void setShowViewFormatDropDown(boolean on)
Sets a flag to display a drop down "magazine", "detailed" and "summary" views

Parameters:
on -

setDisableViewFormatDropDown

public void setDisableViewFormatDropDown(boolean on)

setShowSummaryViewOption

public void setShowSummaryViewOption(boolean on)

setAvailablePageSizes

public void setAvailablePageSizes(java.lang.String[] availablePageSizes)

setSortColumn

public void setSortColumn(java.lang.String sortColumn)
                   throws java.lang.Exception
Throws:
java.lang.Exception

configureDisplayNameUtil

public void configureDisplayNameUtil()
                              throws java.lang.Exception
Sets displayNameUtil parameter in the XSL.

Throws:
java.lang.Exception

getSortColumn

public java.lang.String getSortColumn()
                               throws java.lang.Exception
Throws:
java.lang.Exception

setSortOrder

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

getSortOrder

public boolean getSortOrder()
                     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
Throws:
java.lang.Exception

sort

public void sort(java.lang.String sortProperty,
                 boolean order)
Implement this method in a subclass

Parameters:
sortProperty -
order -

setDisplayedProperties

public void setDisplayedProperties(java.lang.String[] sNames)
Sets the properties that will be displayed in the list view, either in detail or magazine views.

Parameters:
sNames - String[] of property names

setDisplayedProperties

public void setDisplayedProperties(org.w3c.dom.NodeList oNameNodes)
Same as setDisplayedProperties(String), except that it takes NodeList of Text nodes as a parameter.

Parameters:
oNameNodes - NodeList of Text nodes containing property names

setColumnLabels

public void setColumnLabels(java.lang.String[] sLabels)
Sets the column labels used in detailed view.

Parameters:
sLabels - String[] of labels

setColumnLabels

public void setColumnLabels(org.w3c.dom.NodeList oLabelNodes)
Sets the column labels used in detailed view.

Parameters:
oLabelNodes - NodeList of labels (containing Text nodes)

setVersionStatusLabels

public void setVersionStatusLabels(java.lang.String[] sLabels)
Sets the version status labels used in detailed view.

Parameters:
sLabels - String[] of labels

setVersionStatusLabels

public void setVersionStatusLabels(org.w3c.dom.NodeList oLabelNodes)
Sets the version status labels used in detailed view.

Parameters:
oLabelNodes - NodeList of labels (containing Text nodes)

setColumnAlignments

public void setColumnAlignments(java.lang.String[] sAlignments)
Sets the column alignments used in detailed view.

Parameters:
sAlignments - String[] of alignments

setColumnAlignments

public void setColumnAlignments(org.w3c.dom.NodeList oAlignmentNodes)
Sets the column alignments used in detailed view.

Parameters:
oAlignmentNodes - NodeList of alignments

setShowItemsFound

public void setShowItemsFound(boolean on)
Sets the flag to show "Items Found" text before the list view.


setVersionSeriesMode

public void setVersionSeriesMode(boolean on)
If this is true, info link will have versionSeriesMode=true and id will be included on getContent links

Parameters:
on -

setStateIcons

public void setStateIcons(boolean on)
Sets the flag to show state icons.


setMimeIcons

public void setMimeIcons(boolean on)
Sets the flag to show Mime Icons.


setInfoLinkMode

public void setInfoLinkMode(boolean on)
Sets the flag to show Info Link.


setIncludeIdForGetContent

public void setIncludeIdForGetContent(boolean on)
This is add id={GUID} for getContent link on list views.

Parameters:
on -

setSelectLinkEventURL

public void setSelectLinkEventURL(java.lang.String sURL)
Sets the event URL for select link. For internal use only (this method should only be used by other Workplace modules; you should not call it directly from your application).


setSelectLinkURL

public void setSelectLinkURL(java.lang.String sURL)
Sets the URL for the select link. For internal use only (this method should only be used by other Workplace modules; you should not call it directly from your application).


setSelectVersionLinkURL

public void setSelectVersionLinkURL(java.lang.String sURL)
Sets the URL for the select from versions link. For internal use only (this method should only be used by other Workplace modules; you should not call it directly from your application).


setSelectLinkTitle

public void setSelectLinkTitle(java.lang.String title)
Sets the title for the select link.


setShowSelectCurrentVersionLink

public void setShowSelectCurrentVersionLink(boolean on)
Sets the flag to show the Select Release Version Link.


setShowSelectReleasedVersionLink

public void setShowSelectReleasedVersionLink(boolean on)
Sets the flag to show the Select Release Version Link.


setCurrentPageURL

public void setCurrentPageURL(java.lang.String sURL)
Sets the current page URL (The URL of the page containing the list view). Used as returnUrl parameter in Info link.


setEnableSorting

public void setEnableSorting(boolean on)
Sets the parameter to enable sorter

Parameters:
on -

setMode

public void setMode(java.lang.String sMode)
Sets the mode parameter added to the info link.


setShowRankingColumn

public void setShowRankingColumn(boolean on)
Sets the flag for showing ranking column. Optionally used for content search results.


setShowStripesInMagazineView

public void setShowStripesInMagazineView(boolean on)
Sets the flag for using stripes in magazine view. False by default.


setDetailedView

public void setDetailedView(boolean on)
Sets the detailed view.


setMagazineViewDefaultProperty

public void setMagazineViewDefaultProperty(java.lang.String sName)
Sets the default property used by the default property format string in magazine view.


setDefaultPropertyFormatString

public void setDefaultPropertyFormatString(java.lang.String sName)
Sets the default property format string in magazine view.


setMagazineViewFormatString

public void setMagazineViewFormatString(java.lang.String sFormatString)
Sets the magazine view format string.


setVersionNumbers

public void setVersionNumbers(boolean on)
Sets the flag to show version numbers in magazine view.


setShowSummary

public void setShowSummary(boolean on)
Sets the flag to show summary in magazine view.


setHideButtonsInInfo

public void setHideButtonsInInfo(boolean on)
Sets the flag to hide buttons in info pages.


setAddItemLinkUrl

public void setAddItemLinkUrl(boolean on)
Sets the flag to add the Item link Url. The Url is typically the url to the getContent servlet or the bookmark pages.


setMultiSelectLinkHTML

public void setMultiSelectLinkHTML(java.lang.String html)
Adds multiselect link in the bottom of the list view to the left of paging buttons

Parameters:
html -


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