Package io.jmix.flowui.kit.component.main

Class ListMenu

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.UnorderedList>

io.jmix.flowui.kit.component.main.ListMenu

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<ListMenuVariant>, Serializable

Direct Known Subclasses:

JmixListMenu

public class ListMenu
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.UnorderedList>
implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.shared.HasThemeVariant<ListMenuVariant>

listMenu is a component for displaying a vertical menu with a collapsible drop-down sub-menus.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListMenu.ListMenuBarOpenedChangeEvent
static class	ListMenu.MenuBarItem	Describes menu item that can contain other menu items.
static class	ListMenu.MenuItem	Describes menu item.
static class	ListMenu.MenuSeparatorItem

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	JMIX_LIST_MENU_CLASS_NAME
protected static final String	JMIX_MENU_ITEM_CLASS_NAME
protected static final String	JMIX_MENUBAR_ITEM_CLASS_NAME
protected static final String	JMIX_MENUBAR_SUMMARY_ICON_CONTAINER_CLASS_NAME
protected static final String	LINK_TEXT_CLASS_NAME
protected static final String	MENUBAR_LIST_CLASS_NAME
protected static final String	MENUBAR_SUMMARY_CLASS_NAME
protected PropertyChangeListener	menuItemPropertyChangeListener
protected static final String	PREFIX_COMPONENT_CLASS_NAME
protected Map<String,org.apache.commons.lang3.tuple.Pair<ListMenu.MenuItem,com.vaadin.flow.component.html.ListItem>>	registrations
protected List<ListMenu.MenuItem>	rootMenuItems
protected static final String	SUFFIX_COMPONENT_CLASS_NAME

Constructor Summary

Constructors

Constructor	Description
ListMenu()

Method Summary

Modifier and Type	Method	Description
protected void	addChildren(ListMenu.MenuItem parent, ListMenu.MenuItem childItem)
protected void	addChildren(ListMenu.MenuItem parent, ListMenu.MenuItem childItem, int index)
void	addMenuItem(ListMenu.MenuItem menuItem)	Adds menu item and its children to the menu.
void	addMenuItem(ListMenu.MenuItem menuItem, int index)	Adds menu item and its children to the menu in specified index.
protected void	addMenuItemClickListener(com.vaadin.flow.component.Component menuItemComponent, ListMenu.MenuItem menuItem)
protected void	addMenuItemClickShortcutCombination(com.vaadin.flow.component.Component menuItemComponent, ListMenu.MenuItem menuItem)
protected void	addMenuItemText(com.vaadin.flow.component.Component componentContainer, com.vaadin.flow.component.html.Span text)
protected void	addMenuOpenedChangeListener(com.vaadin.flow.component.details.Details details, ListMenu.MenuItem menuItem)
protected void	attachMenuItemRecursively(ListMenu.MenuItem menuItem)
protected void	checkItemIdDuplicate(String id)
protected com.vaadin.flow.component.details.Details	createMenuBarComponent(ListMenu.MenuBarItem menuBarItem)
protected com.vaadin.flow.component.Component	createMenuItemComponent(ListMenu.MenuItem menuItem)
protected com.vaadin.flow.component.Component	createMenuItemContentComponent()
protected com.vaadin.flow.component.html.Span	createMenuItemText(ListMenu.MenuItem menuItem)
protected com.vaadin.flow.component.html.ListItem	createMenuRecursively(ListMenu.MenuItem menuItem)
protected void	detachMenuItemRecursively(ListMenu.MenuItem menuItem)
protected com.vaadin.flow.component.details.Details	getMenuBarComponent(ListMenu.MenuItem menuItem)
protected com.vaadin.flow.component.html.UnorderedList	getMenuBarContent(com.vaadin.flow.component.details.Details menuBar)
protected com.vaadin.flow.component.html.UnorderedList	getMenuBarContent(ListMenu.MenuItem menuItem)
@Nullable ListMenu.MenuItem	getMenuItem(String id)	Gets menu item from the menu by its ID.
protected com.vaadin.flow.component.Component	getMenuItemComponent(ListMenu.MenuItem menuItem)
protected List<String>	getMenuItemComponentClassNames(ListMenu.MenuItem menuItem)
List<ListMenu.MenuItem>	getMenuItems()
protected String	getTitle(ListMenu.MenuItem menuItem)
protected com.vaadin.flow.component.html.UnorderedList	initContent()
protected void	initMenuItemComponent(com.vaadin.flow.component.Component menuItemComponent, ListMenu.MenuItem menuItem)
protected void	onMenuItemPropertyChange(PropertyChangeEvent event)
protected void	registerMenuItem(ListMenu.MenuItem menuItem, com.vaadin.flow.component.html.ListItem menuItemComponent)
void	removeAllMenuItems()	Removes all menu items from the menu.
void	removeMenuItem(int index)	Removes root menu item by index.
void	removeMenuItem(ListMenu.MenuItem menuItem)	Removes menu item and its children from the menu.
protected void	setPrefixComponent(com.vaadin.flow.component.Component componentContainer, @Nullable com.vaadin.flow.component.Component prefixComponent, @Nullable com.vaadin.flow.component.Component oldPrefixComponent)
protected void	setSuffixComponent(com.vaadin.flow.component.Component componentContainer, @Nullable com.vaadin.flow.component.Component suffixComponent, @Nullable com.vaadin.flow.component.Component oldSuffixComponent)
protected void	unregisterMenuItemRecursively(ListMenu.MenuItem menuItem)
protected void	updateMenuItemComponentClassNames(com.vaadin.flow.component.Component menuItemComponent, ListMenu.MenuItem menuItem)

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, bindVisible, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasSize

