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

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

public class EventListView
extends com.filenet.wcm.apps.server.presentation.ui.GenericListView


Field Summary
protected  WcmWorkplaceConfig config
           
protected static java.lang.String KEY_COLUMN
           
protected static java.lang.String KEY_DIRECTION
           
protected  WcmSitePrefs sitePrefs
           
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
EventListView()
           
 
Method Summary
 java.lang.String getSortColumn()
           
 boolean getSortOrder()
           
protected  java.lang.String getXSLTemplate()
          Return the XSL template to use for rendering this listview.
 void initialize()
           
 void onPageSizeChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onSort(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back triggered by a sort event
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 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 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 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 setShowItemsFound(boolean on)
          Sets the flag to show "Items Found" text before the list view.
 void setShowStripesInMagazineView(boolean on)
          Sets the flag for using stripes in magazine view.
 void setSortColumn(java.lang.String sortColumn)
           
 void setSortOrder(boolean accending)
           
 
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

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs
Constructor Detail

EventListView

public EventListView()
Method Detail

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.

initialize

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

onSort

public void onSort(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Call back triggered by a sort event

Parameters:
request -
response -
Throws:
java.lang.Exception

setSortColumn

public void setSortColumn(java.lang.String sortColumn)
                   throws java.lang.Exception
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

onPageSizeChange

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

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)

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.


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 -

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.



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