com.vaadin.contextmenu

Interface Menu

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractMenu, ContextMenu, GridContextMenu, GridContextMenu, MenuBar, TableContextMenu

public interface Menu
extends Serializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Menu.Command This interface contains the layer for menu commands of the MenuBar class.

Method Summary

Modifier and Type	Method and Description
MenuItem	addItem(String caption, Menu.Command command) Add a new item to the menu bar.
MenuItem	addItem(String caption, com.vaadin.server.Resource icon, Menu.Command command) Add a new item to the menu bar.
MenuItem	addItemBefore(String caption, com.vaadin.server.Resource icon, Menu.Command command, MenuItem itemToAddBefore) Add an item before some item.
List<MenuItem>	getItems() Returns a list with all the MenuItem objects in the menu bar
int	getSize() Returns the size of the menu.
boolean	isHtmlContentAllowed() Checks whether item captions are interpreted as html or plain text.
void	removeItem(MenuItem item) Remove first occurrence the specified item from the main menu
void	removeItems() Empty the menu bar
void	setHtmlContentAllowed(boolean htmlContentAllowed) Sets whether html is allowed in the item captions.

Method Detail

addItem

MenuItem addItem(String caption,
                 Menu.Command command)

Add a new item to the menu bar. Command can be null, but a caption must be given.

Parameters:

caption - the text for the menu item

command - the command for the menu item

Throws:

IllegalArgumentException

addItem

MenuItem addItem(String caption,
                 com.vaadin.server.Resource icon,
                 Menu.Command command)

Add a new item to the menu bar. Icon and command can be null, but a caption must be given.

Parameters:

caption - the text for the menu item

icon - the icon for the menu item

command - the command for the menu item

Throws:

IllegalArgumentException

addItemBefore

MenuItem addItemBefore(String caption,
                       com.vaadin.server.Resource icon,
                       Menu.Command command,
                       MenuItem itemToAddBefore)

Add an item before some item. If the given item does not exist the item is added at the end of the menu. Icon and command can be null, but a caption must be given.

Parameters:

caption - the text for the menu item

icon - the icon for the menu item

command - the command for the menu item

itemToAddBefore - the item that will be after the new item

Throws:

IllegalArgumentException

getItems

List<MenuItem> getItems()

Returns a list with all the MenuItem objects in the menu bar

Returns:

a list containing the MenuItem objects in the menu bar

removeItem

void removeItem(MenuItem item)

Remove first occurrence the specified item from the main menu

Parameters:

item - The item to be removed

removeItems

void removeItems()

Empty the menu bar

getSize

int getSize()

Returns the size of the menu.

Returns:

The size of the menu

setHtmlContentAllowed

void setHtmlContentAllowed(boolean htmlContentAllowed)

Sets whether html is allowed in the item captions. If set to true, the captions are passed to the browser as html and the developer is responsible for ensuring no harmful html is used. If set to false, the content is passed to the browser as plain text.

Parameters:

htmlContentAllowed - true if the captions are used as html, false if used as plain text

isHtmlContentAllowed

boolean isHtmlContentAllowed()

Checks whether item captions are interpreted as html or plain text.

Returns:

true if the captions are used as html, false if used as plain text

See Also:

setHtmlContentAllowed(boolean)