Package org.opencms.workplace.help

Class CmsHelpNavigationListView

java.lang.Object
org.opencms.workplace.help.CmsHelpNavigationListView
public final class CmsHelpNavigationListView extends Object
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.

Since:
6.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    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 .
    CmsHelpNavigationListView(org.opencms.jsp.CmsJspActionElement jsp)
    Creates a CmsNaviationListView which uses the given CmsJspActionElement for accessing the underlying navigation API.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createNavigation()
    Returns a string containing the navigation created by using the internal members.
    int
    getDepth()
    Returns the depth in levels of the navigation.
    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(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 Details

    • CmsHelpNavigationListView

      public CmsHelpNavigationListView(org.opencms.jsp.CmsJspActionElement jsp)
      Creates a CmsNaviationListView which uses the given CmsJspActionElement for accessing the underlying navigation API.

      Parameters:
      jsp - the CmsJspActionElement to use

    • CmsHelpNavigationListView

      public 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 .

      Parameters:
      context - the PageContext to use
      request - the HttpServletRequest to use
      response - the HttpServletResponse to use

  • Method Details

    • createNavigation

      public String createNavigation()
      Returns a string containing the navigation created by using the internal members.

      The navigation is a nested html list.

      Returns:
      a string containing the navigation created by using the internal members

    • getDepth

      public int getDepth()
      Returns the depth in levels of the navigation.

      Returns:
      the depth in levels of the navigation.

    • getSiteRootPath

      public String getSiteRootPath()
      Returns the navigation root path of the navigation to generate a view for.

      Returns:
      the navigation root path of the navigation to generate a view for.

    • setDepth

      public void setDepth(int depth)
      Set the depth in level of the navigation to generate a view for.

      Parameters:
      depth - the depth in level of the navigation to generate a view for to set

    • setNavigationRootPath

      public void setNavigationRootPath(String navRootPath)
      Set the navigation root path of the navigation to generate a view for.

      The navigation will start there.

      Parameters:
      navRootPath - the navigation root path of the navigation to generate a view for to set