com.vaadin.contextmenu

Class ContextMenu

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.contextmenu.ContextMenu

All Implemented Interfaces:

Menu, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.Connector, Serializable

Direct Known Subclasses:

GridContextMenu, GridContextMenu, TableContextMenu

public class ContextMenu
extends com.vaadin.server.AbstractExtension
implements Menu

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContextMenu.ContextMenuClosedEvent ContextMenuClosedEvent is an event fired by the context menu when it's closed.
static interface	ContextMenu.ContextMenuClosedListener ContextMenuClosedListener is used to listen for the event that the context menu is closed, either when a item is clicked or when the popup is canceled.
static interface	ContextMenu.ContextMenuOpenListener End of delegates to AbstractMenu

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

Menu.Command

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Constructor Summary

Constructors

Constructor and Description
ContextMenu(com.vaadin.ui.AbstractComponent parentComponent, boolean setAsMenuForParentComponent)

Method Summary

Modifier and Type	Method and Description
void	addContextMenuCloseListener(ContextMenu.ContextMenuClosedListener contextMenuClosedListener) Adds listener that will be invoked when context menu is closed.
void	addContextMenuOpenListener(ContextMenu.ContextMenuOpenListener contextMenuComponentListener)
MenuItem	addItem(String caption, Menu.Command command) Delegates to AbstractMenu
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.
MenuItem	addSeparator()
MenuItem	addSeparatorBefore(MenuItem itemToAddBefore)
void	beforeClientResponse(boolean initial)
protected com.vaadin.event.ContextClickEvent.ContextClickListener	getContextClickListener()
List<MenuItem>	getItems() Returns a list with all the MenuItem objects in the menu bar
int	getSize() Returns the size of the menu.
protected MenuSharedState	getState()
boolean	isHtmlContentAllowed() Checks whether item captions are interpreted as html or plain text.
void	open()
void	open(int x, int y)
void	removeItem(MenuItem item) Remove first occurrence the specified item from the main menu
void	removeItems() Empty the menu bar
void	setAsContextMenuOf(com.vaadin.event.ContextClickEvent.ContextClickNotifier component) Sets this as a context menu of the component.
void	setHtmlContentAllowed(boolean htmlContentAllowed) Sets whether html is allowed in the item captions.

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getParent, getSupportedParentType, remove, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, attach, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

ContextMenu

public ContextMenu(com.vaadin.ui.AbstractComponent parentComponent,
                   boolean setAsMenuForParentComponent)

Parameters:

parentComponent - The component to whose lifecycle the context menu is tied to.

setAsMenuForParentComponent - Determines if this menu will be shown for the parent component.

Method Detail

addContextMenuCloseListener

public void addContextMenuCloseListener(ContextMenu.ContextMenuClosedListener contextMenuClosedListener)

Adds listener that will be invoked when context menu is closed.

Parameters:

contextMenuClosedListener -

open

public void open()

setAsContextMenuOf

public void setAsContextMenuOf(com.vaadin.event.ContextClickEvent.ContextClickNotifier component)

Sets this as a context menu of the component. You can set one menu to as many components as you wish.

Parameters:

component - the component to set the context menu to

addContextMenuOpenListener

public void addContextMenuOpenListener(ContextMenu.ContextMenuOpenListener contextMenuComponentListener)

beforeClientResponse

public void beforeClientResponse(boolean initial)

Specified by:

beforeClientResponse in interface com.vaadin.server.ClientConnector

Overrides:

beforeClientResponse in class com.vaadin.server.AbstractClientConnector

open

public void open(int x,
                 int y)

getState

protected MenuSharedState getState()

Overrides:

getState in class com.vaadin.server.AbstractClientConnector

getContextClickListener

protected com.vaadin.event.ContextClickEvent.ContextClickListener getContextClickListener()

addSeparator

public MenuItem addSeparator()

addSeparatorBefore

public MenuItem addSeparatorBefore(MenuItem itemToAddBefore)

addItem

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

Delegates to AbstractMenu

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)