bindHeight, bindWidth, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, bindThemeName, bindThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

addThemeVariants, bindThemeVariant, removeThemeVariants, setThemeVariant, setThemeVariants, setThemeVariants

Field Details

JMIX_LIST_MENU_CLASS_NAME

protected static final String JMIX_LIST_MENU_CLASS_NAME

See Also:

• Constant Field Values

JMIX_MENUBAR_ITEM_CLASS_NAME

protected static final String JMIX_MENUBAR_ITEM_CLASS_NAME

See Also:

• Constant Field Values

JMIX_MENUBAR_SUMMARY_ICON_CONTAINER_CLASS_NAME

protected static final String JMIX_MENUBAR_SUMMARY_ICON_CONTAINER_CLASS_NAME

See Also:

• Constant Field Values

MENUBAR_SUMMARY_CLASS_NAME

protected static final String MENUBAR_SUMMARY_CLASS_NAME

See Also:

• Constant Field Values

MENUBAR_LIST_CLASS_NAME

protected static final String MENUBAR_LIST_CLASS_NAME

See Also:

• Constant Field Values

JMIX_MENU_ITEM_CLASS_NAME

protected static final String JMIX_MENU_ITEM_CLASS_NAME

See Also:

• Constant Field Values

LINK_TEXT_CLASS_NAME

protected static final String LINK_TEXT_CLASS_NAME

See Also:

• Constant Field Values

PREFIX_COMPONENT_CLASS_NAME

protected static final String PREFIX_COMPONENT_CLASS_NAME

See Also:

• Constant Field Values

SUFFIX_COMPONENT_CLASS_NAME

protected static final String SUFFIX_COMPONENT_CLASS_NAME

See Also:

• Constant Field Values

rootMenuItems

protected List<ListMenu.MenuItem> rootMenuItems

registrations

protected Map<String,org.apache.commons.lang3.tuple.Pair<ListMenu.MenuItem,com.vaadin.flow.component.html.ListItem>> registrations

menuItemPropertyChangeListener

protected PropertyChangeListener menuItemPropertyChangeListener

Constructor Details

ListMenu

public ListMenu()

Method Details

initContent

protected com.vaadin.flow.component.html.UnorderedList initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.html.UnorderedList>

getMenuItem

public @Nullable ListMenu.MenuItem getMenuItem(String id)

Gets menu item from the menu by its ID.

Parameters:

id - menu item id

Returns:

menu item or null if not found

getMenuItems

public List<ListMenu.MenuItem> getMenuItems()

Returns:

immutable list of root menu items

addMenuItem

public void addMenuItem(ListMenu.MenuItem menuItem)

Adds menu item and its children to the menu.

Parameters:

menuItem - menu item to add

addMenuItem

public void addMenuItem(ListMenu.MenuItem menuItem,
 int index)

Adds menu item and its children to the menu in specified index.

If root menu items already contain provided menu item, it will be moved to the provided index.

Parameters:

menuItem - menu item to add

