Package io.jmix.flowui.component.horizontalmenu

Class HorizontalMenu

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<JmixMenuBar>

io.jmix.flowui.component.horizontalmenu.HorizontalMenu

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, HasMenuItemProvider<HorizontalMenu.AbstractMenuItem<?>>, Serializable

public class HorizontalMenu
extends com.vaadin.flow.component.Composite<JmixMenuBar>
implements HasMenuItemProvider<HorizontalMenu.AbstractMenuItem<?>>, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle

Represents horizontal menu that can be used for navigation to a view or for invoking a method of a bean

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HorizontalMenu.AbstractContentMenuItem<T extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents>	Provides base functionality for items that contain text with suffix and prefix components
static class	HorizontalMenu.AbstractMenuItem<T extends com.vaadin.flow.component.Component>	Provides base functionality for horizontal menu items
static class	HorizontalMenu.MenuItem	Represents horizontal menu item that can run some action on click
static class	HorizontalMenu.ParentMenuItem	Represents menu item that can contain other menu items.
static class	HorizontalMenu.SeparatorMenuItem	Represents a separator
static class	HorizontalMenu.ViewMenuItem	Represents an item which navigates to a view on click

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ADD_TO_END_INDEX
protected Map<String,HorizontalMenu.AbstractMenuItem<?>>	allMenuItems
protected static final String	HORIZONTAL_MENU_CLASS_NAME
protected static final String	ITEM_WRAPPER_CLASS_NAME
protected Subscription	itemCollectionChangedSubscription
protected MenuItemProvider<HorizontalMenu.AbstractMenuItem<?>>	menuItemProvider
protected static final String	ROOT_MENU_ITEM_CLASS_NAME
protected List<HorizontalMenu.AbstractMenuItem<?>>	rootMenuItems

Constructor Summary

Constructors

Constructor	Description
HorizontalMenu()

Method Summary

Modifier and Type	Method	Description
protected void	addChildItem(HorizontalMenu.AbstractMenuItem<?> menuItem, HorizontalMenu.ParentMenuItem parentMenuItem, int index)
protected void	addComponentToSubMenu(com.vaadin.flow.component.Component component, JmixSubMenu subMenu, int index)
void	addMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem)	Adds menu item and its children to menu root.
void	addMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem, int index)	Adds menu item and its children to menu root at the specified position.
protected void	addMenuItemRecursive(HorizontalMenu.AbstractMenuItem<?> childMenuItem, HorizontalMenu.ParentMenuItem parentMenuItem, int index)
protected void	addMenuItemToSubMenu(HorizontalMenu.AbstractMenuItem<?> menuItem, JmixSubMenu subMenu, int index)
protected void	attachMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem)
protected void	checkDuplicateItemId(String id)
protected void	detachMenuItemRecursive(HorizontalMenu.AbstractMenuItem<?> menuItem)
HorizontalMenu.AbstractMenuItem<?>	getMenuItem(String id)	Returns menu item from the menu (including non-root items) by its id.
protected String	getMenuItemId(HorizontalMenu.AbstractMenuItem<?> menuItem)
MenuItemProvider<HorizontalMenu.AbstractMenuItem<?>>	getMenuItemProvider()
List<HorizontalMenu.AbstractMenuItem<?>>	getMenuItems()
protected JmixSubMenu	getParentSubMenu(HorizontalMenu.ParentMenuItem parentMenuItem)
protected JmixMenuBar	initContent()
boolean	isTabNavigation()	Gets whether the horizontal menu uses tab navigation.
protected void	onMenuItemCollectionChanged(MenuItemProvider.CollectionChangeEvent<HorizontalMenu.AbstractMenuItem<?>> e)
void	removeAllMenuItems()	Removes all menu items from the menu.
protected void	removeChildItem(HorizontalMenu.AbstractMenuItem<?> menuItem, HorizontalMenu.ParentMenuItem parentMenuItem)
void	removeMenuItem(int index)	Removes root menu item by index.
void	removeMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem)	Removes menu item and its children from the menu.
protected void	removeRootItem(HorizontalMenu.AbstractMenuItem<?> menuItem)
void	setMenuItemProvider(MenuItemProvider<HorizontalMenu.AbstractMenuItem<?>> menuItemProvider)	Sets menu item provider
void	setTabNavigation(boolean tabNavigation)	Sets tab navigation for the horizontal menu.

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

getChildren, getContent, getElement

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

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, 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

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, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

HORIZONTAL_MENU_CLASS_NAME

protected static final String HORIZONTAL_MENU_CLASS_NAME

See Also:

• Constant Field Values

ROOT_MENU_ITEM_CLASS_NAME

protected static final String ROOT_MENU_ITEM_CLASS_NAME

See Also:

• Constant Field Values

ITEM_WRAPPER_CLASS_NAME

protected static final String ITEM_WRAPPER_CLASS_NAME

