com.vaadin.contextmenu

Interface MenuItem

All Superinterfaces:

Serializable

public interface MenuItem
extends Serializable

Method Summary

Modifier and Type	Method and Description
MenuItem	addItem(String caption, Menu.Command command) Add a new item inside this item, thus creating a sub-menu.
MenuItem	addItem(String caption, com.vaadin.server.Resource icon, Menu.Command command) Add a new item inside this item, thus creating a sub-menu.
MenuItem	addItemBefore(String caption, com.vaadin.server.Resource icon, Menu.Command command, MenuItem itemToAddBefore) Add an item before some item.
MenuItem	addSeparator() Adds a separator to this menu.
MenuItem	addSeparatorBefore(MenuItem itemToAddBefore)
List<MenuItem>	getChildren() This will return the children of this item or null if there are none.
Menu.Command	getCommand() For the associated command.
String	getDescription() Gets the items's description.
com.vaadin.server.Resource	getIcon() Gets the objects icon.
int	getId() Get the unique identifier for this item.
MenuItem	getParent() For the containing item.
int	getSize() Returns the number of children.
String	getStyleName()
String	getText() Gets the objects text
boolean	hasChildren() Checks if the item has children (if it is a sub-menu).
boolean	isCheckable() Gets the checkable state of the item - whether the item has checked and unchecked states.
boolean	isChecked() Gets the checked state of the item (checked or unchecked).
boolean	isEnabled()
boolean	isSeparator()
boolean	isVisible()
void	removeChild(MenuItem item) Remove the first occurrence of the item.
void	removeChildren() Empty the list of children items.
void	setCheckable(boolean checkable) Sets the checkable state of the item.
void	setChecked(boolean checked) Sets the checked state of the item.
void	setCommand(Menu.Command command) Set the command for this item.
void	setDescription(String description) Sets the items's description.
void	setEnabled(boolean enabled)
void	setIcon(com.vaadin.server.Resource icon) Sets the icon.
void	setStyleName(String styleName)
void	setText(String text) Set the text of this object.
void	setVisible(boolean visible)

Method Detail

hasChildren

boolean hasChildren()

Checks if the item has children (if it is a sub-menu).

Returns:

True if this item has children

addSeparator

MenuItem addSeparator()

Adds a separator to this menu. A separator is a way to visually group items in a menu, to make it easier for users to find what they are looking for in the menu.

Since:

6.2.0

addSeparatorBefore

MenuItem addSeparatorBefore(MenuItem itemToAddBefore)

addItem

MenuItem addItem(String caption,
                 Menu.Command command)

Add a new item inside this item, thus creating a sub-menu. 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

addItem

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

Add a new item inside this item, thus creating a sub-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

Throws:

IllegalStateException - If the item is checkable and thus cannot have children.

addItemBefore

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

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:

IllegalStateException - If the item is checkable and thus cannot have children.

getCommand

Menu.Command getCommand()

For the associated command.

Returns:

The associated command, or null if there is none

getIcon

com.vaadin.server.Resource getIcon()

Gets the objects icon.

Returns:

The icon of the item, null if the item doesn't have an icon

getParent

MenuItem getParent()

For the containing item. This will return null if the item is in the top-level menu bar.

Returns:

The containing MenuItem , or null if there is none

getChildren

List<MenuItem> getChildren()

This will return the children of this item or null if there are none.

Returns:

List of children items, or null if there are none

getText

String getText()

Gets the objects text

Returns:

The text

getSize

int getSize()

Returns the number of children.

Returns:

The number of child items

getId

int getId()

Get the unique identifier for this item.

Returns:

The id of this item

setCommand

void setCommand(Menu.Command command)

Set the command for this item. Set null to remove.

Parameters:

command - The MenuCommand of this item

setIcon

void setIcon(com.vaadin.server.Resource icon)

Sets the icon. Set null to remove.

Parameters:

icon - The icon for this item

setText

void setText(String text)

Set the text of this object.

Parameters:

text - Text for this object

removeChild

void removeChild(MenuItem item)

Remove the first occurrence of the item.

Parameters:

item - The item to be removed

removeChildren

void removeChildren()

Empty the list of children items.

setEnabled

void setEnabled(boolean enabled)

isEnabled

boolean isEnabled()

setVisible

void setVisible(boolean visible)

isVisible

boolean isVisible()

isSeparator

boolean isSeparator()

setStyleName

void setStyleName(String styleName)

getStyleName

String getStyleName()

setDescription

void setDescription(String description)

Sets the items's description. See getDescription() for more information on what the description is. This method will trigger a menu item repaint.

Parameters:

description - the new description string for the component.

getDescription

String getDescription()

Gets the items's description. The description can be used to briefly describe the state of the item to the user. The description string may contain certain XML tags:

Tag	Description	Example
<b>	bold	bold text
<i>	italic	italic text
<u>	underlined	underlined text
<br>	linebreak	N/A
<ul> <li>item1 <li>item1 </ul>	item list	item1 item2

These tags may be nested.

Returns:

item's description String

isCheckable

boolean isCheckable()

Gets the checkable state of the item - whether the item has checked and unchecked states. If an item is checkable its checked state (as returned by isChecked()) is indicated in the UI.

An item is not checkable by default.

Returns:

true if the item is checkable, false otherwise

Since:

6.6.2

setCheckable

void setCheckable(boolean checkable)
           throws IllegalStateException

Sets the checkable state of the item. If an item is checkable its checked state (as returned by isChecked()) is indicated in the UI.

An item is not checkable by default.

Items with sub items cannot be checkable.

Parameters:

checkable - true if the item should be checkable, false otherwise

Throws:

IllegalStateException - If the item has children

Since:

6.6.2

isChecked

boolean isChecked()

Gets the checked state of the item (checked or unchecked). Only used if the item is checkable (as indicated by isCheckable()). The checked state is indicated in the UI with the item, if the item is checkable.

An item is not checked by default.

The CSS style corresponding to the checked state is "-checked".

Returns:

true if the item is checked, false otherwise

Since:

6.6.2

setChecked

void setChecked(boolean checked)

Sets the checked state of the item. Only used if the item is checkable (indicated by isCheckable()). The checked state is indicated in the UI with the item, if the item is checkable.

An item is not checked by default.

The CSS style corresponding to the checked state is "-checked".

Since:

6.6.2