org.kepler.gui

Class MenuMapper

java.lang.Object

org.kepler.gui.MenuMapper

public class MenuMapper
extends java.lang.Object

MenuMapper A menu creation Runnable that creates and adds a new JMenuBar that provides a 'view' (in a loose sense) of the ptii menus. It enumerates all the existing ptii menu items at runtime, and re-uses them, rearranged (and optionally renamed) - all set via mappings in a localizable resourcebundle properties (text) file. If/when new menu items get added to ptii, they are immediately available for use here, just by adding the relevant text mapping to the properties file.

Since:

Author:

Matthew Brooke

Pt.AcceptedRating:

Pt.ProposedRating:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECKBOX_MENUITEM_TYPE
static java.lang.String	MENU_PATH_DELIMITER
static java.lang.String	MENU_SEPARATOR_KEY
static java.lang.String	MENUITEM_TYPE
static java.lang.String	MNEMONIC_SYMBOL
static java.lang.String	NEW_JMENUITEM_KEY

Constructor Summary

Constructors

Constructor and Description
MenuMapper(TableauFrame tableauFrameInstance) constructor

Method Summary

Modifier and Type	Method and Description
static javax.swing.JMenuItem	addMenuFor(java.lang.String key, javax.swing.Action action, javax.swing.JComponent topLvlContainer, java.util.Map<java.lang.String,javax.swing.JMenuItem> keplerMenuMap)
void	clear()
static javax.swing.Action	getActionFor(java.lang.String key, java.util.Map<java.lang.String,javax.swing.Action> menuActionsMap, TableauFrame tableauFrameInstance)
java.util.Map<java.lang.String,javax.swing.Action>	getPTIIMenuActionsMap()
void	init()
void	printDebugInfo() Debugging method
static void	reloadAllMenubars() Remap all open menubars.
void	reloadPtolemyMenus() Remap the menu.
static void	storePTIIMenuItems(javax.swing.JMenuItem nextMenuItem, java.lang.StringBuffer menuPathBuff, java.lang.String MENU_PATH_DELIMITER, java.util.Map<java.lang.String,javax.swing.Action> actionsMap) Recurse through all the submenu heirarchy beneath the passed JMenu parameter, and for each "leaf node" (ie a menu item that is not a container for other menu items), add the Action and its menu path to the passed Map

Methods inherited from class java.lang.Object

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

Field Detail

MENUITEM_TYPE

public static final java.lang.String MENUITEM_TYPE

See Also:

Constant Field Values

CHECKBOX_MENUITEM_TYPE

public static final java.lang.String CHECKBOX_MENUITEM_TYPE

See Also:

Constant Field Values

NEW_JMENUITEM_KEY

public static final java.lang.String NEW_JMENUITEM_KEY

See Also:

Constant Field Values

MENU_PATH_DELIMITER

public static final java.lang.String MENU_PATH_DELIMITER

See Also:

Constant Field Values

MENU_SEPARATOR_KEY

public static final java.lang.String MENU_SEPARATOR_KEY

See Also:

Constant Field Values

MNEMONIC_SYMBOL

public static final java.lang.String MNEMONIC_SYMBOL

See Also:

Constant Field Values

Constructor Detail

MenuMapper

public MenuMapper(TableauFrame tableauFrameInstance)

constructor

Parameters:

ptiiMenubar - JMenuBar the existing ptii menubar containing the original menus

tableauFrameInstance - TableauFrame the frame from which the ptii menu bar will be hidden, and to which the new menu bar will be added

Method Detail

printDebugInfo

public void printDebugInfo()

Debugging method

init

public void init()

getActionFor

public static javax.swing.Action getActionFor(java.lang.String key,
                                              java.util.Map<java.lang.String,javax.swing.Action> menuActionsMap,
                                              TableauFrame tableauFrameInstance)

storePTIIMenuItems

public static void storePTIIMenuItems(javax.swing.JMenuItem nextMenuItem,
                                      java.lang.StringBuffer menuPathBuff,
                                      java.lang.String MENU_PATH_DELIMITER,
                                      java.util.Map<java.lang.String,javax.swing.Action> actionsMap)

Recurse through all the submenu heirarchy beneath the passed JMenu parameter, and for each "leaf node" (ie a menu item that is not a container for other menu items), add the Action and its menu path to the passed Map

Parameters:

nextMenuItem - the JMenu to recurse into

menuPathBuff - a delimited String representation of the hierarchical "path" to this menu item. This will be used as the key in the actionsMap. For example, the "Graph Editor" menu item beneath the "New" item on the "File" menu would have a menuPath of File->New->Graph Editor. Delimeter is "->" (no quotes), and spaces are allowed within menu text strings, but not around the delimiters; i.e: New->Graph Editor is OK, but File ->New is not.

MENU_PATH_DELIMITER - String

actionsMap - the Map containing key => value pairs of the form: menuPath (as described above) => Action (the javax.swing.Action assigned to this menu item)

getPTIIMenuActionsMap

public java.util.Map<java.lang.String,javax.swing.Action> getPTIIMenuActionsMap()

addMenuFor

public static javax.swing.JMenuItem addMenuFor(java.lang.String key,
                                               javax.swing.Action action,
                                               javax.swing.JComponent topLvlContainer,
                                               java.util.Map<java.lang.String,javax.swing.JMenuItem> keplerMenuMap)

clear

public void clear()

reloadAllMenubars

public static void reloadAllMenubars()

Remap all open menubars.

reloadPtolemyMenus

public void reloadPtolemyMenus()

Remap the menu.