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

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

public class GenericListView
extends com.filenet.wcm.toolkit.server.ui.WcmXSLModule


Field Summary
 
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
GenericListView()
           
 
Method Summary
 int getCurrentPage()
          Returns current page.
protected  java.lang.String getXSLTemplate()
          Return the XSL template to use for rendering this listview.
 void initialize()
           
 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 setCurrentPage(int nPage)
          Sets the current page.
 void setFirstDisplayedItem(int nItem)
          Sets the first displayed item.
 void setItemsCount(int nItems)
          Specify a default value for the total items to be displayed.
 void setLastDisplayedItem(int nItem)
          Sets the last displayed item.
 void setNameProperty(java.lang.String propertyName)
          Sets the default property to be used as the title.
 void setNoItemsText(com.filenet.wcm.toolkit.util.WcmString message)
          Text that shows up when no items are displayed in the list view Note: XSL must have wsNoItemsMessage parameter
 void setNotItemsTextString(java.lang.String message)
          Text that shows up when no items are displayed in the list view Note: XSL must have wsNoItemsMessage parameter
 void setPageSize(int nPageSize)
          Sets the number of items displayed on one page.
 void setPagingLabel(com.filenet.wcm.toolkit.util.WcmString wsPagingLabel)
          Sets the label used for the pages.
 void setSelectedObjects(java.lang.String objects)
          Sets the filter which objects are displayed.
 
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
onStartPage, 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.WcmUiModuleInterface
onStartPage
 
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

GenericListView

public GenericListView()
Method Detail

initialize

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

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.

getCurrentPage

public int getCurrentPage()
                   throws java.lang.Exception
Returns current page.

Throws:
java.lang.Exception - when any errors occur

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 nPageSize)
Sets the number of items displayed on one page.

Parameters:
nPageSize - page size

setPagingLabel

public void setPagingLabel(com.filenet.wcm.toolkit.util.WcmString wsPagingLabel)
Sets the label used for the pages.

Parameters:
wsPagingLabel - paging label as WcmString

setNameProperty

public void setNameProperty(java.lang.String propertyName)
Sets the default property to be used as the title.

Parameters:
propertyName - symbolic name of the title property

setItemsCount

public void setItemsCount(int nItems)
Specify a default value for the total items to be displayed.

Parameters:
nItems - number of items

setFirstDisplayedItem

public void setFirstDisplayedItem(int nItem)
Sets the first displayed item.

Parameters:
nItem - item number

setLastDisplayedItem

public void setLastDisplayedItem(int nItem)
Sets the last displayed item.

Parameters:
nItem - item number

setSelectedObjects

public void setSelectedObjects(java.lang.String objects)
Sets the filter which objects are displayed.

Parameters:
objects - a string with the names of objects that the list view will display. Anything can be used as a separator, including spaces.

setNoItemsText

public void setNoItemsText(com.filenet.wcm.toolkit.util.WcmString message)
Text that shows up when no items are displayed in the list view Note: XSL must have wsNoItemsMessage parameter

Parameters:
message - message to be displayed

setNotItemsTextString

public void setNotItemsTextString(java.lang.String message)
Text that shows up when no items are displayed in the list view Note: XSL must have wsNoItemsMessage parameter

Parameters:
message - message to be displayed

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


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