Package io.jmix.flowui.component.main

Class JmixListMenu

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

io.jmix.flowui.component.main.JmixListMenu

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>, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.internal.AfterNavigationHandler, HasMenuItemProvider<ListMenu.MenuItem>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

TabbedModeListMenu

public class JmixListMenu
extends ListMenu
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean, HasMenuItemProvider<ListMenu.MenuItem>, com.vaadin.flow.router.AfterNavigationObserver

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmixListMenu.BeanMenuItem
static class	JmixListMenu.ViewMenuItem	Describes menu item that should navigate to the view.

Nested classes/interfaces inherited from class io.jmix.flowui.kit.component.main.ListMenu

ListMenu.ListMenuBarOpenedChangeEvent, ListMenu.MenuBarItem, ListMenu.MenuItem, ListMenu.MenuSeparatorItem

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected Subscription	itemCollectionChangedSubscription
protected MenuItemProvider<ListMenu.MenuItem>	itemProvider
protected static final String	JMIX_MENU_ITEM_BEAN_CLASS_NAME
protected static final String	JMIX_MENU_ITEM_VIEW_CLASS_NAME
protected UiComponents	uiComponents
protected ViewRegistry	viewRegistry

Fields inherited from class io.jmix.flowui.kit.component.main.ListMenu

JMIX_LIST_MENU_CLASS_NAME, JMIX_MENU_ITEM_CLASS_NAME, JMIX_MENUBAR_ITEM_CLASS_NAME, JMIX_MENUBAR_SUMMARY_ICON_CONTAINER_CLASS_NAME, LINK_TEXT_CLASS_NAME, MENUBAR_LIST_CLASS_NAME, MENUBAR_SUMMARY_CLASS_NAME, menuItemPropertyChangeListener, PREFIX_COMPONENT_CLASS_NAME, registrations, rootMenuItems, SUFFIX_COMPONENT_CLASS_NAME

Constructor Summary

Constructors

Constructor	Description
JmixListMenu()

Method Summary

Modifier and Type	Method	Description
protected void	addMenuItemClickListener(com.vaadin.flow.component.Component menuItemComponent, ListMenu.MenuItem menuItem)
void	afterNavigation(com.vaadin.flow.router.AfterNavigationEvent event)
void	afterPropertiesSet()
protected void	autowireDependencies()
protected com.vaadin.flow.component.button.Button	createBeanMenuItemComponent(JmixListMenu.BeanMenuItem menuItem)
protected com.vaadin.flow.component.button.Button	createButton()
protected com.vaadin.flow.component.Component	createMenuItemComponent(ListMenu.MenuItem menuItem)
protected com.vaadin.flow.router.RouterLink	createRouterLink()
protected com.vaadin.flow.router.RouterLink	createViewMenuItemComponent(JmixListMenu.ViewMenuItem menuItem)
protected void	expandActiveMenuItemParents(com.vaadin.flow.router.AfterNavigationEvent event)
protected void	expandActiveMenuItemParents(ListMenu.MenuItem menuItem, List<ListMenu.MenuBarItem> parentMenuItems, com.vaadin.flow.router.AfterNavigationEvent event)
protected Class<? extends View<?>>	getControllerClass(JmixListMenu.ViewMenuItem menuItem)
protected List<String>	getMenuItemComponentClassNames(ListMenu.MenuItem menuItem)
@Nullable MenuItemProvider<ListMenu.MenuItem>	getMenuItemProvider()
protected boolean	isSupportedView(Class<?> targetView)
void	loadMenuConfig()	Loads menu items from MenuConfig.
protected void	onMenuItemCollectionChanged(MenuItemProvider.CollectionChangeEvent<ListMenu.MenuItem> e)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setMenuItemProvider(@Nullable MenuItemProvider<ListMenu.MenuItem> itemProvider)	Sets menu item provider
protected boolean	shouldHighlightMenuItem(ListMenu.MenuItem menuItem, com.vaadin.flow.router.AfterNavigationEvent event)

Methods inherited from class io.jmix.flowui.kit.component.main.ListMenu

