com.vaadin.contextmenu

Class MenuBar

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.contextmenu.MenuBar

All Implemented Interfaces:

Menu, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.LegacyComponent, Serializable, EventListener

public class MenuBar
extends com.vaadin.ui.AbstractComponent
implements Menu, com.vaadin.ui.LegacyComponent, com.vaadin.ui.Component.Focusable

A class representing a horizontal menu bar. The menu can contain MenuItem objects, which in turn can contain more MenuBars. These sub-level MenuBars are represented as vertical menu.

See Also:

Serialized Form

Nested Class Summary

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

Menu.Command

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

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

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
MenuBar() Constructs an empty, horizontal menu

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.
void	changeVariables(Object source, Map<String,Object> variables) Deserialize changes received from client.
protected org.jsoup.nodes.Element	createMenuElement(MenuItem item, com.vaadin.ui.declarative.DesignContext designContext)
void	focus()
protected Collection<String>	getCustomAttributes()
List<MenuItem>	getItems() Returns a list with all the MenuItem objects in the menu bar
MenuItem	getMoreMenuItem() Get the MenuItem used as the collapse menu item.
int	getSize() Returns the size of the menu.
protected com.vaadin.shared.ui.menubar.MenuBarState	getState()
protected com.vaadin.shared.ui.menubar.MenuBarState	getState(boolean markAsDirty)
int	getTabIndex()
boolean	isAutoOpen() Detects whether the menubar is in a mode where top level menus are automatically opened when the mouse cursor is moved over the menu.
boolean	isHtmlContentAllowed() Checks whether item captions are interpreted as html or plain text.
void	paintContent(com.vaadin.server.PaintTarget target) Paint (serialise) the component for the client.
void	readDesign(org.jsoup.nodes.Element design, com.vaadin.ui.declarative.DesignContext designContext)
protected MenuItem	readMenuElement(org.jsoup.nodes.Element menuElement, MenuItem parent)
void	removeItem(MenuItem item) Remove first occurrence the specified item from the main menu
void	removeItems() Empty the menu bar
void	setAutoOpen(boolean autoOpenTopLevelMenu) Using this method menubar can be put into a special mode where top level menus opens without clicking on the menu, but automatically when mouse cursor is moved over the menu.
void	setHtmlContentAllowed(boolean htmlContentAllowed) Sets whether html is allowed in the item captions.
void	setMoreMenuItem(MenuItem item) Set the item that is used when collapsing the top level menu.
void	setTabIndex(int tabIndex)
void	writeDesign(org.jsoup.nodes.Element design, com.vaadin.ui.declarative.DesignContext designContext)

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, 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.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Constructor Detail

MenuBar

public MenuBar()

Constructs an empty, horizontal menu

Method Detail

getState

protected com.vaadin.shared.ui.menubar.MenuBarState getState()

Overrides:

getState in class com.vaadin.ui.AbstractComponent

getState

protected com.vaadin.shared.ui.menubar.MenuBarState getState(boolean markAsDirty)

Overrides:

getState in class com.vaadin.ui.AbstractComponent

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Paint (serialise) the component for the client.

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Throws:

com.vaadin.server.PaintException

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Deserialize changes received from client.

Specified by:

changeVariables in interface com.vaadin.server.VariableOwner

getTabIndex

public int getTabIndex()

Specified by:

getTabIndex in interface com.vaadin.ui.Component.Focusable

setTabIndex

public void setTabIndex(int tabIndex)

Specified by:

setTabIndex in interface com.vaadin.ui.Component.Focusable

focus

public void focus()

Specified by:

focus in interface com.vaadin.ui.Component.Focusable

Overrides:

focus in class com.vaadin.ui.AbstractComponent

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        com.vaadin.ui.declarative.DesignContext designContext)

Specified by:

writeDesign in interface com.vaadin.ui.Component

Overrides:

writeDesign in class com.vaadin.ui.AbstractComponent

createMenuElement

protected org.jsoup.nodes.Element createMenuElement(MenuItem item,
                                                    com.vaadin.ui.declarative.DesignContext designContext)

readMenuElement

protected MenuItem readMenuElement(org.jsoup.nodes.Element menuElement,
                                   MenuItem parent)

setMoreMenuItem

public void setMoreMenuItem(MenuItem item)

Set the item that is used when collapsing the top level menu. All "overflowing" items will be added below this. The item command will be ignored. If set to null, the default item with a downwards arrow is used. The item command (if specified) is ignored.

Parameters:

item -

getMoreMenuItem

public MenuItem getMoreMenuItem()

Get the MenuItem used as the collapse menu item.

Returns:

setAutoOpen

public void setAutoOpen(boolean autoOpenTopLevelMenu)

Using this method menubar can be put into a special mode where top level menus opens without clicking on the menu, but automatically when mouse cursor is moved over the menu. In this mode the menu also closes itself if the mouse is moved out of the opened menu.

Note, that on touch devices the menu still opens on a click event.

Parameters:

autoOpenTopLevelMenu - true if menus should be opened without click, the default is false

isAutoOpen

public boolean isAutoOpen()

Detects whether the menubar is in a mode where top level menus are automatically opened when the mouse cursor is moved over the menu. Normally root menu opens only by clicking on the menu. Submenus always open automatically.

Returns:

true if the root menus open without click, the default is false

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       com.vaadin.ui.declarative.DesignContext designContext)

Specified by:

readDesign in interface com.vaadin.ui.Component

Overrides:

readDesign in class com.vaadin.ui.AbstractComponent

getCustomAttributes

protected Collection<String> getCustomAttributes()

Overrides:

getCustomAttributes in class com.vaadin.ui.AbstractComponent

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)