Package io.jmix.flowui.menu

Class ListMenuBuilder

java.lang.Object

io.jmix.flowui.menu.ListMenuBuilder

@Component("flowui_ListMenuBuilder")
@Scope("prototype")
public class ListMenuBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListMenuBuilder.MenuCommandExecutor	A command executor responsible for handling user interactions with ListMenu.MenuItem instances.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GENERATED_SEPARATOR_ID_PREFIX
protected MenuConfig	menuConfig
protected MenuItemCommands	menuItemCommands
protected MessageTools	messageTools
protected UiAccessChecker	uiAccessChecker
protected UiComponents	uiComponents
protected ViewRegistry	viewRegistry

Constructor Summary

Constructors

Constructor	Description
ListMenuBuilder(MenuConfig menuConfig, ViewRegistry viewRegistry, UiComponents uiComponents, MessageTools messageTools, UiAccessChecker uiAccessChecker, MenuItemCommands menuItemCommands)

Method Summary

Modifier and Type	Method	Description
JmixListMenu	build()	Builds and returns a new JmixListMenu instance by initializing it with the necessary configuration.
void	build(JmixListMenu listMenu)	Builds the structure for the provided JmixListMenu by adding menu items based on the root items defined in the menu configuration.
protected ListMenu.MenuItem	createBeanMenuItem(MenuItem menuItem)
Optional<ListMenu.MenuItem>	createListMenu(MenuItem menuItem)	Creates a ListMenu.MenuItem object from the given MenuItem, which can represent a menu hierarchy, separator, or an individual menu item.
protected ListMenu.MenuBarItem	createMenuBar(MenuItem menuItem)
protected ListMenu.MenuItem	createMenuItem(MenuItem menuItem)
protected ListMenu.MenuItem	createMenuSeparator()
protected ListMenu.MenuItem	createViewMenuItem(MenuItem menuItem)
protected String	generateSeparatorId()
protected String[]	getClassNames(MenuItem menuItem)
protected Class<? extends View<?>>	getControllerClass(MenuItem menuItem)
protected String	getDescription(MenuItem menuItem)
protected com.vaadin.flow.component.icon.VaadinIcon	getVaadinIcon(String iconString)
protected boolean	isPermitted(MenuItem menuItem)
protected void	removeTrailingChildSeparators(ListMenu.MenuBarItem menuBarItem)	Removes trailing child separators.
protected void	setIcon(MenuItem menuItem, ListMenu.MenuItem listMenuItem)

Methods inherited from class java.lang.Object

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

Field Details

GENERATED_SEPARATOR_ID_PREFIX

protected static final String GENERATED_SEPARATOR_ID_PREFIX

See Also:

• Constant Field Values

menuConfig

protected MenuConfig menuConfig

viewRegistry

protected ViewRegistry viewRegistry

uiComponents

protected UiComponents uiComponents

messageTools

protected MessageTools messageTools

uiAccessChecker

protected UiAccessChecker uiAccessChecker

menuItemCommands

protected MenuItemCommands menuItemCommands

Constructor Details

ListMenuBuilder

public ListMenuBuilder(MenuConfig menuConfig,
 ViewRegistry viewRegistry,
 UiComponents uiComponents,
 MessageTools messageTools,
 UiAccessChecker uiAccessChecker,
 MenuItemCommands menuItemCommands)

Method Details

build

public JmixListMenu build()

Builds and returns a new JmixListMenu instance by initializing it with the necessary configuration.

Returns:

a newly created JmixListMenu instance

build

public void build(JmixListMenu listMenu)

Builds the structure for the provided JmixListMenu by adding menu items based on the root items defined in the menu configuration.

Parameters:

listMenu - the JmixListMenu instance to build and populate with menu items

createListMenu

public Optional<ListMenu.MenuItem> createListMenu(MenuItem menuItem)

Creates a ListMenu.MenuItem object from the given MenuItem, which can represent a menu hierarchy, separator, or an individual menu item. It recursively processes child menu items if the given MenuItem is a menu container.

Parameters:

menuItem - the MenuItem representing the menu structure to be converted

Returns:

an Optional containing the constructed ListMenu.MenuItem, or Optional.empty() if the item has no children, is not permitted, or represents a n invalid structure

createMenuBar

protected ListMenu.MenuBarItem createMenuBar(MenuItem menuItem)

setIcon

protected void setIcon(MenuItem menuItem,
 ListMenu.MenuItem listMenuItem)

getVaadinIcon

@Nullable
protected com.vaadin.flow.component.icon.VaadinIcon getVaadinIcon(String iconString)

removeTrailingChildSeparators

protected void removeTrailingChildSeparators(ListMenu.MenuBarItem menuBarItem)

Removes trailing child separators.

Parameters:

menuBarItem - parent menu item to trim

createMenuItem

@Nullable
protected ListMenu.MenuItem createMenuItem(MenuItem menuItem)

createViewMenuItem

@Nullable
protected ListMenu.MenuItem createViewMenuItem(MenuItem menuItem)

createBeanMenuItem

protected ListMenu.MenuItem createBeanMenuItem(MenuItem menuItem)

createMenuSeparator

protected ListMenu.MenuItem createMenuSeparator()

getControllerClass

@Nullable
protected Class<? extends View<?>> getControllerClass(MenuItem menuItem)

getDescription

@Nullable
protected String getDescription(MenuItem menuItem)

getClassNames

protected String[] getClassNames(MenuItem menuItem)

isPermitted

protected boolean isPermitted(MenuItem menuItem)

generateSeparatorId

protected String generateSeparatorId()