Class MenuUtil


  • public class MenuUtil
    extends Object
    Provides utilities and constants for use with the new menus API.
    Since:
    3.3
    Restriction:
    This class is not intended to be subclassed by clients.
    Restriction:
    This class is not intended to be instantiated by clients.
    • Field Detail

      • WORKBENCH_MENU

        public static final String WORKBENCH_MENU
        Workbench Menu. On supported platforms, this menu is shown when no workbench windows are active
        Since:
        3.7
        See Also:
        Constant Field Values
      • QUERY_BEFORE

        public static final String QUERY_BEFORE
        Valid query attribute. Usage menu:menu.id?before=contribution.id.
        Since:
        3.6
        See Also:
        Constant Field Values
      • QUERY_AFTER

        public static final String QUERY_AFTER
        Valid query attribute. Usage menu:menu.id?after=contribution.id.
        Since:
        3.6
        See Also:
        Constant Field Values
      • QUERY_ENDOF

        public static final String QUERY_ENDOF
        Valid query attribute. Usage menu:menu.id?endof=contribution.id.

        This menu contribution will be placed at the end of the group defined by contribution.id (usually right in front of the next group marker or separator). Further contribution processing can still place other contributions after this one.

        Since:
        3.6
        See Also:
        Constant Field Values
      • SHOW_IN_MENU_ID

        public static final String SHOW_IN_MENU_ID
        Contributions of targets to this location will be included with the show in menu.
        Since:
        3.4
        See Also:
        Constant Field Values
    • Constructor Detail

      • MenuUtil

        public MenuUtil()
    • Method Detail

      • menuUri

        public static String menuUri​(String id)
        Parameters:
        id - The menu's id
        Returns:
        The locator URI for a menu with the given id
      • menuAddition

        public static String menuAddition​(String id,
                                          String location,
                                          String refId)
        Parameters:
        id - The id of the menu
        location - The relative location specifier
        refId - The id of the menu element to be relative to
        Returns:
        A location URI formatted with the given parameters
      • menuAddition

        public static String menuAddition​(String id)
        Convenience method to create a standard menu addition The resulting string has the format: "menu:[id]?after=additions"
        Parameters:
        id - The id of the root element to contribute to
        Returns:
        The formatted string
      • toolbarUri

        public static String toolbarUri​(String id)
        Parameters:
        id - The toolbar's id
        Returns:
        The lcoation URI for a toolbar with the given id
      • toolbarAddition

        public static String toolbarAddition​(String id,
                                             String location,
                                             String refId)
        Parameters:
        id - The id of the toolbar
        location - The relative location specifier
        refId - The id of the toolbar element to be relative to
        Returns:
        A location URI formatted with the given parameters
      • toolbarAddition

        public static String toolbarAddition​(String id)
        Convenience method to create a standard toolbar addition The resulting string has the format: "toolbar:[id]?after=additions"
        Parameters:
        id - The id of the root element to contribute to
        Returns:
        The formatted string