org.trianacode.gui.hci

Class MenuMnemonics

java.lang.Object

org.trianacode.gui.hci.MenuMnemonics

public class MenuMnemonics
extends java.lang.Object

A utility class that handles setting mnemonics for menu items so that we don't get duplicated items.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignAMnemonic(javax.swing.JMenuItem m, javax.swing.JMenu menu, java.lang.String name)
javax.swing.JCheckBoxMenuItem	createCheckBoxMenuItem(java.lang.String name, javax.swing.JMenu menu, java.awt.event.ItemListener target) Convenience method for creating a check box menu item.
javax.swing.JMenu	createMenu(java.lang.String name) Convenience method for creating a menu.
javax.swing.JMenuItem	createMenuItem(java.lang.String name, javax.swing.JMenu menu, java.awt.event.ActionListener target) Convenience method for creating a menu item.
static MenuMnemonics	getInstance()
char	getNextMnemonic(javax.swing.JMenu parentMenu, java.lang.String name)
char	getNextMnemonic(java.lang.String menuName)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MenuMnemonics getInstance()

createMenu

public javax.swing.JMenu createMenu(java.lang.String name)

Convenience method for creating a menu. This function creates the menu and sets the Mnemonic for the menu to the first letter of the name for the menu

getNextMnemonic

public char getNextMnemonic(java.lang.String menuName)

Parameters:

menuName - The name of the JMenu

Returns:

The mnemonic for the JMenu that goes by this name

createMenuItem

public javax.swing.JMenuItem createMenuItem(java.lang.String name,
                                   javax.swing.JMenu menu,
                                   java.awt.event.ActionListener target)

Convenience method for creating a menu item. This function creates the menu and sets the Mnemonic (see below) for the menu . It then adds the menu item to the specified menu and sets the recevier of the actions from this menu item to the specified target.

createCheckBoxMenuItem

public javax.swing.JCheckBoxMenuItem createCheckBoxMenuItem(java.lang.String name,
                                                   javax.swing.JMenu menu,
                                                   java.awt.event.ItemListener target)

Convenience method for creating a check box menu item. This function creates the menu and sets the Mnemonic (see below) for the menu . It then adds the menu item to the specified menu and sets the recevier of the actions from this menu item to the specified target.

assignAMnemonic

public void assignAMnemonic(javax.swing.JMenuItem m,
                   javax.swing.JMenu menu,
                   java.lang.String name)

getNextMnemonic

public char getNextMnemonic(javax.swing.JMenu parentMenu,
                   java.lang.String name)

Parameters:

parentMenu - the parent JMenu

name - the name of the menu item

Returns:

the next mnemonic for a menuitem