Menu (Cumulus Java Classes Documentation)

java.lang.Object
- BaseUIObject
- - com.canto.cumulus.ui.Menu

```
public class Menu
extends BaseUIObject
```
The Menu object represents a menu entry in the application menu bar, a contextual menu or a sub menu. A menu consist of a name, and contains menu items which can be added or removed.

Since:

EJaP 6.0.0

Constructor Summary

Constructors
Constructor and Description

Menu(java.lang.String name)
Default constructor.

Constructors
Constructor and Description
`Menu(java.lang.String name)` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMenuItem(int index, MenuItem item)` Adds a menu item at the specified index.
`void`	`addMenuItem(MenuItem item)` Adds a menu item at the end of the menu.
`void`	`addSeparator()` Adds a separator at the end of the menu.
`void`	`addSeparator(int index)` Adds a separator at the specified index.
`void`	`addSubMenu(int index, Menu subMenu)` Adds a sub menu at the specified index.
`void`	`addSubMenu(Menu subMenu)` Adds a sub menu at the end of the menu.
`int`	`countMenuItems()` Returns the number of menu items in this menu.
`MenuItem`	`findMenuItem(int command)` Returns a menu item based on it's command.
`int`	`getID()` Returns the menu ID.
`MenuItem`	`getMenuItem(int index)` Returns a menu item by index.
`MenuItem`	`getMenuItem(java.lang.String name)` Returns a menu item by name.
`MenuItem`	`getMenuItemByID(int command)` Returns a menu item by ID.
`java.lang.String`	`getName()` Returns the menu name.
`java.lang.Object`	`getParent()` Returns the parent object for this object.
`boolean`	`isEnabled()` Returns the state of this menu.
`void`	`removeMenuItem(MenuItem item)` Removes a menu item.
`void`	`removeMenuItemAt(int index)` Removes a menu item by index.
`void`	`removeMenuItemByID(int command)` Removes a menu item by ID.
`void`	`setEnabled(boolean bEnabled)` Enables or disables a menu.
`void`	`setName(java.lang.String name)` Sets the menu name.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Menu
```
public Menu(java.lang.String name)
```
    Default constructor.
    
    Parameters:
    name - the menu title as it appears in the menu bar.
- Method Detail
  - countMenuItems
```
public int countMenuItems()
```
    Returns the number of menu items in this menu.
    
    Returns:
    the number of menu items in this menu.
  - getMenuItem
```
public MenuItem getMenuItem(int index)
```
    Returns a menu item by index.
    
    Parameters:
    index - the index of the menu item.
    
    Returns:
    a menu item by index.
  - getMenuItem
```
public MenuItem getMenuItem(java.lang.String name)
                     throws CumulusException
```
    Returns a menu item by name. Since several menu items can have the same same, the first item matching the given name will be returned. Matching names may not necessarily contain the & modifier on Win32 platforms.
    
    Parameters:
    name - the menu item name.
    
    Returns:
    a menu item by name.
    
    Throws:
    
    CumulusException - if the specified item name doesn't exits.
    See Also:
    MenuItem.getName()
  - findMenuItem
```
public MenuItem findMenuItem(int command)
```
    Returns a menu item based on it's command.
    
    Parameters:
    command - the menu item command.
    
    Returns:
    a menu item based on it's command or null if no such item exists in the menu.
    Since:
    
    EJaP 6.5
  - getMenuItemByID
```
public MenuItem getMenuItemByID(int command)
                         throws CumulusException
```
    Returns a menu item by ID. The ID of an item can be obtain by using MenuItem.getCommand().
    
    Parameters:
    command - the menu item ID.
    
    Returns:
    a menu item by ID.
    
    Throws:
    
    CumulusException - if the specified item ID doesn't exits.
  - addMenuItem
```
public void addMenuItem(MenuItem item)
```
    Adds a menu item at the end of the menu.
    For example:
```
 class MyClass implements ActionHandler
 {
      ...
      MenuItem item = new MenuItem("MyItem");
      item.setActionCommand("MyCommand");
      item.setActionHandler(this);
      Application.getInstance().getMenuBar().getMenu(Application.MENU_MID_FILE_MENU).addMenuItem(item);
      ...
 }
 
```
    Parameters:
    item - the menu item to add.
  - addMenuItem
```
public void addMenuItem(int index,
               MenuItem item)
```
    Adds a menu item at the specified index.
    
    Parameters:
    index - the index of the menu item to add.
    item - the menu item to add.
  - addSeparator
```
public void addSeparator()
```
    Adds a separator at the end of the menu.
  - addSeparator
```
public void addSeparator(int index)
```
    Adds a separator at the specified index.
    
    Parameters:
    index - the index of the separator to add.
  - addSubMenu
```
public void addSubMenu(Menu subMenu)
```
    Adds a sub menu at the end of the menu.
    For example:
```
 class MyClass implements ActionHandler
 {
      ...
      Menu menu = new Menu("MyMenu");
      MenuItem item = new MenuItem("MyItem");
      ...
      menu.addMenuItem(item);
      Application.getInstance().getMenuBar().getMenu(Application.MENU_MID_FILE_MENU).addSubMenu(menu);
      ...
 }
 
```
    Parameters:
    subMenu - the sub menu to add.
  - addSubMenu
```
public void addSubMenu(int index,
              Menu subMenu)
```
    Adds a sub menu at the specified index.
    
    Parameters:
    index - the index of the sub menu to add.
    subMenu - the sub menu to add.
  - removeMenuItem
```
public void removeMenuItem(MenuItem item)
                    throws CumulusException
```
    Removes a menu item.
    
    Parameters:
    item - the menu item to remove.
    
    Throws:
    
    CumulusException - the specified item is not in the menu.
  - removeMenuItemAt
```
public void removeMenuItemAt(int index)
```
    Removes a menu item by index.
    
    Parameters:
    index - the index of the item to remove.
  - removeMenuItemByID
```
public void removeMenuItemByID(int command)
                        throws CumulusException
```
    Removes a menu item by ID.
    
    Parameters:
    command - the ID of the item to remove.
    
    Throws:
    
    CumulusException - the specified item is not in the menu.
  - getName
```
public java.lang.String getName()
```
    Returns the menu name. Note: on Win32 platforms, the menu name can contain the & modifier to underline some letters.
    
    Returns:
    the menu name.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the menu name. Note: on Win32 platforms, the menu name can contain the & modifier to underline some letters.
    
    Parameters:
    name - the menu name.
  - isEnabled
```
public boolean isEnabled()
```
    Returns the state of this menu.
    
    Returns:
    true if the menu is enabled; false otherwise.
  - setEnabled
```
public void setEnabled(boolean bEnabled)
```
    Enables or disables a menu.
    
    Parameters:
    bEnabled - true if the menu should be enabled; false otherwise.
  - getID
```
public int getID()
```
    Returns the menu ID.
    
    Returns:
    the menu ID.
  - getParent
```
public java.lang.Object getParent()
```
    Returns the parent object for this object.
    
    Returns:
    the MenuBar's instance or the MenuItem if the menu is a sub menu.

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class Menu

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Menu

Method Detail

countMenuItems

getMenuItem

getMenuItem

findMenuItem

getMenuItemByID

addMenuItem

addMenuItem

addSeparator

addSeparator

addSubMenu

addSubMenu

removeMenuItem

removeMenuItemAt

removeMenuItemByID

getName

setName

isEnabled

setEnabled

getID

getParent