Interface MenuItemComponentDefinition

    • Method Detail

      • getMenuTextMessageKey

        String getMenuTextMessageKey()
        Returns the key in the message properties file of the component which is mapped on the value that is used for the description of the component in the menu structure.
        Returns:
        the key in the message properties file of the component which is mapped on the value that is used for the description of the component in the menu structure
      • getMenuItemPermissions

        Permission[] getMenuItemPermissions()
        Returns all permissions that allow this component to be shown in the menu when assigned.
        Returns:
        all permissions that allow this component to be shown in the menu when assigned
      • getTargetMenu

        @Deprecated
        String getTargetMenu()
        Deprecated.
        Use instead.
        Returns the identifying value of the WebManager menu to which the panel should be added.
        Returns:
        the identifying value of the WebManager menu to which the panel should be added
      • getTargetMenuLocationAfter

        @Deprecated
        String getTargetMenuLocationAfter()
        Deprecated.
        Returns the id of the menu item after which the new menu item should be inserted.
        Returns:
        The id of the menu item after which the new menu item should be inserted
      • getTargetMenuLocationBefore

        @Deprecated
        String getTargetMenuLocationBefore()
        Deprecated.
        Returns the id of the menu item before which the new menu item should be inserted.
        Returns:
        The id of the menu item before which the new menu item should be inserted
      • getSubMenu

        @Deprecated
        String getSubMenu()
        Deprecated.
        Returns a string identifying the sub menu within the target menu where the component will be shown in the menu. If this method returns the same value for one ore more components they will be placed together in the same sub menu.
        Returns:
        A string identifying the sub menu within the target menu where the component will be shown in the menu
      • getSubMenuTextMessageKey

        @Deprecated
        String getSubMenuTextMessageKey()
        Deprecated.
        Returns the key in the message properties file of the component which is mapped on the value that is used for the description of the sub menu within the target menu. If different components return different descriptions one is chosen at random. (The last one registered). If this method returns null and there already is an entry for the sub menu in the menu, the current descriptions will be retained.
        Returns:
        the key in the message properties file of the component which is mapped on the value that is used for the description of the sub menu within the target menu
      • getSubMenuLocationAfter

        @Deprecated
        String getSubMenuLocationAfter()
        Deprecated.
        Returns the id of the menu item in the sub menu after which the new menu item should be inserted.
        Returns:
        the id of the menu item in the sub menu after which the new menu item should be inserted.
      • getSubMenuLocationBefore

        @Deprecated
        String getSubMenuLocationBefore()
        Deprecated.
        Returns the id of the menu item in the sub menu before which the new menu item should be inserted.
        Returns:
        the id of the menu item in the sub menu before which the new menu item should be inserted.