Package ca.phon.ui.menu

Class MenuBuilder

java.lang.Object

ca.phon.ui.menu.MenuBuilder

public final class MenuBuilder
extends Object

Helper class for building menus. Menus items are 'addressed' using paths. Paths are alphanumeric sequences separated by '/'. Each section of the path is path of the menu hierarchy, with the final item naming the terminating menu/menu item.

Example paths:

• File
  The file menu.
• View/Record Data/My Item
  The item with name 'My Item' in the View/Record Data' menu.

When adding a MenuElement, location of the element may be specified in the path by adding the '@' token followed by

• ^ - place new element at beginning of this menu
• $ - place new element at end of the menu (default behaviour)
• item name - place after given item name (or end if not found)

E.g., To add a new item to the beginning of the File menu, use the path File@^ in the path given to the addMenu(String, String) and addItem(String, Action) methods.

Menu builders may be attached to existing menus, in which case existing menu items may be addressed using the scheme above. Menu items are typically added 'before' or 'after' existing items.

Constructor Summary

Constructors

Constructor	Description
MenuBuilder()
MenuBuilder(MenuElement root)

Method Summary

Modifier and Type	Method	Description
JMenuItem	addItem(String path, String text)
JMenuItem	addItem(String path, Action action)
void	addItem(String path, JMenuItem menuItem)
void	addItem(String path, MenuElement ele)
void	addItem(MenuElement elem, int insertIdx, MenuElement menuItem)
JMenu	addMenu(String path, String text)
void	addMenu(String path, JMenu menu)
JMenu	addMenu(MenuElement elem, int insertIdx, String text)
void	addSeparator(String path, String sepName)
void	appendSubItems(String path, MenuElement menu)	Append all subitems from the given MenuElement at the provied path.
void	appendSubItems(MenuElement parent, String path, MenuElement menu)
JMenu	getMenu(String path)
MenuElement	getRoot()
void	removeAll()	Clear root menu element

Methods inherited from class java.lang.Object

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

Constructor Details

MenuBuilder

public MenuBuilder()

MenuBuilder

public MenuBuilder(MenuElement root)

Method Details

getRoot

public MenuElement getRoot()

removeAll

public void removeAll()

Clear root menu element

addMenu

public JMenu addMenu(String path,
 String text)

addMenu

public void addMenu(String path,
 JMenu menu)

getMenu

public JMenu getMenu(String path)

addMenu

public JMenu addMenu(MenuElement elem,
 int insertIdx,
 String text)

addSeparator

public void addSeparator(String path,
 String sepName)

addItem

public JMenuItem addItem(String path,
 String text)

addItem

public void addItem(String path,
 JMenuItem menuItem)

addItem

public JMenuItem addItem(String path,
 Action action)

addItem

public void addItem(String path,
 MenuElement ele)

addItem

public void addItem(MenuElement elem,
 int insertIdx,
 MenuElement menuItem)

appendSubItems

public void appendSubItems(String path,
 MenuElement menu)

Append all subitems from the given MenuElement at the provied path.

Parameters:

path -

menu -

appendSubItems

public void appendSubItems(MenuElement parent,
 String path,
 MenuElement menu)