Package docking.menu

# Class MenuGroupMap

java.lang.Object
docking.menu.MenuGroupMap

public class MenuGroupMap extends Object
Maps menuPaths to groups

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `MenuGroupMap()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getMenuGroup(String[] menuPath)`
  Returns the group for the given menu path
  `String`
  `getMenuSubGroup(String[] menuPath)`
  Returns the menu subgroup string for the given menu path.
  `void`
  `setMenuGroup(String[] menuPath, String group, 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 Details

  - ### MenuGroupMap

    public MenuGroupMap()

- ## Method Details

  - ### setMenuGroup

    public void setMenuGroup(String[] menuPath, String group, 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 String getMenuGroup(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 String getMenuSubGroup(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