index - index to add menu item in the root items

removeMenuItem

public void removeMenuItem(ListMenu.MenuItem menuItem)

Removes menu item and its children from the menu.

Parameters:

menuItem - menu item to remove

removeMenuItem

public void removeMenuItem(int index)

Removes root menu item by index.

Parameters:

index - index to remove from root menu items

removeAllMenuItems

public void removeAllMenuItems()

Removes all menu items from the menu.

addChildren

protected void addChildren(ListMenu.MenuItem parent,
 ListMenu.MenuItem childItem)

addChildren

protected void addChildren(ListMenu.MenuItem parent,
 ListMenu.MenuItem childItem,
 int index)

createMenuRecursively

protected com.vaadin.flow.component.html.ListItem createMenuRecursively(ListMenu.MenuItem menuItem)

attachMenuItemRecursively

protected void attachMenuItemRecursively(ListMenu.MenuItem menuItem)

detachMenuItemRecursively

protected void detachMenuItemRecursively(ListMenu.MenuItem menuItem)

unregisterMenuItemRecursively

protected void unregisterMenuItemRecursively(ListMenu.MenuItem menuItem)

registerMenuItem

protected void registerMenuItem(ListMenu.MenuItem menuItem,
 com.vaadin.flow.component.html.ListItem menuItemComponent)

createMenuItemComponent

protected com.vaadin.flow.component.Component createMenuItemComponent(ListMenu.MenuItem menuItem)

initMenuItemComponent

protected void initMenuItemComponent(com.vaadin.flow.component.Component menuItemComponent,
 ListMenu.MenuItem menuItem)

createMenuItemText

protected com.vaadin.flow.component.html.Span createMenuItemText(ListMenu.MenuItem menuItem)

addMenuItemText

protected void addMenuItemText(com.vaadin.flow.component.Component componentContainer,
 com.vaadin.flow.component.html.Span text)

updateMenuItemComponentClassNames

protected void updateMenuItemComponentClassNames(com.vaadin.flow.component.Component menuItemComponent,
 ListMenu.MenuItem menuItem)

getMenuItemComponentClassNames

protected List<String> getMenuItemComponentClassNames(ListMenu.MenuItem menuItem)

createMenuItemContentComponent

protected com.vaadin.flow.component.Component createMenuItemContentComponent()

addMenuOpenedChangeListener

protected void addMenuOpenedChangeListener(com.vaadin.flow.component.details.Details details,
 ListMenu.MenuItem menuItem)

addMenuItemClickListener

protected void addMenuItemClickListener(com.vaadin.flow.component.Component menuItemComponent,
 ListMenu.MenuItem menuItem)

addMenuItemClickShortcutCombination

protected void addMenuItemClickShortcutCombination(com.vaadin.flow.component.Component menuItemComponent,
 ListMenu.MenuItem menuItem)

createMenuBarComponent

protected com.vaadin.flow.component.details.Details createMenuBarComponent(ListMenu.MenuBarItem menuBarItem)

getMenuBarContent

protected com.vaadin.flow.component.html.UnorderedList getMenuBarContent(ListMenu.MenuItem menuItem)

getMenuBarContent

protected com.vaadin.flow.component.html.UnorderedList getMenuBarContent(com.vaadin.flow.component.details.Details menuBar)

getMenuBarComponent

protected com.vaadin.flow.component.details.Details getMenuBarComponent(ListMenu.MenuItem menuItem)

getMenuItemComponent

protected com.vaadin.flow.component.Component getMenuItemComponent(ListMenu.MenuItem menuItem)

getTitle

protected String getTitle(ListMenu.MenuItem menuItem)

checkItemIdDuplicate

protected void checkItemIdDuplicate(String id)

setPrefixComponent

protected void setPrefixComponent(com.vaadin.flow.component.Component componentContainer,
 @Nullable com.vaadin.flow.component.Component prefixComponent,
 @Nullable com.vaadin.flow.component.Component oldPrefixComponent)

setSuffixComponent

protected void setSuffixComponent(com.vaadin.flow.component.Component componentContainer,
 @Nullable com.vaadin.flow.component.Component suffixComponent,
 @Nullable com.vaadin.flow.component.Component oldSuffixComponent)

onMenuItemPropertyChange

protected void onMenuItemPropertyChange(PropertyChangeEvent event)