Package io.jmix.flowui.component.usermenu

Class UserMenu

java.lang.Object

com.vaadin.flow.component.Component

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

io.jmix.flowui.kit.component.usermenu.JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>

io.jmix.flowui.component.usermenu.UserMenu

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>>, com.vaadin.flow.component.FocusNotifier<JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasOverlayClassName, com.vaadin.flow.component.shared.HasThemeVariant<UserMenuVariant>, HasViewMenuItems, HasSubParts, HasTitle, HasActionMenuItems, HasComponentMenuItems, HasMenuItems, HasTextMenuItems, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class UserMenu
extends JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>
implements HasViewMenuItems, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

A component that displays a user menu as a dropdown.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	UserMenu.UserMenuSubMenu
protected static class	UserMenu.ViewUserMenuItemImpl

Nested classes/interfaces inherited from class io.jmix.flowui.kit.component.usermenu.JmixUserMenu

JmixUserMenu.AbstractTextUserMenuItem, JmixUserMenu.AbstractUserMenuItem, JmixUserMenu.ActionUserMenuItemImpl, JmixUserMenu.ComponentUserMenuItemImpl, JmixUserMenu.HasMenuItem, JmixUserMenu.JmixUserMenuSubMenu, JmixUserMenu.Renderer<T>, JmixUserMenu.TextUserMenuItemImpl, JmixUserMenu.UserChangedEvent<USER>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected static final String	BUTTON_CONTENT_CLASS_NAME
protected CurrentUserSubstitution	currentUserSubstitution
protected Messages	messages
protected MetadataTools	metadataTools
protected static final String	SUBSTITUTED_THEME_NAME
protected UiComponents	uiComponents
protected UserRepository	userRepository

Fields inherited from class io.jmix.flowui.kit.component.usermenu.JmixUserMenu

ATTRIBUTE_JMIX_ROLE_NAME, ATTRIBUTE_JMIX_ROLE_VALUE, BASE_CLASS_NAME, buttonRenderer, headerRenderer, headerWrapper, itemsDelegate, OVERLAY_CLASS_NAME, user, userMenuItem

Constructor Summary

Constructors

Constructor	Description
UserMenu()

Method Summary

Modifier and Type	Method	Description
ViewUserMenuItem	addViewItem(String id, Class<? extends View<?>> viewClass, String text)	Adds a menu item associated with a specified view class and text.
ViewUserMenuItem	addViewItem(String id, Class<? extends View<?>> viewClass, String text, int index)	Adds a menu item associated with a specified view class and text at a specific position.
ViewUserMenuItem	addViewItem(String id, Class<? extends View<?>> viewClass, String text, com.vaadin.flow.component.Component icon)	Adds a menu item associated with a specified view class, text and icon.
ViewUserMenuItem	addViewItem(String id, Class<? extends View<?>> viewClass, String text, com.vaadin.flow.component.Component icon, int index)	Adds a menu item associated with a specified view class, text and icon at a specific position.
ViewUserMenuItem	addViewItem(String id, String viewId, String text)	Adds a menu item associated with a specified view id and text.
ViewUserMenuItem	addViewItem(String id, String viewId, String text, int index)	Adds a menu item associated with a specified view id and text at a specific position.
ViewUserMenuItem	addViewItem(String id, String viewId, String text, com.vaadin.flow.component.Component icon)	Adds a menu item associated with a specified view id, text and icon.
ViewUserMenuItem	addViewItem(String id, String viewId, String text, com.vaadin.flow.component.Component icon, int index)	Adds a menu item associated with a specified view id, text and icon at a specific position.
void	afterPropertiesSet()
protected void	autowireDependencies()
protected UserMenuItem.HasSubMenu.SubMenu	createSubMenu(JmixSubMenu subMenu)
protected UserMenuItemsDelegate	createUserMenuItemsDelegate(JmixSubMenu subMenu)
protected com.vaadin.flow.component.Component	defaultButtonRenderer(org.springframework.security.core.userdetails.UserDetails userDetails)
protected String	generateUserName(org.springframework.security.core.userdetails.UserDetails user)
protected UserMenuItemsDelegate	getItemsDelegate()
protected void	initComponent()
protected boolean	isSubstituted()
protected org.springframework.security.core.userdetails.UserDetails	loadUser()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
protected void	updateSubstitutedState()
protected void	userChangedInternal()

Methods inherited from class io.jmix.flowui.kit.component.usermenu.JmixUserMenu

addActionItem, addActionItem, addComponentItem, addComponentItem, addComponentItem, addComponentItem, addSeparator, addSeparatorAtIndex, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, addUserChangedListener, createHeaderWrapper, findItem, getItem, getItems, getSubMenu, getSubPart, getUser, initContent, initUserMenuItem, isOpenOnHover, remove, remove, removeAll, setButtonRenderer, setHeaderRenderer, setOpenOnHover, setOverlayClassName, setUser, updateButton, updateHeader

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.BlurNotifier

addBlurListener

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

addDetachListener

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

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

