com.filenet.wcm.apps.server.ui.nav
Class BrowseNavigation

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
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
SelectableBrowseNavigation, SelectableCatBrowseNavigation, SelectOperation.SelectionBrowseNavigation, ShortcutsPage.ShortcutBrowseNavigation, WcmFileWizardPage.WcmSpecialFolderNavigation, WcmFilterFolderNavigation, WebContentSiteNavigation

public class BrowseNavigation
extends WcmPathNavigation

Shows the path and a list of folders and stored searches.


Nested Class Summary
static class BrowseNavigation.BrowseTreeModule
           
static class BrowseNavigation.WcmNavigationPath
          WcmNavigationPath is a vector class of WcmPathEntry items.
static class BrowseNavigation.WcmPathEntry
          Path Entry class contains information about one path item.
 
Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  com.filenet.wcm.apps.server.presentation.ui.ToolBar anchors
          User Anchor List
protected  boolean bHideButtonsInInfo
           
protected  boolean bShowObjectStorePathLink
           
protected  boolean bShowOnlyFolders
           
protected  boolean bShowRoot
           
protected  boolean isWebNavigation
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel objectStoresLabel
           
protected  com.filenet.wcm.apps.server.presentation.ui.PathView pathModule
          User Path
protected  java.lang.String sMode
           
protected  WcmNavigationState state
          Navigation State
static int TOP_FOLDER
          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
BrowseNavigation()
           
 
Method Summary
 void addGetInfoLink()
           
protected  void addShowContentLink()
           
 void callRenderTreeModule(boolean on)
          Deprecated. Sets callRenderTreeModule variable.
 void clearRoot()
          Clears the last call to setRoot(...)
protected  void configPath()
           
protected  void configToolBar()
           
 org.w3c.dom.Document filterContent(org.w3c.dom.Document doc, int filterType, BrowseNavigation.WcmNavigationPath path)
           
 BrowseNavigation.WcmNavigationPath getCurrentPath()
          Will return current WcmFolderNavigation.WcmNavigationPath
protected  boolean getRenderTreeModule()
           
protected  org.w3c.dom.Document getResults(java.lang.String[] props, boolean getFoldersOnly)
           
 boolean getShowContentsLink()
          Returns value of showContentsLink variable.
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 module.
protected  void insertExtraAnchors()
           
