com.filenet.wcm.apps.server.ui
Class WcmNavigationListView

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.WcmGenericListView
                              extended bycom.filenet.wcm.apps.server.ui.WcmNavigationListView
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
ShortcutNavigation, TasksNavigation, WcmAttachmentNavigation, WcmPathNavigation

public class WcmNavigationListView
extends WcmGenericListView

Provides base functionality for many navigation subclasses.


Field Summary
protected  WorkplaceActionConfiguration contextMenuHelper
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmGenericListView
config
 
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
WcmNavigationListView()
           
 
Method Summary
 void initialize()
           
 void render(java.io.Writer w)
           
 void setColumns(int cols)
          Sets the number of columns displayed in the navigation list view.
 void setExtraURLParameters(java.lang.String sURLParams)
          Sets the string that will be appended to every link generated
 void setFormSubmitName(java.lang.String sFormName)
          Sets the name of the HTML form that is going to be submitted when user clicks on any item in the navigation list view.
 void setMaxRows(int rows)
          Sets the maximum number of rows that can be displayed.
 void setShowContextMenu(boolean showContextMenu)
           
 void setShowNoItemsMessage(boolean on)
           
 void setTitle(java.lang.String title)
          Sets the description that is displayed in the top of the list view.
 void setTitle(com.filenet.wcm.toolkit.util.WcmString wsTitle)
          Sets the description that is displayed in the top of the list view.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmGenericListView
configNameProperties, configNameProperties, configNameProperties, configNameProperties, setCustomObjectNameProperty, setCustomObjectNameProperty, setDocumentNameProperty, setDocumentNameProperty, setFolderNameProperty, setFolderNameProperty
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.GenericListView
getCurrentPage, getXSLTemplate, 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, 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
 

Field Detail

contextMenuHelper

protected WorkplaceActionConfiguration contextMenuHelper
Constructor Detail

WcmNavigationListView

public WcmNavigationListView()
Method Detail

initialize

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

setShowNoItemsMessage

public void setShowNoItemsMessage(boolean on)

setShowContextMenu

public void setShowContextMenu(boolean showContextMenu)

render

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

setColumns

public final void setColumns(int cols)
Sets the number of columns displayed in the navigation list view.

Parameters:
cols - number of columns

setFormSubmitName

public void setFormSubmitName(java.lang.String sFormName)
Sets the name of the HTML form that is going to be submitted when user clicks on any item in the navigation list view.

Parameters:
sFormName - HTML form name

setMaxRows

public final void setMaxRows(int rows)
Sets the maximum number of rows that can be displayed.

Parameters:
rows - maximum number of rows

setTitle

public final void setTitle(com.filenet.wcm.toolkit.util.WcmString wsTitle)
Sets the description that is displayed in the top of the list view.

Parameters:
wsTitle - text to be displayed (as WcmString)

setTitle

public final void setTitle(java.lang.String title)
Sets the description that is displayed in the top of the list view.

Parameters:
title - text to be displayed (as WcmString)

setExtraURLParameters

public final void setExtraURLParameters(java.lang.String sURLParams)
Sets the string that will be appended to every link generated

Parameters:
sURLParams - the string that will be appended


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