org.jowidgets.api.model.item

Interface IMenuModel

All Superinterfaces:

IItemModel, IItemModelObservable, IListModelObservable, IMenuItemModel, IToolBarItemModel

All Known Implementing Classes:

MenuModel

public interface IMenuModel
extends IItemModel, IMenuItemModel, IToolBarItemModel, IListModelObservable

Method Summary

Methods

Modifier and Type	Method and Description
IActionItemModel	addAction(IAction action) Creates an adds an action item and binds it to the given action
IActionItemModel	addAction(int index, IAction action) Creates an adds an action item at a given index and binds it to the given action
IActionItemModel	addActionItem() Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text) Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text, IImageConstant icon) Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text, java.lang.String toolTipText) Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and adds a action item
void	addAfter(IMenuItemModel newItem, java.lang.String... idPath) Adds an item after another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown
void	addBefore(IMenuItemModel newItem, java.lang.String... idPath) Adds an item before another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown
ICheckedItemModel	addCheckedItem() Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text) Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text, IImageConstant icon) Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text, java.lang.String toolTipText) Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and adds a checked item
void	addDecorator(IDecorator<IAction> decorator) Adds an action decorator for all actions contained in this menu an all sub menus.
<MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE	addItem(BUILDER_TYPE itemBuilder) Adds an item defined by an builder and returns the build item
void	addItem(IMenuItemModel item) Adds an item to the model
<MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE	addItem(int index, BUILDER_TYPE itemBuilder) Adds an item at a given index defined by an builder and returns the build item
void	addItem(int index, IMenuItemModel item) Adds an item at a given index
void	addItemsOfModel(IMenuModel menuModel) Adds all items of a given model to this model
IMenuModel	addMenu() Creates and add a submenu
IMenuModel	addMenu(java.lang.String text) Creates and add a submenu
IMenuModel	addMenu(java.lang.String text, IImageConstant icon) Creates and add a submenu
IMenuModel	addMenu(java.lang.String text, java.lang.String toolTipText) Creates and add a submenu
IMenuModel	addMenu(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and add a submenu
IRadioItemModel	addRadioItem() Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text) Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text, IImageConstant icon) Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text, java.lang.String toolTipText) Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and adds a radio item
ISeparatorItemModel	addSeparator() Creates and adds a separator
ISeparatorItemModel	addSeparator(int index) Creates and adds separator at a given index
ISeparatorItemModel	addSeparator(java.lang.String id) Creates and adds a separator
void	bind(IMenuModel model) Binds the given model to this model with the following manner: 1.
IMenuModel	createCopy() Creates a deep copy of the item and its children.
IMenuItemModel	findItemByPath(java.lang.String... idPath) Searches for an item in this model defined by a given path
java.util.List<IMenuItemModel>	getChildren() Gets a unmodifieable copy of the menus items
void	removeAllItems() Removes all items from the menu
void	removeDecorator(IDecorator<IAction> decorator) Removes a decorator for all actions contained in this menu an all sub menus.
void	removeItem(IMenuItemModel item) Removes an item from this menu
void	removeItem(int index) Removes an item at a given index
void	unbind(IMenuModel model) Unbind the given model.

Methods inherited from interface org.jowidgets.api.model.item.IItemModel

getAccelerator, getIcon, getId, getMnemonic, getText, getToolTipText, isEnabled, isVisible, setAccelerator, setAccelerator, setEnabled, setIcon, setMnemonic, setMnemonic, setText, setToolTipText, setVisible

Methods inherited from interface org.jowidgets.api.model.item.IItemModelObservable

addItemModelListener, removeItemModelListener

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

addListModelListener, removeListModelListener

Method Detail

addItem

void addItem(IMenuItemModel item)

Adds an item to the model

Parameters:

item - The item to add, must not be null

addItem

void addItem(int index,
           IMenuItemModel item)

Adds an item at a given index

Parameters:

index - The index to add the item at

item - The item to add

addItem

<MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE addItem(BUILDER_TYPE itemBuilder)

Adds an item defined by an builder and returns the build item

Parameters:

itemBuilder - The builder that defines the item

Returns:

The added item

addItem

<MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE addItem(int index,
                                                                                                          BUILDER_TYPE itemBuilder)

Adds an item at a given index defined by an builder and returns the build item

Parameters:

index - The index to add the item at

itemBuilder - The builder that defines the item

Returns:

The added item

addAfter

void addAfter(IMenuItemModel newItem,
            java.lang.String... idPath)

Adds an item after another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown

Parameters:

newItem - The item to add

idPath - The path where to add the item

Throws:

java.lang.IllegalArgumentException

addBefore

void addBefore(IMenuItemModel newItem,
             java.lang.String... idPath)

Adds an item before another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown

Parameters:

newItem - The item to add

idPath - The path where to add the item

Throws:

java.lang.IllegalArgumentException

addAction

IActionItemModel addAction(IAction action)

Creates an adds an action item and binds it to the given action

Parameters:

action - The action to use

Returns:

The created action item

addAction

IActionItemModel addAction(int index,
                         IAction action)

Creates an adds an action item at a given index and binds it to the given action

Parameters:

index - The index to add the item at

action - The action to use

Returns:

The created action item

addActionItem

IActionItemModel addActionItem()

Creates and adds a action item

Returns:

The created action item

addActionItem

IActionItemModel addActionItem(java.lang.String text)

Creates and adds a action item

Parameters:

text - The label text of the action item

Returns:

The created action item

addActionItem

