Package com.atlassian.confluence.web

Interface WebMenuManager

All Known Implementing Classes:
ConfluenceWebMenuManager
public interface WebMenuManager

  • Method Details

    • getMenu

      WebMenu getMenu(String id, String menuKey, WebInterfaceContext context)
      Builds and returns a WebMenu for display with the given properties and context.

      WebMenuSection)s with no menu items are not included in the final menu returned.

      Parameters:
      id - the id of the menu
      menuKey - the web section key of the menu being built (see DynamicWebInterfaceManager)
      context - the context in which the menu is being built in
      Returns:
      WebMenu which can be used for display

    • getMenu

      default WebMenu getMenu(Collection<String> menuKeys, WebInterfaceContext context)
      Builds and returns a WebMenu for display with the given properties and context. This method takes in a list of menu keys to allow for building a combination of menus.

      WebMenuSection)s with no menu items are not included in the final menu returned.

      Parameters:
      menuKeys - the web section keys of the menu being built with (see DynamicWebInterfaceManager)
      context - the context in which the menu is being built in
      Returns:
      WebMenu which can be used for display

    • getMenu

      WebMenu getMenu(String id, Collection<String> menuKeys, WebInterfaceContext context)
      Builds and returns a WebMenu for display with the given properties and context. This method takes in a list of menu keys to allow for building a combination of menus.

      WebMenuSection)s with no menu items are not included in the final menu returned.

      Parameters:
      id - the id of the menu
      menuKeys - the web section keys of the menu being built with (see DynamicWebInterfaceManager)
      context - the context in which the menu is being built in
      Returns:
      WebMenu which can be used for display