org.jowidgets.tools.model.item

Class MenuBarModel

java.lang.Object

org.jowidgets.tools.model.item.MenuBarModel

All Implemented Interfaces:

IListModelObservable, IMenuBarModel

public class MenuBarModel
extends java.lang.Object
implements IMenuBarModel

Constructor Summary

Constructors

Constructor and Description
MenuBarModel()

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
void	addListModelListener(IListModelListener listener) Adds a list model listener
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.
static IMenuBarModel	create() Creates a new menu bar model
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	removeListModelListener(IListModelListener listener) removes a list model listener
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 class java.lang.Object

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

Constructor Detail

MenuBarModel

public MenuBarModel()

Method Detail

addListModelListener

public final void addListModelListener(IListModelListener listener)

Description copied from interface: IListModelObservable

Adds a list model listener

Specified by:

addListModelListener in interface IListModelObservable

Parameters:

listener - The listener to add

removeListModelListener

public final void removeListModelListener(IListModelListener listener)

Description copied from interface: IListModelObservable

removes a list model listener

Specified by:

removeListModelListener in interface IListModelObservable

Parameters:

listener - The listener to remove

addAfter

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

Description copied from interface: IMenuBarModel

Adds a menu after another menu

Specified by:

addAfter in interface IMenuBarModel

Parameters:

newMenu - The menu to add

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

addBefore

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

Description copied from interface: IMenuBarModel

Adds a menu before another menu

Specified by:

addBefore in interface IMenuBarModel

Parameters:

newMenu - The menu to add

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

bind

public final void bind(IMenuBarModel model)

Description copied from interface: IMenuBarModel

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.

Specified by:

bind in interface IMenuBarModel

Parameters:

model - The model to bind this model to

unbind

public final void unbind(IMenuBarModel model)

Description copied from interface: IMenuBarModel

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

Specified by:

unbind in interface IMenuBarModel

Parameters:

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

addMenusOfModel

public final void addMenusOfModel(IMenuBarModel model)

Description copied from interface: IMenuBarModel

Adds all menus of a given menu bar

Specified by:

addMenusOfModel in interface IMenuBarModel

Parameters:

model - The menu bar which models should be added

addMenu

public final void addMenu(IMenuModel menu)

Description copied from interface: IMenuBarModel

Adds a menu

Specified by:

addMenu in interface IMenuBarModel

Parameters:

menu - The menu to add

addMenu

public final void addMenu(int index,
           IMenuModel menu)

Description copied from interface: IMenuBarModel

Adds a menu at a given index

Specified by:

addMenu in interface IMenuBarModel

Parameters:

index - The index where to add the menu

menu - The menu to add

addMenu

public final IMenuModel addMenu(IMenuModelBuilder menuBuilder)

Description copied from interface: IMenuBarModel

Creates and adds a menu defined by a builder.

Specified by:

addMenu in interface IMenuBarModel

Parameters:

menuBuilder - The builder that defines the menu

Returns:

The added menu

addMenu

public final IMenuModel addMenu(int index,
                 IMenuModelBuilder menuBuilder)

Description copied from interface: IMenuBarModel

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

Specified by:

addMenu in interface IMenuBarModel

Parameters:

index - The index where to add the menu

menuBuilder - The builder that defines the menu

Returns:

The added menu

addMenu

public final IMenuModel addMenu()

Description copied from interface: IMenuBarModel

Creates and add a menu

Specified by:

addMenu in interface IMenuBarModel

Returns:

The created menu

addMenu

public final IMenuModel addMenu(java.lang.String text)

Description copied from interface: IMenuBarModel

Creates and add a menu

Specified by:

addMenu in interface IMenuBarModel

Parameters:

text - The label text of the menu

Returns:

The created menu

addMenu

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

Description copied from interface: IMenuBarModel

Creates and add a menu

Specified by:

addMenu in interface IMenuBarModel

Parameters:

text - The label text of the menu

toolTipText - The tooltip text of the menu

Returns:

The created menu

addMenu

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

Description copied from interface: IMenuBarModel

Creates and add a menu

Specified by:

addMenu in interface IMenuBarModel

Parameters:

text - The label text of the menu

icon - The icon of the menu

Returns:

The created menu

addMenu

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

Description copied from interface: IMenuBarModel

Creates and add a menu

Specified by:

addMenu in interface IMenuBarModel

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

removeMenu

public final void removeMenu(IMenuModel item)

Description copied from interface: IMenuBarModel

Removes a menu

Specified by:

removeMenu in interface IMenuBarModel

Parameters:

item - The menu to remove

removeMenu

public final void removeMenu(int index)

Description copied from interface: IMenuBarModel

Removes a menu at a given index

Specified by:

removeMenu in interface IMenuBarModel

Parameters:

index - The index where to remove the menu

removeAllMenus

public final void removeAllMenus()

Description copied from interface: IMenuBarModel

Removes all menus

Specified by:

removeAllMenus in interface IMenuBarModel

findMenuById

public final IMenuModel findMenuById(java.lang.String id)

Description copied from interface: IMenuBarModel

Searches for a menu with a given id

Specified by:

findMenuById in interface IMenuBarModel

Parameters:

id - The id of the menu to search for

Returns:

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

getMenus

public final java.util.List<IMenuModel> getMenus()

Description copied from interface: IMenuBarModel

Gets a unmodifieable copy of all menus

Specified by:

getMenus in interface IMenuBarModel

Returns:

createCopy

public IMenuBarModel createCopy()

Description copied from interface: IMenuBarModel

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.

Specified by:

createCopy in interface IMenuBarModel

Returns:

A new instance that is a clone of this instance

create

public static IMenuBarModel create()

Creates a new menu bar model

Returns:

A new menu bar model