IActionItemModel addActionItem(java.lang.String text,
                             java.lang.String toolTipText)

Creates and adds a action item

Parameters:

text - The label text of the action item

toolTipText - The tooltip text of the action item

Returns:

The created action item

addActionItem

IActionItemModel addActionItem(java.lang.String text,
                             IImageConstant icon)

Creates and adds a action item

Parameters:

text - The label text of the action item

icon - The icon of the action item

Returns:

The created action item

addActionItem

IActionItemModel addActionItem(java.lang.String text,
                             java.lang.String toolTipText,
                             IImageConstant icon)

Creates and adds a action item

Parameters:

text - The label text of the action item

toolTipText - The tooltip text of the action item

icon - The icon of the action item

Returns:

The created action item

addCheckedItem

ICheckedItemModel addCheckedItem()

Creates and adds a checked item

Returns:

The created item

addCheckedItem

ICheckedItemModel addCheckedItem(java.lang.String text)

Creates and adds a checked item

Parameters:

text - The label text of the item

Returns:

The created item

addCheckedItem

ICheckedItemModel addCheckedItem(java.lang.String text,
                               java.lang.String toolTipText)

Creates and adds a checked item

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

Returns:

The created item

addCheckedItem

ICheckedItemModel addCheckedItem(java.lang.String text,
                               IImageConstant icon)

Creates and adds a checked item

Parameters:

text - The label text of the item

icon - The icon of the item

Returns:

The created item

addCheckedItem

ICheckedItemModel addCheckedItem(java.lang.String text,
                               java.lang.String toolTipText,
                               IImageConstant icon)

Creates and adds a checked item

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

icon - The icon of the item

Returns:

The created item

addRadioItem

IRadioItemModel addRadioItem()

Creates and adds a radio item

Returns:

The created item

addRadioItem

IRadioItemModel addRadioItem(java.lang.String text)

Creates and adds a radio item

Parameters:

text - The label text of the item

Returns:

The created item

addRadioItem

IRadioItemModel addRadioItem(java.lang.String text,
                           java.lang.String toolTipText)

Creates and adds a radio item

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

Returns:

The created item

addRadioItem

IRadioItemModel addRadioItem(java.lang.String text,
                           IImageConstant icon)

Creates and adds a radio item

Parameters:

text - The label text of the item

icon - The icon of the item

Returns:

The created item

addRadioItem

IRadioItemModel addRadioItem(java.lang.String text,
                           java.lang.String toolTipText,
                           IImageConstant icon)

Creates and adds a radio item

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

icon - The icon of the item

Returns:

The created item

addSeparator

ISeparatorItemModel addSeparator()

Creates and adds a separator

Returns:

The created item

addSeparator

ISeparatorItemModel addSeparator(java.lang.String id)

Creates and adds a separator

Parameters:

id - The id of the separator

Returns:

The created item

addSeparator

ISeparatorItemModel addSeparator(int index)

Creates and adds separator at a given index

Parameters:

index - The index where to add the separator

Returns:

The created item

addMenu

IMenuModel addMenu()

Creates and add a submenu

Returns:

The created submenu

addMenu

IMenuModel addMenu(java.lang.String text)

Creates and add a submenu

Parameters:

text - The label text of the sub menu

Returns:

The created submenu

addMenu

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

Creates and add a submenu

Parameters:

text - The label text of the sub menu

toolTipText - The tooltip text of the submenu

Returns:

The created submenu

addMenu

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

Creates and add a submenu

Parameters:

text - The label text of the sub menu

icon - The icon of the submenu

Returns:

The created submenu

addMenu

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

Creates and add a submenu

Parameters:

text - The label text of the sub menu

toolTipText - The tooltip text of the submenu

icon - The icon of the submenu

Returns:

The created submenu

addItemsOfModel

void addItemsOfModel(IMenuModel menuModel)

Adds all items of a given model to this model

Parameters:

menuModel - The model which items should be added

addDecorator

void addDecorator(IDecorator<IAction> decorator)

Adds an action decorator for all actions contained in this menu an all sub menus. Remark: The decorator decorates the contained action and the actions that will be added in the future

Parameters:

decorator - The decorator to add, must not be null

removeDecorator

void removeDecorator(IDecorator<IAction> decorator)

Removes a decorator for all actions contained in this menu an all sub menus. Remark: The decorator will only be removed for items that are still descendant of this menu. In other words: When removing an item before removing the decorator, the remove decorator invocation on the ancestor has no effect for the removed items.

Parameters:

decorator - The decorator to remove, must not be null

removeItem

void removeItem(IMenuItemModel item)

Removes an item from this menu

Parameters:

item - The item to remove, must not be null

removeItem

void removeItem(int index)

Removes an item at a given index

Parameters:

index - The index where to remove the item

removeAllItems

void removeAllItems()

Removes all items from the menu

getChildren

java.util.List<IMenuItemModel> getChildren()

Gets a unmodifieable copy of the menus items

Returns:

The child items, never null but may be empty

findItemByPath

IMenuItemModel findItemByPath(java.lang.String... idPath)

Searches for an item in this model defined by a given path

Parameters:

idPath - The path of the items ids

Returns:

The item if found, null otherwise

bind

void bind(IMenuModel 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(IMenuModel 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

IMenuModel createCopy()

Description copied from interface: IItemModel

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

Specified by:

createCopy in interface IItemModel

Specified by:

createCopy in interface IMenuItemModel

Returns:

A new instance that is a clone of this instance