See Also:

• Constant Field Values

ADD_TO_END_INDEX

protected static final int ADD_TO_END_INDEX

See Also:

• Constant Field Values

menuItemProvider

protected MenuItemProvider<HorizontalMenu.AbstractMenuItem<?>> menuItemProvider

itemCollectionChangedSubscription

protected Subscription itemCollectionChangedSubscription

rootMenuItems

protected List<HorizontalMenu.AbstractMenuItem<?>> rootMenuItems

allMenuItems

protected Map<String,HorizontalMenu.AbstractMenuItem<?>> allMenuItems

Constructor Details

HorizontalMenu

public HorizontalMenu()

Method Details

initContent

protected JmixMenuBar initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<JmixMenuBar>

getMenuItemProvider

@Nullable
public MenuItemProvider<HorizontalMenu.AbstractMenuItem<?>> getMenuItemProvider()

Specified by:

getMenuItemProvider in interface HasMenuItemProvider<HorizontalMenu.AbstractMenuItem<?>>

Returns:

menu item provider

setMenuItemProvider

public void setMenuItemProvider(@Nullable
 MenuItemProvider<HorizontalMenu.AbstractMenuItem<?>> menuItemProvider)

Description copied from interface: HasMenuItemProvider

Sets menu item provider

Specified by:

setMenuItemProvider in interface HasMenuItemProvider<HorizontalMenu.AbstractMenuItem<?>>

Parameters:

menuItemProvider - menu item provider to set

onMenuItemCollectionChanged

protected void onMenuItemCollectionChanged(MenuItemProvider.CollectionChangeEvent<HorizontalMenu.AbstractMenuItem<?>> e)

isTabNavigation

public boolean isTabNavigation()

Gets whether the horizontal menu uses tab navigation.

Returns:

true if the top-level menu items is traversable by tab instead of arrow keys (i.e. disabling roving tabindex)

setTabNavigation

public void setTabNavigation(boolean tabNavigation)

Sets tab navigation for the horizontal menu.

Parameters:

tabNavigation - if true, the top-level menu items is traversable by tab instead of arrow keys (i.e. disabling roving tabindex)

getMenuItem

@Nullable
public HorizontalMenu.AbstractMenuItem<?> getMenuItem(String id)

Returns menu item from the menu (including non-root items) by its id.

Parameters:

id - menu item id

Returns:

menu item or null if not found

getMenuItems

public List<HorizontalMenu.AbstractMenuItem<?>> getMenuItems()

Returns:

immutable list of root menu items

addMenuItem

public void addMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem)

Adds menu item and its children to menu root.

Parameters:

menuItem - menu item to add

addMenuItemRecursive

protected void addMenuItemRecursive(HorizontalMenu.AbstractMenuItem<?> childMenuItem,
 @Nullable
 HorizontalMenu.ParentMenuItem parentMenuItem,
 int index)

getMenuItemId

protected String getMenuItemId(HorizontalMenu.AbstractMenuItem<?> menuItem)

checkDuplicateItemId

protected void checkDuplicateItemId(String id)

getParentSubMenu

@Nullable
protected JmixSubMenu getParentSubMenu(@Nullable
 HorizontalMenu.ParentMenuItem parentMenuItem)

addMenuItemToSubMenu

protected void addMenuItemToSubMenu(HorizontalMenu.AbstractMenuItem<?> menuItem,
 @Nullable
 JmixSubMenu subMenu,
 int index)

addComponentToSubMenu

protected void addComponentToSubMenu(com.vaadin.flow.component.Component component,
 JmixSubMenu subMenu,
 int index)

attachMenuItem

protected void attachMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem)

addMenuItem

public void addMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem,
 int index)

Adds menu item and its children to menu root at the specified position.

Parameters:

menuItem - menu item to add

index - index at which the item will be inserted

addChildItem

protected void addChildItem(HorizontalMenu.AbstractMenuItem<?> menuItem,
 HorizontalMenu.ParentMenuItem parentMenuItem,
 int index)

removeMenuItem

public void removeMenuItem(HorizontalMenu.AbstractMenuItem<?> menuItem)

Removes menu item and its children from the menu.

Parameters:

menuItem - menu item to remove

removeRootItem

protected void removeRootItem(HorizontalMenu.AbstractMenuItem<?> menuItem)

detachMenuItemRecursive

protected void detachMenuItemRecursive(HorizontalMenu.AbstractMenuItem<?> menuItem)

removeChildItem

protected void removeChildItem(HorizontalMenu.AbstractMenuItem<?> menuItem,
 HorizontalMenu.ParentMenuItem parentMenuItem)

removeMenuItem

public void removeMenuItem(int index)

Removes root menu item by index.

Parameters:

index - index of an item to remove

removeAllMenuItems

public void removeAllMenuItems()

Removes all menu items from the menu.