org.jowidgets.api.widgets

Interface IMenu

All Superinterfaces:

IDisposeObservable, IMenuCommon, IMenuObservable, IWidget, IWidgetCommon

All Known Subinterfaces:

IMainMenu, IPopupMenu, ISubMenu

All Known Implementing Classes:

JoMainMenu, JoPopupMenu, JoSubMenu

public interface IMenu
extends IWidget, IMenuCommon

Method Summary

Methods

Modifier and Type	Method and Description
IActionMenuItem	addAction(IAction action) Adds an action item to the menu that will be bound to the given action
IActionMenuItem	addAction(int index, IAction action) Adds an action item to the menu at a specific that will be bound to the given action
<WIDGET_TYPE extends IMenuItem> WIDGET_TYPE	addItem(int index, IWidgetDescriptor<? extends WIDGET_TYPE> descriptor) Adds a menu item to the menu at a specific index
<WIDGET_TYPE extends IMenuItem> WIDGET_TYPE	addItem(IWidgetDescriptor<? extends WIDGET_TYPE> descriptor) Adds a menu item to the menu
IMenuItem	addSeparator() Adds a separator item to the menu
IMenuItem	addSeparator(int index) Adds a separator item to the menu at a specific index
java.util.List<IMenuItem>	getChildren() Gets the menu items of the menu as a unmodifieable copy
IMenuModel	getModel() Gets the model of the menu
boolean	remove(IMenuItem item) Removes a menu item form the menu
void	removeAll() Removes all items from the menu
void	setModel(IMenuModel model) Sets the model of the menu

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

Methods inherited from interface org.jowidgets.common.widgets.controller.IMenuObservable

addMenuListener, removeMenuListener

Method Detail

getModel

IMenuModel getModel()

Gets the model of the menu

Returns:

The model, never null

setModel

void setModel(IMenuModel model)

Sets the model of the menu

Parameters:

model - The model to set, must not be null

addItem

<WIDGET_TYPE extends IMenuItem> WIDGET_TYPE addItem(IWidgetDescriptor<? extends WIDGET_TYPE> descriptor)

Adds a menu item to the menu

Parameters:

descriptor - The descriptor for the item to add, must not be null

Returns:

The created menu item

addItem

<WIDGET_TYPE extends IMenuItem> WIDGET_TYPE addItem(int index,
                                                  IWidgetDescriptor<? extends WIDGET_TYPE> descriptor)

Adds a menu item to the menu at a specific index

Parameters:

index - The index where to add the item

descriptor - The descriptor for the item to add, must not be null

Returns:

The created menu item

addAction

IActionMenuItem addAction(IAction action)

Adds an action item to the menu that will be bound to the given action

Parameters:

action - The action to add, must not be null

Returns:

The action item that was created

addAction

IActionMenuItem addAction(int index,
                        IAction action)

Adds an action item to the menu at a specific that will be bound to the given action

Parameters:

index - The index where to add the item

action - The action to add, must not be null

Returns:

The action item that was created

addSeparator

IMenuItem addSeparator()

Adds a separator item to the menu

Returns:

The separator item that was added

addSeparator

IMenuItem addSeparator(int index)

Adds a separator item to the menu at a specific index

Parameters:

index - The index where to add the separarot item

Returns:

The separator item that was added

remove

boolean remove(IMenuItem item)

Removes a menu item form the menu

Parameters:

item - The item to remove

Returns:

True if the item was removed, false of the item is no child of the menu

removeAll

void removeAll()

Removes all items from the menu

getChildren

java.util.List<IMenuItem> getChildren()

Gets the menu items of the menu as a unmodifieable copy

Returns:

The menu items of the menu, never null but may be empty