|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.help.CmsHelpNavigationListView
public final class CmsHelpNavigationListView
Generates a simple TOC - list by using a navigation model
obtained from a
. CmsJspNavBuilder
This is a simpler facade to a fixed html - list based layout. Only a navigation root path and a desired depth have to be set. It is not specific to the online help.
Constructor Summary | |
---|---|
CmsHelpNavigationListView(CmsJspActionElement jsp)
Creates a CmsNaviationListView which uses the given
CmsJspActionElement for accessing the underlying
navigation API. |
|
CmsHelpNavigationListView(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Creates a CmsNaviationListView which creates a
CmsJspActionElement for accessing the underlying
navigation API with the given arguments . |
Method Summary | |
---|---|
java.lang.String |
createNavigation()
Returns a string containing the navigation created by using the internal members. |
int |
getDepth()
Returns the depth in levels of the navigation. |
java.lang.String |
getSiteRootPath()
Returns the navigation root path of the navigation to generate a view for. |
void |
setDepth(int depth)
Set the depth in level of the navigation to generate a view for. |
void |
setNavigationRootPath(java.lang.String navRootPath)
Set the navigation root path of the navigation to generate a view for. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CmsHelpNavigationListView(CmsJspActionElement jsp)
CmsNaviationListView
which uses the given
CmsJspActionElement
for accessing the underlying
navigation API.
jsp
- the CmsJspActionElement
to usepublic CmsHelpNavigationListView(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
CmsNaviationListView
which creates a
CmsJspActionElement
for accessing the underlying
navigation API with the given arguments .
context
- the PageContext
to userequest
- the HttpServletRequest
to useresponse
- the HttpServletResponse
to useMethod Detail |
---|
public java.lang.String createNavigation()
The navigation is a nested html list.
public int getDepth()
public java.lang.String getSiteRootPath()
public void setDepth(int depth)
depth
- the depth in level of the navigation to generate a view for to setpublic void setNavigationRootPath(java.lang.String navRootPath)
The navigation will start there.
navRootPath
- the navigation root path of the navigation to generate a view for to set
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |