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

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

public class WebContentSiteNavigation
extends BrowseNavigation

This module displays all object stores and its information.


Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.nav.BrowseNavigation
BrowseNavigation.BrowseTreeModule, BrowseNavigation.WcmNavigationPath, BrowseNavigation.WcmPathEntry
 
Field Summary
static int ROOT_FOLDER_TYPE_RESOURCE
           
static int ROOT_FOLDER_TYPE_SITE
           
static int ROOT_FOLDER_TYPE_SITEDEFINITION
           
static java.lang.String siteIdKey
           
static java.lang.String siteLabelKey
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.nav.BrowseNavigation
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
WebContentSiteNavigation(int type)
           
 
Method Summary
protected  void configPath()
           
protected  void configToolBar()
           
 java.lang.String getSiteId()
          Returns the selected site id.
 java.lang.String getSiteName()
          Returns the selected site name.
 void initialize()
          Initializes module.
 boolean isSiteSelected()
          Returns true if a site is already selected.
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          User selects an object store, site or folder.
 void onSelectFolder(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          User selects a folder from the path navigation.
 void onSelectObjectStore(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          User selects an object store.
 void onSelectRoot(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          User selects the root anchor of the path navigation.
 void onSelectSite(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          User selects a site from the path navigation.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Sets up display information and info link if an object store has been selected
 void setLockSelectedFolder(boolean yes)
          Locks site navigation to the selected folder and subfolders.
 void setLockSite(boolean yes)
          Locks site navigation to the selected site.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.nav.BrowseNavigation
addGetInfoLink, addShowContentLink, callRenderTreeModule, clearRoot, filterContent, getCurrentPath, getRenderTreeModule, getResults, getShowContentsLink, getUnsortedResults, insertExtraAnchors, isLockedRoot, onRefreshPage, onReset, onSelectObjectStore, onShowContents, onStateChanged, onTreeSelect, render, resetRoot, selectObjectStore, setAuthoringDataProvider, setBookmarkPage, setHideButtonsInInfo, setMode, setNavigationDataProvider, setPathLabel, setRenderActionLinks, setRenderPathLinks, setRenderTreeModule, setResultsFromCachedState, setRoot, 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, 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

ROOT_FOLDER_TYPE_SITE

public static final int ROOT_FOLDER_TYPE_SITE
See Also:
Constant Field Values

ROOT_FOLDER_TYPE_RESOURCE

public static final int ROOT_FOLDER_TYPE_RESOURCE
See Also:
Constant Field Values

ROOT_FOLDER_TYPE_SITEDEFINITION

public static final int ROOT_FOLDER_TYPE_SITEDEFINITION
See Also:
Constant Field Values

siteIdKey

public static final java.lang.String siteIdKey
See Also:
Constant Field Values

siteLabelKey

public static final java.lang.String siteLabelKey
See Also:
Constant Field Values
Constructor Detail

WebContentSiteNavigation

public WebContentSiteNavigation(int type)
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Description copied from class: WcmPathNavigation
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 BrowseNavigation
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Sets up display information and info link if an object store has been selected

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class BrowseNavigation
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or there's an invalid parameter.

configToolBar

protected void configToolBar()
                      throws java.lang.Exception
Overrides:
configToolBar in class BrowseNavigation
Throws:
java.lang.Exception

configPath

protected void configPath()
                   throws java.lang.Exception
Overrides:
configPath in class BrowseNavigation
Throws:
java.lang.Exception

onSelectSite

public void onSelectSite(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
User selects a site from the path navigation.

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

onSelectFolder

public void onSelectFolder(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
User selects a folder from the path navigation.

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

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
User selects an object store, site or folder.

Overrides:
onSelect in class BrowseNavigation
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or there's an invalid parameter.

onSelectRoot

public void onSelectRoot(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
User selects the root anchor of the path navigation.

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

onSelectObjectStore

public void onSelectObjectStore(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws java.lang.Exception
User selects an object store. Selected item is reset.

Throws:
java.lang.Exception - If there are problems retrieving data or there's an invalid parameter.

isSiteSelected

public boolean isSiteSelected()
Returns true if a site is already selected.

Returns:
boolean true if site is already selected

getSiteId

public java.lang.String getSiteId()
Returns the selected site id.

Returns:
String The selected site id.

getSiteName

public java.lang.String getSiteName()
Returns the selected site name.

Returns:
String The selected site name.

setLockSite

public void setLockSite(boolean yes)
Locks site navigation to the selected site. Cannot change site.

Parameters:
yes - true to lock navigation to the selected site.

setLockSelectedFolder

public void setLockSelectedFolder(boolean yes)
Locks site navigation to the selected folder and subfolders.

Parameters:
yes - true to lock navigation to the selected folder and subfolders..


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