org.jowidgets.api.widgets

Interface IMenuBar

All Superinterfaces:

IDisposeObservable, IMenuBarCommon, IWidget, IWidgetCommon

All Known Implementing Classes:

JoMenuBar

public interface IMenuBar
extends IWidget, IMenuBarCommon

Method Summary

Methods

Modifier and Type	Method and Description
IMainMenu	addMenu(IMainMenuDescriptor descriptor) Adds a menu to the menu bar
IMainMenu	addMenu(int index, IMainMenuDescriptor descriptor) Adds a menu to the menu bar at a given index
IMainMenu	addMenu(int index, java.lang.String name) Adds a menu to the menu bar at a given index
IMainMenu	addMenu(java.lang.String name) Adds a menu to the menu bar
IMainMenu	addMenu(java.lang.String name, char mnemonic) Adds a menu to the menu bar
java.util.List<IMenu>	getMenus() Gets a unmodifieable copy of the menus this menu bar contains
IMenuBarModel	getModel() Gets the model
boolean	remove(IMenu menu) Removes a menu from the menu bar The menu will be disposed by that
void	remove(int index) Removes a menu from the menu bar at a given index
void	removeAll() Removes all menus from the mneu bar
void	setModel(IMenuBarModel model) Sets the model

Methods inherited from interface org.jowidgets.api.widgets.IWidget

dispose, getParent, getRoot, isDisposed

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable

addDisposeListener, removeDisposeListener

Methods inherited from interface org.jowidgets.common.widgets.IWidgetCommon

getUiReference, isEnabled, setEnabled

Method Detail

setModel

void setModel(IMenuBarModel model)

Sets the model

Parameters:

model - The model, must not be null

getModel

IMenuBarModel getModel()

Gets the model

Returns:

The model, never null

addMenu

IMainMenu addMenu(IMainMenuDescriptor descriptor)

Adds a menu to the menu bar

Parameters:

descriptor - The descriptor of the menu

Returns:

The added menu

addMenu

IMainMenu addMenu(int index,
                IMainMenuDescriptor descriptor)

Adds a menu to the menu bar at a given index

Parameters:

index - The index to at the menu at

descriptor - The descriptor of the menu

Returns:

The added menu

addMenu

IMainMenu addMenu(java.lang.String name)

Adds a menu to the menu bar

Parameters:

name - The name of the menu to add

Returns:

The added menu

addMenu

IMainMenu addMenu(java.lang.String name,
                char mnemonic)

Adds a menu to the menu bar

Parameters:

name - The name of the menu

mnemonic - The mnemonic of the mneu

Returns:

The added menu

addMenu

IMainMenu addMenu(int index,
                java.lang.String name)

Adds a menu to the menu bar at a given index

Parameters:

index - The index to at the menu at

name - The name of the menu

Returns:

The added menu

getMenus

java.util.List<IMenu> getMenus()

Gets a unmodifieable copy of the menus this menu bar contains

Returns:

The list of menus, never null

remove

boolean remove(IMenu menu)

Removes a menu from the menu bar The menu will be disposed by that

Parameters:

menu - The menu to remove

Returns:

true if the menu was removed, false if the given menu was no child of this menu bar

remove

void remove(int index)

Removes a menu from the menu bar at a given index

Parameters:

index - The index to remove the menu at

removeAll

void removeAll()

Removes all menus from the mneu bar