Package io.jans.casa.extension.navigation

Interface NavigationMenu

All Superinterfaces:
org.pf4j.ExtensionPoint
public interface NavigationMenu extends org.pf4j.ExtensionPoint
A pf4j extension point. Classes implementing this interface define the characteristics of one or more navigation menu items that can be added to Gluu Casa UI.
Author:
jgomer

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getContentsUrl()
    Specifies a path that points to the actual contents of the menu items to be added to Casa UI.
    float
    getPriority()
    A value used to determine a relative order among extensions that implement this particular extension point.
    default MenuType
    menuType()
    Specifies the type of menu the extension deals with.

  • Method Details

    • getContentsUrl

      String getContentsUrl()
      Specifies a path that points to the actual contents of the menu items to be added to Casa UI. This can point to a .zul, .jsp or static document relative to the base URL of the plugin to which the extension (that implements this extension point) belongs to.

      As an example, if your Plugin-Id is my-plugin and you want to point to file assests/abc/menu.zul of your maven project (which will be web-accessible via https://host/casa/pl/my-plugin/abc/menu.zul), you'll just have to return abc/menu.zul.

      For more information, visit plugin's developer guide at Jans Casa docs

      Returns:
      The URL that serves the markup of this menu set.

    • getPriority

      float getPriority()
      A value used to determine a relative order among extensions that implement this particular extension point. That is, it determines which menus added by extensions are rendered first (top), second, etc. within the same class (eg. menus targetted at regular users, or for admin dashboard). The first menu to be shown will be that with the greatest priority value and the last menu included will correspond to the one with the lowest.
      Returns:
      A priority value. It is recommended to use values in the interval [0,1].