|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmXSLModule
com.filenet.wcm.apps.server.presentation.ui.GenericListView
com.filenet.wcm.apps.server.ui.WcmGenericListView
com.filenet.wcm.apps.server.ui.WcmNavigationListView
com.filenet.wcm.apps.server.ui.WcmPathNavigation
com.filenet.wcm.apps.server.ui.nav.BrowseNavigation
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 |
public static final int TOP_FOLDER
protected com.filenet.wcm.apps.server.presentation.ui.PathView pathModule
protected com.filenet.wcm.apps.server.presentation.ui.ToolBar anchors
protected WcmNavigationState state
protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
protected boolean bShowRoot
protected boolean bShowOnlyFolders
protected boolean bHideButtonsInInfo
protected java.lang.String sMode
protected boolean bShowObjectStorePathLink
protected boolean isWebNavigation
protected com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel objectStoresLabel
Constructor Detail |
public BrowseNavigation()
Method Detail |
public void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
public void setRenderPathLinks(boolean on)
public void setShowPrintView(boolean on)
on
- public void setBookmarkPage(boolean on)
on
- public void setShowRoot(boolean on)
on
- public void callRenderTreeModule(boolean on)
on
- true/false set variablepublic void setHideButtonsInInfo(boolean on)
on
- true/false set variablepublic void setMode(java.lang.String mode)
mode
- mode value to setpublic void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e) throws java.lang.Exception
e
- Global event
java.lang.Exception
public void onRefreshPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void clearRoot() throws java.lang.Exception
java.lang.Exception
- If there are problems.public BrowseNavigation.WcmNavigationPath getCurrentPath()
public void resetRoot() throws java.lang.Exception
java.lang.Exception
public void setRoot(java.lang.String sObjectStoreName, java.lang.String sObjectID, int nObjectType, java.lang.String label) throws java.lang.Exception
sObjectStoreName
- Id of object store for rootsObjectID
- Id of root objectnObjectType
- Object type of root objectlabel
- Label of root object
java.lang.Exception
public void setRoot(java.lang.String sObjectStoreName, java.lang.String sObjectID, int nObjectType, java.lang.String label, boolean constrain) throws java.lang.Exception
sObjectStoreName
- Id of object store for rootsObjectID
- Id of root objectnObjectType
- Object type of root objectlabel
- Label of root objectconstrain
- This parameter is used in overided method.
java.lang.Exception
public void render(java.io.Writer w) throws java.lang.Exception
WcmPathNavigation
render
in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
render
in class WcmPathNavigation
w
- Writer for writing to the response object.
java.lang.Exception
- If there are problems.public void setRenderTreeModule(boolean render)
render
- state of Tree Module rendering.protected boolean getRenderTreeModule()
public void initialize() throws java.lang.Exception
WcmPathNavigation
initialize
in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
initialize
in class WcmPathNavigation
java.lang.Exception
public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt) throws java.lang.Exception
evt
- - GlobalEven handler
java.lang.Exception
protected void selectObjectStore(java.lang.String objectStoreName) throws java.lang.Exception
java.lang.Exception
public void onSelectObjectStore(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt) throws java.lang.Exception
java.lang.Exception
public void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onTreeSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
protected boolean isLockedRoot()
public void onShowContents(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onSelectRoot(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.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
java.lang.Exception
protected org.w3c.dom.Document getResults(java.lang.String[] props, boolean getFoldersOnly) throws java.lang.Exception
java.lang.Exception
protected void setSelectedTreeNode()
protected void setPathLabel() throws java.lang.Exception
java.lang.Exception
public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
protected void configToolBar() throws java.lang.Exception
java.lang.Exception
public void setXML(org.w3c.dom.Document domDocument)
domDocument
- Source XML in DOM Documentprotected void insertExtraAnchors() throws java.lang.Exception
java.lang.Exception
protected void configPath() throws java.lang.Exception
java.lang.Exception
public void addGetInfoLink() throws java.lang.Exception
java.lang.Exception
protected void addShowContentLink() throws java.lang.Exception
java.lang.Exception
public void setRootFromPageParameters(boolean on)
on
- sets valuepublic void setShowOnlyFolders(boolean on)
on
- sets valuepublic void setShowContentsLink(boolean on)
on
- sets valuepublic void setShowCustomObjects(boolean on)
on
- sets valuepublic boolean getShowContentsLink() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data.public void setResultsFromCachedState(boolean on)
on
- sets valuepublic org.w3c.dom.Document filterContent(org.w3c.dom.Document doc, int filterType, BrowseNavigation.WcmNavigationPath path) throws java.lang.Exception
java.lang.Exception
public void setNavigationDataProvider(com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider dp)
public void setAuthoringDataProvider(com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp)
public void setShowAddBookmarkLink(boolean on)
public void setShowAddShortCutLink(boolean on)
public void setShowAddDocumentLink(boolean on)
public void setShowAddCustomObjectLink(boolean on)
public void setRenderActionLinks(boolean on)
public void setShowExcludedFolderTypes(boolean on)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |