Package io.jmix.flowui.menu

Class MenuConfig

java.lang.Object

io.jmix.flowui.menu.MenuConfig

@Component("flowui_MenuConfig")
public class MenuConfig
extends Object

Holds information about the main menu structure.

Field Summary

Fields

Modifier and Type	Field	Description
protected Dom4jTools	dom4JTools
protected org.springframework.core.env.Environment	environment
protected boolean	initialized
protected ReadWriteLock	lock
static final String	MENU_CONFIG_XML_PROP
protected Messages	messages
protected MessageTools	messageTools
protected Metadata	metadata
protected MetadataTools	metadataTools
protected JmixModules	modules
protected Resources	resources
protected List<MenuItem>	rootItems
protected UiProperties	uiProperties

Constructor Summary

Constructors

Constructor	Description
MenuConfig(Resources resources, Messages messages, MessageTools messageTools, Dom4jTools dom4JTools, org.springframework.core.env.Environment environment, UiProperties uiProperties, JmixModules modules, Metadata metadata, MetadataTools metadataTools)

Method Summary

Modifier and Type	Method	Description
protected void	checkDuplicateAction(String menuItemId, String... actionDefinition)
protected void	checkInitialized()
protected void	checkValueOrEntityProvided(org.dom4j.Element property)
protected MenuItem	createMenuItem(org.dom4j.Element element, MenuItem currentParentItem)
MenuItem	findItem(String id, MenuItem item)
String	getItemTitle(MenuItem menuItem)
String	getItemTitle(String id)
protected Object	getMenuItemPropertyTypedValue(String value)
List<MenuItem>	getRootItems()	Main menu root items
protected void	init()
protected void	loadClassName(org.dom4j.Element element, MenuItem menuItem)
protected void	loadDescription(org.dom4j.Element element, MenuItem menuItem)
protected String	loadEntityFetchPlan(org.dom4j.Element propertyElement)
protected void	loadIcon(org.dom4j.Element element, MenuItem menuItem)
protected MetaClass	loadItemPropertyEntityClass(org.dom4j.Element property)
protected Object	loadItemPropertyEntityId(org.dom4j.Element property, MetaClass metaClass)
protected List<MenuItem.MenuItemParameter>	loadMenuItemParameters(org.dom4j.Element menuItem, String parametersElementName)
protected List<MenuItem.MenuItemProperty>	loadMenuItemProperties(org.dom4j.Element menuItem)
protected Object	loadMenuItemPropertyValue(org.dom4j.Element property)
protected void	loadMenuItems(org.dom4j.Element parentElement, MenuItem parentItem)
protected void	loadOpened(org.dom4j.Element element, MenuItem menuItem)
protected String	loadResourceString(String ref)
protected void	loadShortcutCombination(MenuItem menuItem, org.dom4j.Element element)
protected void	loadTitle(org.dom4j.Element element, MenuItem menuItem)
protected Object	parseEntityId(MetaClass entityMetaClass, String entityId)
void	reset()	Make the config to reload view on next request.

Methods inherited from class java.lang.Object

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

Field Details

MENU_CONFIG_XML_PROP

public static final String MENU_CONFIG_XML_PROP

See Also:

• Constant Field Values

rootItems

protected List<MenuItem> rootItems

resources

protected Resources resources

messages

protected Messages messages

messageTools

protected MessageTools messageTools

dom4JTools

protected Dom4jTools dom4JTools

environment

protected org.springframework.core.env.Environment environment

uiProperties

protected UiProperties uiProperties

modules

protected JmixModules modules

metadata

protected Metadata metadata

metadataTools

protected MetadataTools metadataTools

initialized

protected volatile boolean initialized

lock

protected ReadWriteLock lock

Constructor Details

MenuConfig

public MenuConfig(Resources resources,
 Messages messages,
 MessageTools messageTools,
 Dom4jTools dom4JTools,
 org.springframework.core.env.Environment environment,
 UiProperties uiProperties,
 JmixModules modules,
 Metadata metadata,
 MetadataTools metadataTools)

Method Details

getItemTitle

public String getItemTitle(String id)

getItemTitle

public String getItemTitle(MenuItem menuItem)

checkInitialized

protected void checkInitialized()

init

protected void init()

reset

public void reset()

Make the config to reload view on next request.

getRootItems

public 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)

checkValueOrEntityProvided

protected void checkValueOrEntityProvided(org.dom4j.Element property)

checkDuplicateAction

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

loadOpened

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

loadTitle

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

loadDescription

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

loadClassName

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

loadIcon

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

loadResourceString

protected String loadResourceString(@Nullable
 String ref)

loadMenuItemProperties

protected List<MenuItem.MenuItemProperty> loadMenuItemProperties(org.dom4j.Element menuItem)

loadMenuItemParameters

protected List<MenuItem.MenuItemParameter> loadMenuItemParameters(org.dom4j.Element menuItem,
 String parametersElementName)

loadMenuItemPropertyValue

@Nullable
protected Object loadMenuItemPropertyValue(org.dom4j.Element property)

getMenuItemPropertyTypedValue

protected Object getMenuItemPropertyTypedValue(String value)

loadItemPropertyEntityClass

protected MetaClass loadItemPropertyEntityClass(org.dom4j.Element property)

loadItemPropertyEntityId

protected Object loadItemPropertyEntityId(org.dom4j.Element property,
 MetaClass metaClass)

loadEntityFetchPlan

protected String loadEntityFetchPlan(org.dom4j.Element propertyElement)

parseEntityId

@Nullable
protected Object parseEntityId(MetaClass entityMetaClass,
 String entityId)

loadShortcutCombination

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

findItem

@Nullable
public MenuItem findItem(String id,
 MenuItem item)