addFocusListener

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

getElement

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

isEnabled, setEnabled

Methods inherited from interface io.jmix.flowui.kit.component.usermenu.HasMenuItems

addSeparator, addSeparatorAtIndex, findItem, getItem, getItems, remove, remove, removeAll

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

getOverlayClassName

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

Methods inherited from interface io.jmix.flowui.kit.component.HasTitle

getTitle, setTitle

Field Details

SUBSTITUTED_THEME_NAME

protected static final String SUBSTITUTED_THEME_NAME

See Also:

• Constant Field Values

BUTTON_CONTENT_CLASS_NAME

protected static final String BUTTON_CONTENT_CLASS_NAME

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

messages

protected Messages messages

uiComponents

protected UiComponents uiComponents

metadataTools

protected MetadataTools metadataTools

userRepository

protected UserRepository userRepository

currentUserSubstitution

protected CurrentUserSubstitution currentUserSubstitution

Constructor Details

UserMenu

public UserMenu()

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

defaultButtonRenderer

@Nullable
protected com.vaadin.flow.component.Component defaultButtonRenderer(@Nullable
 org.springframework.security.core.userdetails.UserDetails userDetails)

loadUser

protected org.springframework.security.core.userdetails.UserDetails loadUser()

userChangedInternal

protected void userChangedInternal()

Overrides:

userChangedInternal in class JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>

isSubstituted

protected boolean isSubstituted()

updateSubstitutedState

protected void updateSubstitutedState()

generateUserName

protected String generateUserName(org.springframework.security.core.userdetails.UserDetails user)

addViewItem

public ViewUserMenuItem addViewItem(String id,
 Class<? extends View<?>> viewClass,
 String text)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view class and text.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewClass - the class of the view to associate with the menu item

text - the text to be set for the menu item

Returns:

the created ViewUserMenuItem instance

addViewItem

public ViewUserMenuItem addViewItem(String id,
 Class<? extends View<?>> viewClass,
 String text,
 int index)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view class and text at a specific position.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewClass - the class of the view to associate with the menu item

text - the text to be set for the menu item

index - the position at which the menu item will be added

Returns:

the created ViewUserMenuItem instance

addViewItem

public ViewUserMenuItem addViewItem(String id,
 Class<? extends View<?>> viewClass,
 String text,
 com.vaadin.flow.component.Component icon)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view class, text and icon.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewClass - the class of the view to associate with the menu item

text - the text to be set for the menu item

icon - the icon to be set for the menu item

Returns:

the created ViewUserMenuItem instance

addViewItem

public ViewUserMenuItem addViewItem(String id,
 Class<? extends View<?>> viewClass,
 String text,
 com.vaadin.flow.component.Component icon,
 int index)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view class, text and icon at a specific position.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewClass - the class of the view to associate with the menu item

text - the text to be set for the menu item

icon - the icon to be set for the menu item

index - the position at which the menu item will be added

Returns:

the created ViewUserMenuItem instance

addViewItem

public ViewUserMenuItem addViewItem(String id,
 String viewId,
 String text)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view id and text.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewId - the id of the view to associate with the menu item

text - the text to be set for the menu item

Returns:

the created ViewUserMenuItem instance

addViewItem

public ViewUserMenuItem addViewItem(String id,
 String viewId,
 String text,
 int index)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view id and text at a specific position.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewId - the id of the view to associate with the menu item

text - the text to be set for the menu item

index - the position at which the menu item will be added

Returns:

the created ViewUserMenuItem instance

addViewItem

public ViewUserMenuItem addViewItem(String id,
 String viewId,
 String text,
 com.vaadin.flow.component.Component icon)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view id, text and icon.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewId - the id of the view to associate with the menu item

text - the text to be set for the menu item

icon - the icon to be set for the menu item

Returns:

the created ViewUserMenuItem instance

addViewItem

public ViewUserMenuItem addViewItem(String id,
 String viewId,
 String text,
 com.vaadin.flow.component.Component icon,
 int index)

Description copied from interface: HasViewMenuItems

Adds a menu item associated with a specified view id, text and icon at a specific position.

Specified by:

addViewItem in interface HasViewMenuItems

Parameters:

id - the unique identifier of the menu item

viewId - the id of the view to associate with the menu item

text - the text to be set for the menu item

icon - the icon to be set for the menu item

index - the position at which the menu item will be added

Returns:

the created ViewUserMenuItem instance

getItemsDelegate

protected UserMenuItemsDelegate getItemsDelegate()

Overrides:

getItemsDelegate in class JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>

createUserMenuItemsDelegate

protected UserMenuItemsDelegate createUserMenuItemsDelegate(JmixSubMenu subMenu)

Overrides:

createUserMenuItemsDelegate in class JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>

createSubMenu

protected UserMenuItem.HasSubMenu.SubMenu createSubMenu(JmixSubMenu subMenu)

Overrides:

createSubMenu in class JmixUserMenu<org.springframework.security.core.userdetails.UserDetails>