Interface NavbarInterface

All Known Implementing Classes:
NavbarRDF, NavbarSchemaOrg, NavbarStandard

public interface NavbarInterface
Interface for custom navbar implementations. Clients can implement this interface to provide custom navbar formatting. The implementation class name should be set in Constants.getString("navbarDefaultType").
  • Method Summary

    Modifier and Type
    Method
    Description
    getNavbar(int groupId, int docId, javax.servlet.http.HttpServletRequest request)
    Generates navbar (breadcrumb navigation)
    getNavbarForNonDefaultDoc(DocDetails doc, String navbarHtml, javax.servlet.http.HttpServletRequest request)
    Generates navbar for a document if current doc is not default doc of last group in navbar This will be added to navbar generated by getNavbar method
  • Method Details

    • getNavbar

      String getNavbar(int groupId, int docId, javax.servlet.http.HttpServletRequest request)
      Generates navbar (breadcrumb navigation)
      Parameters:
      groupId - - ID of the directory/group
      docId - - ID of current web page
      request - - HTTP request
      Returns:
      HTML code for breadcrumb navigation
    • getNavbarForNonDefaultDoc

      String getNavbarForNonDefaultDoc(DocDetails doc, String navbarHtml, javax.servlet.http.HttpServletRequest request)
      Generates navbar for a document if current doc is not default doc of last group in navbar This will be added to navbar generated by getNavbar method
      Parameters:
      doc - - document details
      navbarHtml - - existing navbar HTML
      request -
      Returns: