com.filenet.wcm.apps.server.ui.nav.webcontent
Class SelectableCatBrowseNavigation

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
                                      extended bycom.filenet.wcm.apps.server.ui.nav.BrowseNavigation
                                          extended bycom.filenet.wcm.apps.server.ui.nav.webcontent.SelectableCatBrowseNavigation
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class SelectableCatBrowseNavigation
extends BrowseNavigation


Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.nav.BrowseNavigation
BrowseNavigation.BrowseTreeModule, BrowseNavigation.WcmNavigationPath, BrowseNavigation.WcmPathEntry
 
Field Summary
protected static java.lang.String MODULE_NAME
           
protected  com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddToSelection
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.nav.BrowseNavigation
adp, anchors, bHideButtonsInInfo, bShowObjectStorePathLink, bShowOnlyFolders, bShowRoot, isWebNavigation, objectStoresLabel, pathModule, sMode, state, TOP_FOLDER
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmNavigationListView
contextMenuHelper
 
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
SelectableCatBrowseNavigation()
           
SelectableCatBrowseNavigation(java.lang.String name)
           
 
Method Summary
 void addGetInfoLink()
          Display object info icon.
protected  void configureAnchors()
           
 org.w3c.dom.Document filterContent(org.w3c.dom.Document doc, int filterType, BrowseNavigation.WcmNavigationPath path)
          user this method to intercept folders dom object
protected  java.lang.String getFolderPath(java.lang.String objectStoreName)
           
 java.lang.String getFormName()
           
 org.w3c.dom.Document getLastestBrowsingXML()
           
protected  org.w3c.dom.Document getUnsortedResults(java.lang.String folderpath, java.lang.String folderNameProp, java.lang.String documentNameProp, java.lang.String customobjectNameProp, java.lang.String[] props, boolean getFoldersOnly)
           
 void initialize()
          Initializes the data providers and the display objects.
 void onAddFavorites(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler, This method use Chain of Responsibility pattern to route form data to related module.
 void onAddSelection(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler, This method use Chain of Responsibility pattern to route form data to related module.
 void onChangePage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The onChangePage controller event handler.
 void onRemoveFavorites(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler, This method use Chain of Responsibility pattern to route form data to related module.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event sets up the display objects for rendering.
 void selectObjectStore(java.lang.String objectStoreName)
           
 void setFormName(java.lang.String formName)
           
 void setRoot(java.lang.String sObjectStoreName, java.lang.String sObjectID, int nObjectType, java.lang.String sLabel)
          Sets root of browse path from variables.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.nav.BrowseNavigation
addShowContentLink, callRenderTreeModule, clearRoot, configPath, configToolBar, getCurrentPath, getRenderTreeModule, getResults, getShowContentsLink, insertExtraAnchors, isLockedRoot, onRefreshPage, onReset, onSelect, onSelectObjectStore, onSelectRoot, onShowContents, onStateChanged, onTreeSelect, render, resetRoot, setAuthoringDataProvider, setBookmarkPage, setHideButtonsInInfo, setMode, setNavigationDataProvider, setPathLabel, setRenderActionLinks, setRenderPathLinks, setRenderTreeModule, setResultsFromCachedState, setRoot, setRootFromPageParameters, setSelectedTreeNode, setShowAddBookmarkLink, setShowAddCustomObjectLink, setShowAddDocumentLink, setShowAddShortCutLink, setShowContentsLink, setShowCustomObjects, setShowExcludedFolderTypes, setShowOnlyFolders, setShowPrintView, setShowRoot, setTree, setXML
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmPathNavigation
getCommandBar, getPathView, setRenderNavigation, setRenderPath
 
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, 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, 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

wsAddToSelection

protected static final com.filenet.wcm.toolkit.util.WcmString wsAddToSelection

MODULE_NAME

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

ndp

protected com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp
Constructor Detail

SelectableCatBrowseNavigation

public SelectableCatBrowseNavigation(java.lang.String name)
                              throws java.lang.Exception

SelectableCatBrowseNavigation

public SelectableCatBrowseNavigation()
                              throws java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the data providers and the display objects. This object replace super class's navigation data provider with RM navigation data provider therefore, it needs to call super.initialize first before setting up its replacement.

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

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
The default event sets up the display objects for rendering.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class BrowseNavigation
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

configureAnchors

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

addGetInfoLink

public void addGetInfoLink()
                    throws java.lang.Exception
Display object info icon. If selected item is file plan then display object store info.

Overrides:
addGetInfoLink in class BrowseNavigation
Throws:
java.lang.Exception

getUnsortedResults

protected org.w3c.dom.Document getUnsortedResults(java.lang.String folderpath,
                                                  java.lang.String folderNameProp,
                                                  java.lang.String documentNameProp,
                                                  java.lang.String customobjectNameProp,
                                                  java.lang.String[] props,
                                                  boolean getFoldersOnly)
                                           throws java.lang.Exception
Overrides:
getUnsortedResults in class BrowseNavigation
Throws:
java.lang.Exception

getFolderPath

protected java.lang.String getFolderPath(java.lang.String objectStoreName)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

setRoot

public void setRoot(java.lang.String sObjectStoreName,
                    java.lang.String sObjectID,
                    int nObjectType,
                    java.lang.String sLabel)
             throws java.lang.Exception
Sets root of browse path from variables.

Overrides:
setRoot in class BrowseNavigation
Parameters:
sObjectStoreName - Id of object store for root
sObjectID - Id of root object
nObjectType - Object type of root object
sLabel - Label of root object
Throws:
java.lang.Exception

onAddSelection

public void onAddSelection(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Select event handler, This method use Chain of Responsibility pattern to route form data to related module.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onAddFavorites

public void onAddFavorites(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Select event handler, This method use Chain of Responsibility pattern to route form data to related module.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onRemoveFavorites

public void onRemoveFavorites(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
Select event handler, This method use Chain of Responsibility pattern to route form data to related module.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onChangePage

public void onChangePage(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
The onChangePage controller event handler.

Parameters:
request - - The current HttpServletRequest.
response - - The current HttpServletResponse.
Throws:
java.lang.Exception

selectObjectStore

public void selectObjectStore(java.lang.String objectStoreName)
                       throws java.lang.Exception
Overrides:
selectObjectStore in class BrowseNavigation
Throws:
java.lang.Exception

getLastestBrowsingXML

public org.w3c.dom.Document getLastestBrowsingXML()
                                           throws java.lang.Exception
Throws:
java.lang.Exception

filterContent

public org.w3c.dom.Document filterContent(org.w3c.dom.Document doc,
                                          int filterType,
                                          BrowseNavigation.WcmNavigationPath path)
                                   throws java.lang.Exception
user this method to intercept folders dom object

Overrides:
filterContent in class BrowseNavigation
Parameters:
doc - folders dom
filterType - filter type
path - Navigation path
Returns:
return same object
Throws:
java.lang.Exception

setFormName

public void setFormName(java.lang.String formName)
                 throws java.lang.Exception
Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()


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