Package io.jmix.flowui.kit.component.usermenu

Class JmixUserMenu.TextUserMenuItemImpl

java.lang.Object

io.jmix.flowui.kit.component.usermenu.JmixUserMenu.AbstractUserMenuItem

io.jmix.flowui.kit.component.usermenu.JmixUserMenu.AbstractTextUserMenuItem

io.jmix.flowui.kit.component.usermenu.JmixUserMenu.TextUserMenuItemImpl

All Implemented Interfaces:

com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<UserMenuItemVariant>, HasSubParts, JmixUserMenu.HasMenuItem, TextUserMenuItem, UserMenuItem, UserMenuItem.HasClickListener<TextUserMenuItem>, UserMenuItem.HasSubMenu, Serializable

Enclosing class:

JmixUserMenu<USER>

protected static class JmixUserMenu.TextUserMenuItemImpl
extends JmixUserMenu.AbstractTextUserMenuItem
implements TextUserMenuItem

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.kit.component.usermenu.UserMenuItem

UserMenuItem.HasClickListener<ITEM extends UserMenuItem>, UserMenuItem.HasSubMenu

Nested classes/interfaces inherited from interface io.jmix.flowui.kit.component.usermenu.UserMenuItem.HasClickListener

UserMenuItem.HasClickListener.ClickEvent<ITEM extends UserMenuItem>

Nested classes/interfaces inherited from interface io.jmix.flowui.kit.component.usermenu.UserMenuItem.HasSubMenu

UserMenuItem.HasSubMenu.SubMenu

Field Summary

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

icon, text

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

id, item, menuItemClickListenerRegistration, subMenu, userMenu

Fields inherited from interface io.jmix.flowui.kit.component.usermenu.TextUserMenuItem

PROP_ICON, PROP_TEXT

Fields inherited from interface io.jmix.flowui.kit.component.usermenu.UserMenuItem

PROP_CHECKABLE, PROP_CHECKED, PROP_ENABLED, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
TextUserMenuItemImpl(String id, JmixUserMenu<?> userMenu, JmixMenuItem item, String text)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addClickListener(Consumer<UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem>> listener)	Adds a listener to handle click events for the user menu item.
com.vaadin.flow.component.Component	getIcon()	Retrieves the icon associated with this user menu item, if one exists.
UserMenuItem.HasSubMenu.SubMenu	getSubMenu()	Retrieves the submenu associated with this user menu item.
String	getText()	Returns the text contained within this user menu item.
void	setIcon(com.vaadin.flow.component.Component icon)	Sets the icon for this user menu item.
void	setText(String text)	Sets the text contained within this user menu item.

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

addClickListenerInternal, addPropertyChangeListener, createSubMenu, firePropertyChange, getElement, getEventBus, getId, getItem, getSubPart, hasListener, internalRemoveClickListener, isCheckable, isChecked, isEnabled, isVisible, setCheckable, setChecked, setEnabled, setVisible, toString, updateContent

Methods inherited from class java.lang.Object

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

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

getElement

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

getSubPart

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.usermenu.UserMenuItem

addPropertyChangeListener, getId, isCheckable, isChecked, isEnabled, isVisible, setCheckable, setChecked, setEnabled, setVisible

Constructor Details

TextUserMenuItemImpl

public TextUserMenuItemImpl(String id,
 JmixUserMenu<?> userMenu,
 JmixMenuItem item,
 String text)

Method Details

getText

public String getText()

Description copied from interface: TextUserMenuItem

Returns the text contained within this user menu item.

Specified by:

getText in interface TextUserMenuItem

Overrides:

getText in class JmixUserMenu.AbstractTextUserMenuItem

Returns:

the text of the menu item

setText

public void setText(String text)

Description copied from interface: TextUserMenuItem

Sets the text contained within this user menu item.

Specified by:

setText in interface TextUserMenuItem

Overrides:

setText in class JmixUserMenu.AbstractTextUserMenuItem

Parameters:

text - the text to be set for the menu item

getIcon

@Nullable
public com.vaadin.flow.component.Component getIcon()

Description copied from interface: TextUserMenuItem

Retrieves the icon associated with this user menu item, if one exists.

Specified by:

getIcon in interface TextUserMenuItem

Overrides:

getIcon in class JmixUserMenu.AbstractTextUserMenuItem

Returns:

the icon component of this menu item, or null if no icon is set

setIcon

public void setIcon(@Nullable
 com.vaadin.flow.component.Component icon)

Description copied from interface: TextUserMenuItem

Sets the icon for this user menu item.

Specified by:

setIcon in interface TextUserMenuItem

Overrides:

setIcon in class JmixUserMenu.AbstractTextUserMenuItem

Parameters:

icon - the icon to set for this menu item; can be null to remove the icon

getSubMenu

public UserMenuItem.HasSubMenu.SubMenu getSubMenu()

Description copied from interface: UserMenuItem.HasSubMenu

Retrieves the submenu associated with this user menu item. A submenu is a container for additional menu items, providing hierarchical structuring of user menu options.

Specified by:

getSubMenu in interface UserMenuItem.HasSubMenu

Overrides:

getSubMenu in class JmixUserMenu.AbstractUserMenuItem

Returns:

the submenu associated with this user menu item

addClickListener

public com.vaadin.flow.shared.Registration addClickListener(Consumer<UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem>> listener)

Description copied from interface: UserMenuItem.HasClickListener

Adds a listener to handle click events for the user menu item. When the item is clicked, the provided Consumer processes the associated UserMenuItem.HasClickListener.ClickEvent.

Specified by:

addClickListener in interface UserMenuItem.HasClickListener<TextUserMenuItem>

Parameters:

listener - the Consumer to handle the UserMenuItem.HasClickListener.ClickEvent triggered by a click on the item

Returns:

a Registration object that can be used to remove the added listener