|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.vaadin.ui.AbstractComponent
com.vaadin.ui.MenuBar
public class MenuBar
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.
| Nested Class Summary | |
|---|---|
static interface |
MenuBar.Command
This interface contains the layer for menu commands of the MenuBar class. |
class |
MenuBar.MenuItem
A composite class for menu items and sub-menus. |
| Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
|---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
| Nested classes/interfaces inherited from interface com.vaadin.ui.Component |
|---|
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener |
| Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable |
|---|
Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener |
| Field Summary |
|---|
| Fields inherited from interface com.vaadin.terminal.Sizeable |
|---|
SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
| Constructor Summary | |
|---|---|
MenuBar()
Constructs an empty, horizontal menu |
|
| Method Summary | |
|---|---|
MenuBar.MenuItem |
addItem(String caption,
MenuBar.Command command)
Add a new item to the menu bar. |
MenuBar.MenuItem |
addItem(String caption,
Resource icon,
MenuBar.Command command)
Add a new item to the menu bar. |
MenuBar.MenuItem |
addItemBefore(String caption,
Resource icon,
MenuBar.Command command,
MenuBar.MenuItem itemToAddBefore)
Add an item before some item. |
void |
changeVariables(Object source,
Map<String,Object> variables)
Deserialize changes received from client. |
boolean |
getCollapse()
Deprecated. |
List<MenuBar.MenuItem> |
getItems()
Returns a list with all the MenuItem objects in the menu bar |
MenuBar.MenuItem |
getMoreMenuItem()
Get the MenuItem used as the collapse menu item. |
int |
getSize()
Returns the size of the menu. |
Resource |
getSubmenuIcon()
Deprecated. |
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(PaintTarget target)
Paint (serialise) the component for the client. |
void |
removeItem(MenuBar.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 |
setCollapse(boolean collapse)
Deprecated. (since 6.2, will be removed in 7.0) Collapsing is always enabled if the MenuBar has a specified width. |
void |
setHtmlContentAllowed(boolean htmlContentAllowed)
Sets whether html is allowed in the item captions. |
void |
setMoreMenuItem(MenuBar.MenuItem item)
Set the item that is used when collapsing the top level menu. |
void |
setSubmenuIcon(Resource icon)
Deprecated. (since 6.2, will be removed in 7.0) Icon is set in theme, no need to worry about the visual representation here. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public MenuBar()
| Method Detail |
|---|
public void paintContent(PaintTarget target)
throws PaintException
paintContent in class AbstractComponenttarget - the target UIDL stream where the component should paint itself
to
PaintException - if the paint operation failed.
public void changeVariables(Object source,
Map<String,Object> variables)
changeVariables in interface VariableOwnerchangeVariables in class AbstractComponentsource - the Source of the variable change. This is the origin of the
event. For example in Web Adapter this is the request.variables - the Mapping from variable names to new variable values.
public MenuBar.MenuItem addItem(String caption,
MenuBar.Command command)
caption - the text for the menu itemcommand - the command for the menu item
IllegalArgumentException
public MenuBar.MenuItem addItem(String caption,
Resource icon,
MenuBar.Command command)
caption - the text for the menu itemicon - the icon for the menu itemcommand - the command for the menu item
IllegalArgumentException
public MenuBar.MenuItem addItemBefore(String caption,
Resource icon,
MenuBar.Command command,
MenuBar.MenuItem itemToAddBefore)
caption - the text for the menu itemicon - the icon for the menu itemcommand - the command for the menu itemitemToAddBefore - the item that will be after the new item
IllegalArgumentExceptionpublic List<MenuBar.MenuItem> getItems()
public void removeItem(MenuBar.MenuItem item)
item - The item to be removedpublic void removeItems()
public int getSize()
@Deprecated public void setSubmenuIcon(Resource icon)
icon - @Deprecated public Resource getSubmenuIcon()
setSubmenuIcon(Resource)@Deprecated public void setCollapse(boolean collapse)
collapse - @Deprecated public boolean getCollapse()
setCollapse(boolean)public void setMoreMenuItem(MenuBar.MenuItem item)
item - public MenuBar.MenuItem getMoreMenuItem()
public void setAutoOpen(boolean autoOpenTopLevelMenu)
Note, that on touch devices the menu still opens on a click event.
autoOpenTopLevelMenu - true if menus should be opened without click, the default is
falsepublic boolean isAutoOpen()
public void setHtmlContentAllowed(boolean htmlContentAllowed)
htmlContentAllowed - true if the captions are used as html, false if used as plain
textpublic boolean isHtmlContentAllowed()
setHtmlContentAllowed(boolean)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||