MenuItem (Cumulus Java Classes Documentation)

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

```
public class MenuItem
extends BaseUIObject
```
A MenuItem is an entry in a Menu. An ActionHandler can be attached to a menu item which will be called when the item is selected.

Since:

EJaP 6.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MODIFIER_ALT` The Alt modifier
`static int`	`MODIFIER_CTRL` The Ctrl Modifier
`static int`	`MODIFIER_NONE` No modifier
`static int`	`MODIFIER_SHIFT` The Shift modifier.

Constructor Summary

Constructors
Constructor and Description

MenuItem()
Creates a new separator.

MenuItem(java.lang.String name)
Creates a new menu item with the specified name.

Constructors
Constructor and Description
`MenuItem()` Creates a new separator.
`MenuItem(java.lang.String name)` Creates a new menu item with the specified name.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getActionCommand()` Returns the menu item action command.
`ActionHandler`	`getActionHandler()` Returns the action handler associated with this item.
`int`	`getCommand()` Returns the menu item command.
`Menu`	`getMenu()` Returns the menu to which this item is attached.
`java.lang.String`	`getName()` Returns the menu item text.
`char`	`getShortcut()` Returns the shortcut key to activate the item.
`int`	`getShortcutModifier()` Returns the shortcut key modifier.
`Menu`	`getSubMenu()` Returns the sub menu attached to this menu item.
`boolean`	`hasSubMenu()` Returns whether this menu item has a submenu.
`boolean`	`isChecked()` Returns whether this menu item is checked.
`boolean`	`isEnabled()` Returns whether this menu item is enabled.
`boolean`	`isSeparator()` Returns whether this menu item is a separator.
`void`	`setActionCommand(java.lang.String actionCommand)` Sets the menu item action command.
`ActionHandler`	`setActionHandler(ActionHandler handler)` Associates an action handler to the item.
`void`	`setChecked(boolean checked)` Checks or unchecks a menu item.
`void`	`setEnabled(boolean enabled)` Enables or disables a menu item.
`void`	`setName(java.lang.String name)` Sets the menu item text.
`void`	`setShortcut(char key, int modifier)` Sets the shortcut key to activate the item.

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

- Field Detail
  - MODIFIER_NONE
```
public static final int MODIFIER_NONE
```
    No modifier
    
    See Also:
    Constant Field Values
  - MODIFIER_SHIFT
```
public static final int MODIFIER_SHIFT
```
    The Shift modifier.
    
    See Also:
    Constant Field Values
  - MODIFIER_ALT
```
public static final int MODIFIER_ALT
```
    The Alt modifier
    
    See Also:
    Constant Field Values
  - MODIFIER_CTRL
```
public static final int MODIFIER_CTRL
```
    The Ctrl Modifier
    
    See Also:
    Constant Field Values
- Constructor Detail
  - MenuItem
```
public MenuItem(java.lang.String name)
```
    Creates a new menu item with the specified name. Note: on Win32 platforms, the item name can contain the & modifier to underline item letters.
    
    Parameters:
    name - the name of the item as it appears in the menu.
  - MenuItem
```
public MenuItem()
```
    Creates a new separator.
- Method Detail
  - isEnabled
```
public boolean isEnabled()
```
    Returns whether this menu item is enabled.
    
    Returns:
    true if the item is enabled; false otherwise.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Enables or disables a menu item.
    
    Parameters:
    enabled - true if the item should be enabled; false otherwise.
  - isChecked
```
public boolean isChecked()
```
    Returns whether this menu item is checked.
    
    Returns:
    true if the item is checked; false otherwise.
    Since:
    
    7.5
  - setChecked
```
public void setChecked(boolean checked)
```
    Checks or unchecks a menu item.
    
    Parameters:
    checked - true if the item should be checked; false otherwise.
    Since:
    
    7.5
  - isSeparator
```
public boolean isSeparator()
```
    Returns whether this menu item is a separator.
    
    Returns:
    true if the menu item is a separator; false otherwise.
  - getActionCommand
```
public java.lang.String getActionCommand()
```
    Returns the menu item action command.
    
    Returns:
    a string that specifies a command associated with the item.
  - setActionCommand
```
public void setActionCommand(java.lang.String actionCommand)
```
    Sets the menu item action command.
    
    Parameters:
    actionCommand - a string that may specify a command associated with the item.
  - getCommand
```
public int getCommand()
```
    Returns the menu item command. A menu item has a unique command ID.
    
    Returns:
    the menu item command.
  - getName
```
public java.lang.String getName()
```
    Returns the menu item text. Note: on Win32 platforms, the item text can contain the & modifier to underline some letters.
    
    Returns:
    the menu item text.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the menu item text. Note: on Win32 platforms, the item text can contain the & modifier to underline some letters.
    
    Parameters:
    name - the menu item text.
  - hasSubMenu
```
public boolean hasSubMenu()
```
    Returns whether this menu item has a submenu.
    
    Returns:
    true if the menu item has a submenu; false otherwise.
  - getSubMenu
```
public Menu getSubMenu()
```
    Returns the sub menu attached to this menu item.
    
    Returns:
    the sub menu attached to this menu item or null if the item has no sub menu.
  - getMenu
```
public Menu getMenu()
```
    Returns the menu to which this item is attached.
    
    Returns:
    the menu to which this item is attached or null if the item is not attached to any menu yet.
  - getShortcut
```
public char getShortcut()
```
    Returns the shortcut key to activate the item. On Win32 platforms shortcuts are always uppercase keys.
    
    Returns:
    the shortcut key to activate the item.
  - getShortcutModifier
```
public int getShortcutModifier()
```
    Returns the shortcut key modifier.
    
    Returns:
    the shortcut key modifier.
  - setShortcut
```
public void setShortcut(char key,
               int modifier)
```
    Sets the shortcut key to activate the item.
    
    Parameters:
    key - shortcut key to activate the item. On Win32 platforms shortcuts are always uppercase keys.
    modifier - a bit combination that indicates the modifier keys.
  - setActionHandler
```
public ActionHandler setActionHandler(ActionHandler handler)
```
    Associates an action handler to the item. One and only one action handler can be associated to an item.
    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);
 
      public void handleAction (ActionEvent e)
      {
          MenuItem item = (MenuItem) e.getSource();
          String cmd = item.getActionCommand();
 

          if (cmd.equals("MyCommand"))
          {
              JOptionPane.showMessageDialog(null, "Item " + item + " was clicked\n");
          }
      }
      ...
 }
 
```
    Parameters:
    handler - the action handler to associate to the item.
    
    Returns:
    the previous action handler that was associated with the item.
  - getActionHandler
```
public ActionHandler getActionHandler()
```
    Returns the action handler associated with this item.
    
    Returns:
    the action handler associated with this item.

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 MenuItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODIFIER_NONE

MODIFIER_SHIFT

MODIFIER_ALT

MODIFIER_CTRL

Constructor Detail

MenuItem

MenuItem

Method Detail

isEnabled

setEnabled

isChecked

setChecked

isSeparator

getActionCommand

setActionCommand

getCommand

getName

setName

hasSubMenu

getSubMenu

getMenu

getShortcut

getShortcutModifier

setShortcut

setActionHandler

getActionHandler