Package docking.menu

Class MenuGroupMap

  • public class MenuGroupMap
extends java.lang.Object
    Maps menuPaths to groups

    • Constructor Summary

      Constructors 
      Constructor Description
      MenuGroupMap()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getMenuGroup​(java.lang.String[] menuPath)
      Returns the group for the given menu path
      java.lang.String getMenuSubGroup​(java.lang.String[] menuPath)
      Returns the menu subgroup string for the given menu path.
      void setMenuGroup​(java.lang.String[] menuPath, java.lang.String group, java.lang.String menuSubGroup)
      Sets the group for the given menuPath

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MenuGroupMap

        public MenuGroupMap()

    • Method Detail

      • setMenuGroup

        public void setMenuGroup​(java.lang.String[] menuPath,
                         java.lang.String group,
                         java.lang.String menuSubGroup)
        Sets the group for the given menuPath
        Parameters:
        menuPath - the menuPath for which to assign a group
        group - the name of the group for the action with the given menu path
        menuSubGroup - the name used for sorting items in the same group. If this value is MenuData.NO_SUBGROUP, then sorting is based upon the name of the menu item.

      • getMenuGroup

        public java.lang.String getMenuGroup​(java.lang.String[] menuPath)
        Returns the group for the given menu path
        Parameters:
        menuPath - the menu path for which to find its group
        Returns:
        the menu group

      • getMenuSubGroup

        public java.lang.String getMenuSubGroup​(java.lang.String[] menuPath)
        Returns the menu subgroup string for the given menu path. This string is used to perform sorting of menu items that exist in the same group.
        Parameters:
        menuPath - the menu path for which to find its group
        Returns:
        the menu sub-group