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

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
                                  extended bycom.filenet.wcm.apps.server.ui.WcmPathNavigation
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
BrowseNavigation, ConvertForWebNavigation, PrefGroupHomeInfoPage, WcmObjectStoreNavigation, WcmPublishOptionsNavigation, WcmUnfileWizardPage

public class WcmPathNavigation
extends WcmNavigationListView

The path navigation UI module renders a PathView, a ToolBar, and, by extending WcmNavigationListView, it also renders a listview of navigation items. This is used in navigation modules to show current path and a toolbar of commands, such as "get Info" and "add Shortcut".


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmNavigationListView
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
WcmPathNavigation()
           
 
Method Summary
 com.filenet.wcm.apps.server.presentation.ui.ToolBar getCommandBar()
          Returns contained WcmToolBar module as WcmToolBar.
 com.filenet.wcm.apps.server.presentation.ui.PathView getPathView()
          Returns WcmPathView object.
 void initialize()
          Initializes module.
 void render(java.io.Writer w)
          Renders the class data.
 void setRenderNavigation(boolean on)
          Sets a flag to indicate whether navigation list view will be rendered.
 void setRenderPath(boolean on)
          Sets a flag to indicate whether Path will be rendered.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmNavigationListView
setColumns, setExtraURLParameters, setFormSubmitName, setMaxRows, setShowContextMenu, setShowNoItemsMessage, setTitle, setTitle
 
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
 

Constructor Detail

WcmPathNavigation

public WcmPathNavigation()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes module. Does an addChild for the toolbar and pathView.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmNavigationListView
Throws:
java.lang.Exception

getPathView

public com.filenet.wcm.apps.server.presentation.ui.PathView getPathView()
Returns WcmPathView object.

Returns:
WcmPathView

getCommandBar

public com.filenet.wcm.apps.server.presentation.ui.ToolBar getCommandBar()
Returns contained WcmToolBar module as WcmToolBar.

Returns:
WcmToolBar member as WcmToolBar.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
render in class WcmNavigationListView
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

setRenderNavigation

public void setRenderNavigation(boolean on)
Sets a flag to indicate whether navigation list view will be rendered.

Parameters:
on - True to render.

setRenderPath

public void setRenderPath(boolean on)
Sets a flag to indicate whether Path will be rendered.

Parameters:
on - True to render.


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