com.haulmont.cuba.gui.config

Class MenuConfig

java.lang.Object

com.haulmont.cuba.gui.config.MenuConfig

@Component(value="cuba_MenuConfig")
public class MenuConfig
extends java.lang.Object

GenericUI class holding information about the main menu structure.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized
protected java.util.concurrent.locks.ReadWriteLock	lock
static java.lang.String	MENU_CONFIG_XML_PROP
protected Messages	messages
static java.lang.String	NAME
protected Resources	resources
protected java.util.List<MenuItem>	rootItems
protected ThemeConstantsManager	themeConstantsManager

Constructor Summary

Constructors

Constructor and Description
MenuConfig()

Method Summary

Modifier and Type	Method and Description
protected void	addItem(java.util.List<MenuItem> items, MenuItem menuItem, MenuItem beforeItem, boolean before)
protected void	checkDuplicateAction(java.lang.String menuItemId, java.lang.String... actionDefinition)
protected void	checkInitialized()
protected MenuItem	createMenuItem(org.dom4j.Element element, MenuItem currentParentItem)
protected MenuItem	findItem(java.lang.String id, MenuItem item)
protected java.lang.String	getIconPath(java.lang.String icon)
java.lang.String	getItemCaption(java.lang.String id)
static java.lang.String	getMenuItemCaption(java.lang.String id) Deprecated. Use getItemCaption(String)
java.util.List<MenuItem>	getRootItems() Main menu root items
protected void	init()
protected void	loadDescription(org.dom4j.Element element, MenuItem menuItem)
protected void	loadExpanded(org.dom4j.Element element, MenuItem menuItem)
protected void	loadIcon(org.dom4j.Element element, MenuItem menuItem)
protected void	loadMenuItems(org.dom4j.Element parentElement, MenuItem parentItem)
protected java.lang.String	loadResourceString(java.lang.String caption)
protected void	loadShortcut(MenuItem menuItem, org.dom4j.Element element)
protected void	loadStylename(org.dom4j.Element element, MenuItem menuItem)
protected java.lang.String	loadThemeString(java.lang.String value)
void	reset() Make the config to reload screens on next request.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

MENU_CONFIG_XML_PROP

public static final java.lang.String MENU_CONFIG_XML_PROP

See Also:

Constant Field Values

rootItems

protected java.util.List<MenuItem> rootItems

resources

@Inject
protected Resources resources

messages

@Inject
protected Messages messages

themeConstantsManager

@Inject
protected ThemeConstantsManager themeConstantsManager

initialized

protected volatile boolean initialized

lock

protected java.util.concurrent.locks.ReadWriteLock lock

Constructor Detail

MenuConfig

public MenuConfig()

Method Detail

getMenuItemCaption

@Deprecated
public static java.lang.String getMenuItemCaption(java.lang.String id)

Deprecated. Use getItemCaption(String)

Localized menu item caption.

Parameters:

id - screen ID as defined in screens.xml

getItemCaption

public java.lang.String getItemCaption(java.lang.String id)

checkInitialized

protected void checkInitialized()

init

protected void init()

reset

public void reset()

Make the config to reload screens on next request.

getRootItems

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

Main menu root items

loadMenuItems

protected void loadMenuItems(org.dom4j.Element parentElement,
                             MenuItem parentItem)

createMenuItem

protected MenuItem createMenuItem(org.dom4j.Element element,
                                  MenuItem currentParentItem)

checkDuplicateAction

protected void checkDuplicateAction(java.lang.String menuItemId,
                                    java.lang.String... actionDefinition)

loadExpanded

protected void loadExpanded(org.dom4j.Element element,
                            MenuItem menuItem)

loadDescription

protected void loadDescription(org.dom4j.Element element,
                               MenuItem menuItem)

loadStylename

protected void loadStylename(org.dom4j.Element element,
                             MenuItem menuItem)

loadIcon

protected void loadIcon(org.dom4j.Element element,
                        MenuItem menuItem)

getIconPath

protected java.lang.String getIconPath(java.lang.String icon)

loadResourceString

protected java.lang.String loadResourceString(java.lang.String caption)

loadThemeString

protected java.lang.String loadThemeString(java.lang.String value)

addItem

protected void addItem(java.util.List<MenuItem> items,
                       MenuItem menuItem,
                       MenuItem beforeItem,
                       boolean before)

findItem

protected MenuItem findItem(java.lang.String id,
                            MenuItem item)

loadShortcut

protected void loadShortcut(MenuItem menuItem,
                            org.dom4j.Element element)