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>, HasMenuItemProvider<ListMenu.MenuItem>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class JmixListMenu
extends ListMenu
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean, HasMenuItemProvider<ListMenu.MenuItem>

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.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 UiComponents	uiComponents
protected ViewRegistry	viewRegistry

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

FLEX_CLASS_NAME, FONT_MEDIUM_CLASS_NAME, JMIX_LIST_MENU_CLASS_NAME, JMIX_MENU_ITEM_LINK_CLASS_NAME, JMIX_MENUBAR_ITEM_CLASS_NAME, JMIX_MENUBAR_SUMMARY_ICON_CONTAINER_CLASS_NAME, LINK_ICON_CLASS_NAME, LINK_TEXT_CLASS_NAME, LIST_NONE_CLASS_NAME, MARGIN_NONE_CLASS_NAME, MENUBAR_ICON_CLASS_NAME, MENUBAR_LIST_CLASS_NAME, MENUBAR_SUMMARY_CLASS_NAME, menuItemPropertyChangeListener, PADDING_NONE_CLASS_NAME, PREFIX_COMPONENT_CLASS_NAME, registrations, rootMenuItems, SUFFIX_COMPONENT_CLASS_NAME, TEXT_SMALL_CLASS_NAME

Constructor Summary

Constructors

Constructor	Description
JmixListMenu()

Method Summary

Modifier and Type	Method	Description
protected void	addMenuItemClickListener(com.vaadin.flow.router.RouterLink routerLink, ListMenu.MenuItem menuItem)
void	afterPropertiesSet()
protected void	autowireDependencies()
protected com.vaadin.flow.router.RouterLink	createMenuItemComponent(ListMenu.MenuItem menuItem)
protected Class<? extends View<?>>	getControllerClass(JmixListMenu.ViewMenuItem menuItem)
MenuItemProvider<ListMenu.MenuItem>	getMenuItemProvider()
protected void	initComponent()
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(MenuItemProvider<ListMenu.MenuItem> itemProvider)	Sets menu item provider

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

addChildren, addChildren, addMenuItem, addMenuItem, addMenuItemClickShortcutCombination, attachMenuItemRecursively, checkItemIdDuplicate, createMenuBarComponent, createMenuRecursively, detachMenuItemRecursively, getMenuBarComponent, getMenuBarContent, getMenuBarContent, getMenuItem, getMenuItemComponent, getMenuItems, getTitle, initContent, onMenuItemPropertyChange, registerMenuItem, removeAllMenuItems, removeMenuItem, removeMenuItem, setPrefixComponent, setSuffixComponent, unregisterMenuItemRecursively

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

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

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

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

addThemeVariants, removeThemeVariants

Field Details

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

initComponent

protected void initComponent()

loadMenuConfig

public void loadMenuConfig()

Loads menu items from MenuConfig.

createMenuItemComponent

protected com.vaadin.flow.router.RouterLink createMenuItemComponent(ListMenu.MenuItem menuItem)

Overrides:

createMenuItemComponent in class ListMenu

addMenuItemClickListener

protected void addMenuItemClickListener(com.vaadin.flow.router.RouterLink routerLink,
 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

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

Specified by:

getMenuItemProvider in interface HasMenuItemProvider<ListMenu.MenuItem>

Returns:

menu item provider