protected  boolean isLockedRoot()
           
 void onRefreshPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
          global even handler.
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Sets initial values for rendering of new object in current path.
 void onSelectObjectStore(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
           
 void onSelectRoot(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Resets values to Root values of current main option (Object Stores, My Shortcuts, Site Shortcuts).
 void onShowContents(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Toggles bShowContents flag.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
          Tells that some state has changed
 void onTreeSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void render(java.io.Writer w)
          Renders the class data.
 void resetRoot()
           
protected  void selectObjectStore(java.lang.String objectStoreName)
           
 void setAuthoringDataProvider(com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp)
           
 void setBookmarkPage(boolean on)
          Set to show or hide Printable View Link.
 void setHideButtonsInInfo(boolean on)
          Sets HideButtonsInInfo variable.
 void setMode(java.lang.String mode)
          Sets Mode variable.
 void setNavigationDataProvider(com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider dp)
           
protected  void setPathLabel()
           
 void setRenderActionLinks(boolean on)
           
 void setRenderPathLinks(boolean on)
           
 void setRenderTreeModule(boolean render)
          Turn Tree Module rendering on or off.
 void setResultsFromCachedState(boolean on)
          When true, page will set results from Cached State value.
 void setRoot(java.lang.String sObjectStoreName, java.lang.String sObjectID, int nObjectType, java.lang.String label)
          Sets root of browse path from variables.
 void setRoot(java.lang.String sObjectStoreName, java.lang.String sObjectID, int nObjectType, java.lang.String label, boolean constrain)
          Sets root of browse path from variables.
 void setRootFromPageParameters(boolean on)
          When true, page will get path root from page parameter values.
protected  void setSelectedTreeNode()
           
 void setShowAddBookmarkLink(boolean on)
           
 void setShowAddCustomObjectLink(boolean on)
           
 void setShowAddDocumentLink(boolean on)
           
 void setShowAddShortCutLink(boolean on)
           
 void setShowContentsLink(boolean on)
          When true, page will show "show contents" link.
 void setShowCustomObjects(boolean on)
          When false, listview will not include custom objects
 void setShowExcludedFolderTypes(boolean on)
           
 void setShowOnlyFolders(boolean on)
          When true, page will show folders but not Stored Searches.
 void setShowPrintView(boolean on)
          Set to show or hide Printable View Link.
 void setShowRoot(boolean on)
          Set to show or hide path root.
 void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
           
 void setXML(org.w3c.dom.Document domDocument)
          Sets the source XML as Document.
 
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

TOP_FOLDER

public static final int TOP_FOLDER
top folder

See Also:
Constant Field Values

pathModule

protected com.filenet.wcm.apps.server.presentation.ui.PathView pathModule
User Path


anchors

protected com.filenet.wcm.apps.server.presentation.ui.ToolBar anchors
User Anchor List


state

protected WcmNavigationState state
Navigation State


adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

bShowRoot

protected boolean bShowRoot

bShowOnlyFolders

protected boolean bShowOnlyFolders

bHideButtonsInInfo

protected boolean bHideButtonsInInfo

sMode

protected java.lang.String sMode

bShowObjectStorePathLink

protected boolean bShowObjectStorePathLink

isWebNavigation

protected boolean isWebNavigation

objectStoresLabel

protected com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel objectStoresLabel
Constructor Detail

BrowseNavigation

public BrowseNavigation()
Method Detail

setTree

public void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)

setRenderPathLinks

public void setRenderPathLinks(boolean on)

setShowPrintView

public void setShowPrintView(boolean on)
Set to show or hide Printable View Link.

Parameters:
on -

setBookmarkPage

public void setBookmarkPage(boolean on)
Set to show or hide Printable View Link.

Parameters:
on -

setShowRoot

public void setShowRoot(boolean on)
Set to show or hide path root.

Parameters:
on -

callRenderTreeModule

public void callRenderTreeModule(boolean on)
Deprecated. Sets callRenderTreeModule variable.

Parameters:
on - true/false set variable

setHideButtonsInInfo

public void setHideButtonsInInfo(boolean on)
Sets HideButtonsInInfo variable.

Parameters:
on - true/false set variable

setMode

public void setMode(java.lang.String mode)
Sets Mode variable.

Parameters:
mode - mode value to set

onStateChanged

public void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                    throws java.lang.Exception
Tells that some state has changed

Parameters:
e - Global event
Throws:
java.lang.Exception

onRefreshPage

public void onRefreshPage(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Throws:
java.lang.Exception

clearRoot

public void clearRoot()
               throws java.lang.Exception
Clears the last call to setRoot(...)

Throws:
java.lang.Exception - If there are problems.

getCurrentPath

public BrowseNavigation.WcmNavigationPath getCurrentPath()
Will return current WcmFolderNavigation.WcmNavigationPath


resetRoot

public void resetRoot()
               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 label)
             throws java.lang.Exception
Sets root of browse path from variables.

Parameters:
sObjectStoreName - Id of object store for root
sObjectID - Id of root object
nObjectType - Object type of root object
label - Label of root object
Throws:
java.lang.Exception

setRoot

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

Parameters:
sObjectStoreName - Id of object store for root
sObjectID - Id of root object
nObjectType - Object type of root object
label - Label of root object
constrain - This parameter is used in overided method.
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Description copied from class: WcmPathNavigation
Renders the class data.

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

setRenderTreeModule

public void setRenderTreeModule(boolean render)
Turn Tree Module rendering on or off. When you turn this on, make sure you have setup TreeModule handlers for the following events: eventUrl Handles clicks on the link getChildrenUrl Handles clicks on the plus icon

Parameters:
render - state of Tree Module rendering.

getRenderTreeModule

protected boolean getRenderTreeModule()

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 WcmPathNavigation
Throws:
java.lang.Exception

onReset

public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
             throws java.lang.Exception
global even handler. indicates that user clicked their Home Link so this page needs to be reset to the top level and state information cleared.

Parameters:
evt - - GlobalEven handler
Throws:
java.lang.Exception

selectObjectStore

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

onSelectObjectStore

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

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Sets initial values for rendering of new object in current path.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

onTreeSelect

public void onTreeSelect(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Throws:
java.lang.Exception

isLockedRoot

protected boolean isLockedRoot()

onShowContents

public void onShowContents(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Toggles bShowContents flag.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

onSelectRoot

public void onSelectRoot(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Resets values to Root values of current main option (Object Stores, My Shortcuts, Site Shortcuts).

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

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
Throws:
java.lang.Exception

getResults

protected org.w3c.dom.Document getResults(java.lang.String[] props,
                                          boolean getFoldersOnly)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

setSelectedTreeNode

protected void setSelectedTreeNode()

setPathLabel

protected void setPathLabel()
                     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

configToolBar

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

setXML

public void setXML(org.w3c.dom.Document domDocument)
Sets the source XML as Document.

Parameters:
domDocument - Source XML in DOM Document

insertExtraAnchors

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

configPath

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

addGetInfoLink

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

addShowContentLink

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

setRootFromPageParameters

public void setRootFromPageParameters(boolean on)
When true, page will get path root from page parameter values.

Parameters:
on - sets value

setShowOnlyFolders

public void setShowOnlyFolders(boolean on)
When true, page will show folders but not Stored Searches.

Parameters:
on - sets value

setShowContentsLink

public void setShowContentsLink(boolean on)
When true, page will show "show contents" link.

Parameters:
on - sets value

setShowCustomObjects

public void setShowCustomObjects(boolean on)
When false, listview will not include custom objects

Parameters:
on - sets value

getShowContentsLink

public boolean getShowContentsLink()
                            throws java.lang.Exception
Returns value of showContentsLink variable.

Returns:
showContentsLink value
Throws:
java.lang.Exception - If there are problems retrieving data.

setResultsFromCachedState

public void setResultsFromCachedState(boolean on)
When true, page will set results from Cached State value.

Parameters:
on - sets value

filterContent

public org.w3c.dom.Document filterContent(org.w3c.dom.Document doc,
                                          int filterType,
                                          BrowseNavigation.WcmNavigationPath path)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

setNavigationDataProvider

public void setNavigationDataProvider(com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider dp)

setAuthoringDataProvider

public void setAuthoringDataProvider(com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp)

setShowAddBookmarkLink

public void setShowAddBookmarkLink(boolean on)

setShowAddShortCutLink

public void setShowAddShortCutLink(boolean on)

setShowAddDocumentLink

public void setShowAddDocumentLink(boolean on)

setShowAddCustomObjectLink

public void setShowAddCustomObjectLink(boolean on)

setRenderActionLinks

public void setRenderActionLinks(boolean on)

setShowExcludedFolderTypes

public void setShowExcludedFolderTypes(boolean on)


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