io.jmix.ui.menu

Class MenuConfig

java.lang.Object

io.jmix.ui.menu.MenuConfig

@Component(value="ui_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 io.jmix.core.common.xmlparsing.Dom4jTools	dom4JTools
protected org.springframework.core.env.Environment	environment
protected Icons	icons
protected boolean	initialized
protected java.util.concurrent.locks.ReadWriteLock	lock
static java.lang.String	MENU_CONFIG_XML_PROP
protected io.jmix.core.Messages	messages
protected io.jmix.core.MessageTools	messageTools
protected io.jmix.core.JmixModules	modules
protected io.jmix.core.Resources	resources
protected java.util.List<MenuItem>	rootItems
protected ThemeConstantsManager	themeConstantsManager
protected UiProperties	uiProperties

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)
MenuItem	findItem(java.lang.String id, MenuItem item)
protected java.lang.String	getIconPath(java.lang.String icon)
java.lang.String	getItemCaption(MenuItem menuItem)
java.lang.String	getItemCaption(java.lang.String id)
java.util.List<MenuItem>	getRootItems() Main menu root items
protected void	init()
protected void	loadCaption(org.dom4j.Element element, MenuItem menuItem)
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

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

@Autowired
protected io.jmix.core.Resources resources

messages

@Autowired
protected io.jmix.core.Messages messages

messageTools

@Autowired
protected io.jmix.core.MessageTools messageTools

themeConstantsManager

@Autowired
protected ThemeConstantsManager themeConstantsManager

dom4JTools

@Autowired
protected io.jmix.core.common.xmlparsing.Dom4jTools dom4JTools

environment

@Autowired
protected org.springframework.core.env.Environment environment

uiProperties

@Autowired
protected UiProperties uiProperties

modules

@Autowired
protected io.jmix.core.JmixModules modules

icons

@Autowired
protected Icons icons

initialized

protected volatile boolean initialized

lock

protected java.util.concurrent.locks.ReadWriteLock lock

Constructor Detail

MenuConfig

public MenuConfig()

Method Detail

getItemCaption

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

getItemCaption

public java.lang.String getItemCaption(MenuItem menuItem)

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,
                             @Nullable
                             MenuItem parentItem)

createMenuItem

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

checkDuplicateAction

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

loadExpanded

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

loadCaption

protected void loadCaption(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

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

loadResourceString

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

loadThemeString

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

addItem

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

findItem

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

loadShortcut

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