addChildren, addChildren, addMenuItem, addMenuItem, addMenuItemClickShortcutCombination, addMenuItemText, addMenuOpenedChangeListener, attachMenuItemRecursively, checkItemIdDuplicate, createMenuBarComponent, createMenuItemContentComponent, createMenuItemText, createMenuRecursively, detachMenuItemRecursively, getMenuBarComponent, getMenuBarContent, getMenuBarContent, getMenuItem, getMenuItemComponent, getMenuItems, getTitle, initContent, initMenuItemComponent, onMenuItemPropertyChange, registerMenuItem, removeAllMenuItems, removeMenuItem, removeMenuItem, setPrefixComponent, setSuffixComponent, unregisterMenuItemRecursively, updateMenuItemComponentClassNames

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_MENU_ITEM_VIEW_CLASS_NAME

protected static final String JMIX_MENU_ITEM_VIEW_CLASS_NAME

See Also:

• Constant Field Values

JMIX_MENU_ITEM_BEAN_CLASS_NAME

protected static final String JMIX_MENU_ITEM_BEAN_CLASS_NAME

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

uiComponents

protected UiComponents uiComponents

viewRegistry

protected ViewRegistry viewRegistry

itemProvider

protected MenuItemProvider<ListMenu.MenuItem> itemProvider

itemCollectionChangedSubscription

protected Subscription itemCollectionChangedSubscription

Constructor Details

JmixListMenu

public JmixListMenu()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

autowireDependencies

protected void autowireDependencies()

createRouterLink

protected com.vaadin.flow.router.RouterLink createRouterLink()

createButton

protected com.vaadin.flow.component.button.Button createButton()

loadMenuConfig

public void loadMenuConfig()

Loads menu items from MenuConfig.

createMenuItemComponent

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

Overrides:

createMenuItemComponent in class ListMenu

createViewMenuItemComponent

protected com.vaadin.flow.router.RouterLink createViewMenuItemComponent(JmixListMenu.ViewMenuItem menuItem)

getMenuItemComponentClassNames

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

Overrides:

getMenuItemComponentClassNames in class ListMenu

createBeanMenuItemComponent

protected com.vaadin.flow.component.button.Button createBeanMenuItemComponent(JmixListMenu.BeanMenuItem menuItem)

addMenuItemClickListener

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

Overrides:

addMenuItemClickListener in class ListMenu

getControllerClass

protected Class<? extends View<?>> getControllerClass(JmixListMenu.ViewMenuItem menuItem)

isSupportedView

protected boolean isSupportedView(Class<?> targetView)

setMenuItemProvider

public void setMenuItemProvider(@Nullable MenuItemProvider<ListMenu.MenuItem> itemProvider)

Description copied from interface: HasMenuItemProvider

Sets menu item provider

Specified by:

setMenuItemProvider in interface HasMenuItemProvider<ListMenu.MenuItem>

Parameters:

itemProvider - menu item provider to set

onMenuItemCollectionChanged

protected void onMenuItemCollectionChanged(MenuItemProvider.CollectionChangeEvent<ListMenu.MenuItem> e)

getMenuItemProvider

public @Nullable MenuItemProvider<ListMenu.MenuItem> getMenuItemProvider()

Specified by:

getMenuItemProvider in interface HasMenuItemProvider<ListMenu.MenuItem>

Returns:

menu item provider

afterNavigation

public void afterNavigation(com.vaadin.flow.router.AfterNavigationEvent event)

Specified by:

afterNavigation in interface com.vaadin.flow.router.internal.AfterNavigationHandler

expandActiveMenuItemParents

protected void expandActiveMenuItemParents(com.vaadin.flow.router.AfterNavigationEvent event)

expandActiveMenuItemParents

protected void expandActiveMenuItemParents(ListMenu.MenuItem menuItem,
 List<ListMenu.MenuBarItem> parentMenuItems,
 com.vaadin.flow.router.AfterNavigationEvent event)

shouldHighlightMenuItem

protected boolean shouldHighlightMenuItem(ListMenu.MenuItem menuItem,
 com.vaadin.flow.router.AfterNavigationEvent event)