Package io.jmix.flowui.component.usermenu

Interface ViewUserMenuItem

All Superinterfaces:

com.vaadin.flow.component.HasElement, HasSubParts, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<UserMenuItemVariant>, Serializable, UserMenuItem

All Known Implementing Classes:

UserMenu.ViewUserMenuItemImpl

@NullMarked
public interface ViewUserMenuItem
extends UserMenuItem

Represents a specific type of UserMenuItem that is associated with an View.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_ICON
static final String	PROP_OPEN_MODE
static final String	PROP_TEXT

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

PROP_CHECKABLE, PROP_CHECKED, PROP_ENABLED, PROP_VISIBLE

Method Summary

Modifier and Type	Method	Description
@Nullable com.vaadin.flow.component.Component	getIcon()	Retrieves the icon associated with this user menu item, if one exists.
@Nullable OpenMode	getOpenMode()	Returns the view open mode.
String	getText()	Returns the text contained within this user menu item.
@Nullable Class<? extends View<?>>	getViewClass()	Returns the view class if it was set.
@Nullable String	getViewId()	Returns the view id if it was set.
void	setIcon(@Nullable com.vaadin.flow.component.Component icon)	Sets the icon for this user menu item.
void	setOpenMode(@Nullable OpenMode openMode)	Sets the view open mode.
void	setText(String text)	Sets the text contained within this user menu item.

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, 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

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

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

Field Details

PROP_TEXT

static final String PROP_TEXT

See Also:

• Constant Field Values

PROP_ICON

static final String PROP_ICON

See Also:

• Constant Field Values

PROP_OPEN_MODE

static final String PROP_OPEN_MODE

See Also:

• Constant Field Values

Method Details

getText

String getText()

Returns the text contained within this user menu item.

Returns:

the text of the menu item

setText

void setText(String text)

Sets the text contained within this user menu item.

Parameters:

text - the text to be set for the menu item

getIcon

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

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

Returns:

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

setIcon

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

Sets the icon for this user menu item.

Parameters:

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

getOpenMode

@Nullable OpenMode getOpenMode()

Returns the view open mode.

Returns:

the open mode, or null if not set

setOpenMode

void setOpenMode(@Nullable OpenMode openMode)

Sets the view open mode.

Parameters:

openMode - the open mode to set

getViewId

@Nullable String getViewId()

Returns the view id if it was set.

Returns:

the view id if it was set, otherwise returns null

getViewClass

@Nullable Class<? extends View<?>> getViewClass()

Returns the view class if it was set.

Returns:

the view class, otherwise returns null.