com.vaadin.contextmenu

Class AbstractMenu

java.lang.Object

com.vaadin.contextmenu.AbstractMenu

All Implemented Interfaces:

Menu, Serializable

public class AbstractMenu
extends Object
implements Menu

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.contextmenu.Menu

Menu.Command

Constructor Summary

Constructors

Constructor and Description
AbstractMenu()
AbstractMenu(com.vaadin.server.ClientConnector connector)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMenu

public AbstractMenu()

AbstractMenu

public AbstractMenu(com.vaadin.server.ClientConnector connector)

Method Detail

addItem

public MenuItem addItem(String caption,
                        Menu.Command command)

Description copied from interface: Menu

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

Specified by:

addItem in interface Menu

Parameters:

caption - the text for the menu item

command - the command for the menu item

addItem

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

Description copied from interface: Menu

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

Specified by:

addItem in interface Menu

Parameters:

caption - the text for the menu item

icon - the icon for the menu item

command - the command for the menu item

addItemBefore

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

Description copied from interface: Menu

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.

Specified by:

addItemBefore in interface Menu

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

getItems

public List<MenuItem> getItems()

Description copied from interface: Menu

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

Specified by:

getItems in interface Menu

Returns:

a list containing the MenuItem objects in the menu bar

removeItem

public void removeItem(MenuItem item)

Description copied from interface: Menu

Remove first occurrence the specified item from the main menu

Specified by:

removeItem in interface Menu

Parameters:

item - The item to be removed

removeItems

public void removeItems()

Description copied from interface: Menu

Empty the menu bar

Specified by:

removeItems in interface Menu

getSize

public int getSize()

Description copied from interface: Menu

Returns the size of the menu.

Specified by:

getSize in interface Menu

Returns:

The size of the menu

setHtmlContentAllowed

public void setHtmlContentAllowed(boolean htmlContentAllowed)

Description copied from interface: Menu

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.

Specified by:

setHtmlContentAllowed in interface Menu

Parameters:

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

isHtmlContentAllowed

public boolean isHtmlContentAllowed()

Description copied from interface: Menu

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

Specified by:

isHtmlContentAllowed in interface Menu

Returns:

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

See Also:

Menu.setHtmlContentAllowed(boolean)