io.jmix.ui.menu

Class MenuItem

java.lang.Object

io.jmix.ui.menu.MenuItem

public class MenuItem
extends java.lang.Object

Main menu item descriptor

Constructor Summary

Constructors

Constructor and Description
MenuItem(MenuItem parent, java.lang.String id)
MenuItem(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBean()
java.lang.String	getBeanMethod()
java.lang.String	getCaption()
java.util.List<MenuItem>	getChildren() Children items
java.lang.String	getDescription()
org.dom4j.Element	getDescriptor()
java.lang.String	getIcon()
java.lang.String	getId() Menu item ID as defined in menu-config.xml
MenuItem	getParent() Parent item.
java.lang.String	getRunnableClass()
java.lang.String	getScreen()
KeyCombination	getShortcut()
java.lang.String	getStylename()
boolean	isExpanded()
boolean	isMenu()
boolean	isSeparator()
void	setBean(java.lang.String bean)
void	setBeanMethod(java.lang.String beanMethod)
void	setCaption(java.lang.String caption) Sets the given caption to menu item.
void	setDescription(java.lang.String description) Sets the given description to menu item.
void	setDescriptor(org.dom4j.Element descriptor)
void	setExpanded(boolean expanded)
void	setIcon(java.lang.String icon)
void	setMenu(boolean isMenu)
void	setRunnableClass(java.lang.String runnableClass)
void	setScreen(java.lang.String screen)
void	setSeparator(boolean separator)
void	setShortcut(KeyCombination shortcut)
void	setStylename(java.lang.String stylename)

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuItem

public MenuItem(@Nullable
                MenuItem parent,
                java.lang.String id)

MenuItem

public MenuItem(java.lang.String id)

Method Detail

isMenu

public boolean isMenu()

setMenu

public void setMenu(boolean isMenu)

getParent

@Nullable
public MenuItem getParent()

Parent item. Null if this is root item.

getChildren

public java.util.List<MenuItem> getChildren()

Children items

getId

public java.lang.String getId()

Menu item ID as defined in menu-config.xml

getDescriptor

public org.dom4j.Element getDescriptor()

setDescriptor

public void setDescriptor(org.dom4j.Element descriptor)

getCaption

public java.lang.String getCaption()

Returns:

a raw string from menu XML config, can be a reference to localization message, e.g. mainMsg://menuitem.caption

See Also:

MenuConfig.getItemCaption(MenuItem)

setCaption

public void setCaption(java.lang.String caption)

Sets the given caption to menu item.

Parameters:

caption - menu item caption

See Also:

MenuConfig.getItemCaption(MenuItem)

getDescription

public java.lang.String getDescription()

Returns:

a raw string from menu XML config, can be a reference to localization message, e.g. mainMsg://menuitem.description

setDescription

public void setDescription(java.lang.String description)

Sets the given description to menu item.

Parameters:

description - menu item description

getStylename

public java.lang.String getStylename()

setStylename

public void setStylename(java.lang.String stylename)

getShortcut

public KeyCombination getShortcut()

setShortcut

public void setShortcut(@Nullable
                        KeyCombination shortcut)

isSeparator

public boolean isSeparator()

setSeparator

public void setSeparator(boolean separator)

getIcon

@Nullable
public java.lang.String getIcon()

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

isExpanded

public boolean isExpanded()

setExpanded

public void setExpanded(boolean expanded)

getScreen

public java.lang.String getScreen()

setScreen

public void setScreen(java.lang.String screen)

getRunnableClass

public java.lang.String getRunnableClass()

setRunnableClass

public void setRunnableClass(java.lang.String runnableClass)

getBean

public java.lang.String getBean()

setBean

public void setBean(java.lang.String bean)

getBeanMethod

public java.lang.String getBeanMethod()

setBeanMethod

public void setBeanMethod(java.lang.String beanMethod)