com.canto.cumulus.ui

Class MenuBar

java.lang.Object

com.canto.cumulus.ui.MenuBar

public class MenuBar
extends java.lang.Object

The MenuBar object allows you to access and modify the application's menus. The application has one unique instance of menu bar. A menu bar consists of menus.

Since:

EJaP 6.0.0

Method Summary

Methods

Modifier and Type	Method and Description
void	addMenu(int index, Menu menu) Adds a menu by index.
void	addMenu(Menu menu) Adds a menu at the end of the menu bar.
int	countMenus() Returns the number of menus in this menu bar.
Menu	findMenu(int id) Returns a menu based on its ID.
MenuItem	findMenuItem(int command) Returns a menu item based on it's command.
Menu	getMenu(int index) Returns a menu by index.
Menu	getMenu(java.lang.String name) Returns a menu by name.
Menu	getMenuByID(int id) Returns a menu by ID.
java.lang.Object	getParent() Returns the parent object for this object.
void	removeMenu(Menu menu) Removes a menu from the menu bar.
void	removeMenuAt(int index) Removes a menu by index.
void	removeMenuByID(int id) Removes a menu by ID.

Methods inherited from class java.lang.Object

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

Method Detail

getParent

public java.lang.Object getParent()

Returns the parent object for this object.

Returns:

the Application's instance.

countMenus

public int countMenus()

Returns the number of menus in this menu bar.

Returns:

the number of menus in this menu bar.

getMenu

public Menu getMenu(int index)

Returns a menu by index.

Parameters:

index - the index of the menu in the menu bar.

Returns:

a menu by index.

getMenu

public Menu getMenu(java.lang.String name)
             throws CumulusException

Returns a menu by name. Since several menu can have the same same, the first menu matching the given name will be returned. Matching names may not necessarily contain the & modifier on Win32 platforms.

Parameters:

name - the name of the menu.

Returns:

a menu by name.

Throws:

CumulusException - if the specified menu is not in the menu bar.

See Also:

Menu.getName()

getMenuByID

public Menu getMenuByID(int id)
                 throws CumulusException

Returns a menu by ID.

Parameters:

id - the menu ID.

Returns:

a menu by ID.

Throws:

CumulusException - if the specified menu is not in the menu bar.

addMenu

public void addMenu(Menu menu)

Adds a menu at the end of the menu bar.

Parameters:

menu - the menu to add.

addMenu

public void addMenu(int index,
           Menu menu)

Adds a menu by index.

Parameters:

index - the index where to add the menu.

menu - the menu to add.

removeMenu

public void removeMenu(Menu menu)
                throws CumulusException

Removes a menu from the menu bar.

Parameters:

menu - the menu to remove.

Throws:

CumulusException - if the specified menu is not in the menu bar.

removeMenuAt

public void removeMenuAt(int index)

Removes a menu by index.

Parameters:

index - the index of the menu to remove.

removeMenuByID

public void removeMenuByID(int id)
                    throws CumulusException

Removes a menu by ID.

Parameters:

id - the ID of the menu to remove.

Throws:

CumulusException - if the specified menu is not in the menu bar.

findMenu

public Menu findMenu(int id)

Returns a menu based on its ID.

Parameters:

id - the menu ID.

Returns:

a menu based on its ID or null if no such menu exists in the menu bar.

findMenuItem

public MenuItem findMenuItem(int command)

Returns a menu item based on it's command.

Parameters:

command - the menu item command.

Returns:

a menu item based on it's command or null if no such item exists in the menu bar.