view.menuutil.keymainmenu

Class KeyMainMenu

java.lang.Object

view.menuutil.keymainmenu.KeyMainMenu

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

public class KeyMainMenu
extends java.lang.Object
implements java.awt.event.ActionListener

A main menu consisting of key items. Items can be accessed using the associated string keys. The items are added into a given menu bar. Includes are sub menu stack principle to easily create sub menus. An item is always added to a current sub menu and methods are provided to navigate up and down the sub menu stack.

Constructor Summary

Constructors

Constructor and Description
KeyMainMenu(javax.swing.JMenuBar menuBar, MainMenuListener menuListener) Creates an instance with the given values.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent ev)
KeyItem	addItem(java.lang.String key, java.lang.String caption) Creates and returns a new item with the given values and associates it with the given key.
void	addSeparator() Adds a separator line at the current sub menu.
javax.swing.JMenu	createSubMenu(java.lang.String title) Creates an item leading to a new sub menu.
KeyItem	getItem(java.lang.String key) Returns the item which is associated with the given key or null if no such item exists.
void	itemAdded(KeyItem item) Registers the given item's key and adds an action listener to it.
javax.swing.JMenu	nextSubMenu(java.lang.String title) Creates an item leading to a new sub menu one sub menu layer above the current layer.
void	popSubMenu() Sets the current sub menu to the one which is one layer above the current sub menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyMainMenu

public KeyMainMenu(javax.swing.JMenuBar menuBar,
                   MainMenuListener menuListener)

Creates an instance with the given values.

Parameters:

menuBar - the menu bar into which the items are to be added.

menuListener - the listener to add to each added item.

Method Detail

itemAdded

public void itemAdded(KeyItem item)

Registers the given item's key and adds an action listener to it.

addItem

public KeyItem addItem(java.lang.String key,
                       java.lang.String caption)

Creates and returns a new item with the given values and associates it with the given key.

Parameters:

key - the key of the item to create

caption - the caption of the item to create

Returns:

the created item

getItem

public KeyItem getItem(java.lang.String key)

Returns the item which is associated with the given key or null if no such item exists.

createSubMenu

public javax.swing.JMenu createSubMenu(java.lang.String title)

Creates an item leading to a new sub menu. All items that are added after this method call are added within the created sub menu, until nextSubMenu or popSubMenu is called.

Parameters:

title - the caption of the item to create

Returns:

the created sub menu

nextSubMenu

public javax.swing.JMenu nextSubMenu(java.lang.String title)

Creates an item leading to a new sub menu one sub menu layer above the current layer. All items that are added after this method call are added within the created sub menu, until nextSubMenu or popSubMenu is called.

Parameters:

title - the caption of the item to create

Returns:

the created sub menu

addSeparator

public void addSeparator()

Adds a separator line at the current sub menu.

popSubMenu

public void popSubMenu()

Sets the current sub menu to the one which is one layer above the current sub menu.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ev)

Specified by:

actionPerformed in interface java.awt.event.ActionListener