org.jowidgets.api.model.item

Interface IMenuBarModel

All Superinterfaces:

IListModelObservable

All Known Implementing Classes:

MenuBarModel

public interface IMenuBarModel
extends IListModelObservable

Method Summary

Methods

Modifier and Type	Method and Description
void	addAfter(IMenuModel newMenu, java.lang.String id) Adds a menu after another menu
void	addBefore(IMenuModel newMenu, java.lang.String id) Adds a menu before another menu
IMenuModel	addMenu() Creates and add a menu
void	addMenu(IMenuModel menu) Adds a menu
IMenuModel	addMenu(IMenuModelBuilder menuBuilder) Creates and adds a menu defined by a builder.
void	addMenu(int index, IMenuModel menu) Adds a menu at a given index
IMenuModel	addMenu(int index, IMenuModelBuilder menuBuilder) Creates and adds a menu defined by a builder at a given index
IMenuModel	addMenu(java.lang.String text) Creates and add a menu
IMenuModel	addMenu(java.lang.String text, IImageConstant icon) Creates and add a menu
IMenuModel	addMenu(java.lang.String text, java.lang.String toolTipText) Creates and add a menu
IMenuModel	addMenu(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and add a menu
void	addMenusOfModel(IMenuBarModel model) Adds all menus of a given menu bar
void	bind(IMenuBarModel model) Binds the given model to this model with the following manner: 1.
IMenuBarModel	createCopy() Creates a deep copy of the model and its children.
IMenuModel	findMenuById(java.lang.String id) Searches for a menu with a given id
java.util.List<IMenuModel>	getMenus() Gets a unmodifieable copy of all menus
void	removeAllMenus() Removes all menus
void	removeMenu(IMenuModel item) Removes a menu
void	removeMenu(int index) Removes a menu at a given index
void	unbind(IMenuBarModel model) Unbind the given model.

Methods inherited from interface org.jowidgets.api.model.IListModelObservable

addListModelListener, removeListModelListener

Method Detail

addMenu

void addMenu(IMenuModel menu)

Adds a menu

Parameters:

menu - The menu to add

addMenu

void addMenu(int index,
           IMenuModel menu)

Adds a menu at a given index

Parameters:

index - The index where to add the menu

menu - The menu to add

addMenu

IMenuModel addMenu(IMenuModelBuilder menuBuilder)

Creates and adds a menu defined by a builder.

Parameters:

menuBuilder - The builder that defines the menu

Returns:

The added menu

addMenu

IMenuModel addMenu(int index,
                 IMenuModelBuilder menuBuilder)

Creates and adds a menu defined by a builder at a given index

Parameters:

index - The index where to add the menu

menuBuilder - The builder that defines the menu

Returns:

The added menu

addMenu

IMenuModel addMenu()

Creates and add a menu

Returns:

The created menu

addMenu

IMenuModel addMenu(java.lang.String text)

Creates and add a menu

Parameters:

text - The label text of the menu

Returns:

The created menu

addMenu

IMenuModel addMenu(java.lang.String text,
                 java.lang.String toolTipText)

Creates and add a menu

Parameters:

text - The label text of the menu

toolTipText - The tooltip text of the menu

Returns:

The created menu

addMenu

IMenuModel addMenu(java.lang.String text,
                 IImageConstant icon)

Creates and add a menu

Parameters:

text - The label text of the menu

icon - The icon of the menu

Returns:

The created menu

addMenu

IMenuModel addMenu(java.lang.String text,
                 java.lang.String toolTipText,
                 IImageConstant icon)

Creates and add a menu

Parameters:

text - The label text of the menu

toolTipText - The tooltip text of the menu

icon - The icon of the menu

Returns:

The created menu

addAfter

void addAfter(IMenuModel newMenu,
            java.lang.String id)

Adds a menu after another menu

Parameters:

newMenu - The menu to add

id - The id of the menu to add the newMenu after

Throws:

java.lang.IllegalArgumentException - if no menu with the given id exists, use findMenuById(String) to check if the menu exist

addBefore

void addBefore(IMenuModel newMenu,
             java.lang.String id)

Adds a menu before another menu

Parameters:

newMenu - The menu to add

id - The id of the menu to add the newMenu before

Throws:

java.lang.IllegalArgumentException - if no menu with the given id exists, use findMenuById(String) to check if the menu exist

addMenusOfModel

void addMenusOfModel(IMenuBarModel model)

Adds all menus of a given menu bar

Parameters:

model - The menu bar which models should be added

removeMenu

void removeMenu(IMenuModel item)

Removes a menu

Parameters:

item - The menu to remove

removeMenu

void removeMenu(int index)

Removes a menu at a given index

Parameters:

index - The index where to remove the menu

removeAllMenus

void removeAllMenus()

Removes all menus

getMenus

java.util.List<IMenuModel> getMenus()

Gets a unmodifieable copy of all menus

Returns:

findMenuById

IMenuModel findMenuById(java.lang.String id)

Searches for a menu with a given id

Parameters:

id - The id of the menu to search for

Returns:

The found menu or null if no menu with the id exists

bind

void bind(IMenuBarModel model)

Binds the given model to this model with the following manner: 1. All items of the given model will be removed. 2. All items of this model will be added to the given model. 3. All changes on this model will be done on the given model.

Parameters:

model - The model to bind this model to

Throws:

java.lang.IllegalArgumentException - if the given model is null

unbind

void unbind(IMenuBarModel model)

Unbind the given model. Changes on this model will no longer be propagated to the given model.

Parameters:

model - the model to unbind, may be not bound already but must not be null

Throws:

java.lang.IllegalArgumentException - if the given model is null

createCopy

IMenuBarModel createCopy()

Creates a deep copy of the model and its children. Remark: Registered listeners won't be copied, so the result has no registered listeners for the first time.

Returns:

A new instance that is a clone of this instance