Package io.jmix.flowui.component.usermenu

Class UserMenu.ViewUserMenuItemImpl

java.lang.Object

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

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

io.jmix.flowui.component.usermenu.UserMenu.ViewUserMenuItemImpl

All Implemented Interfaces:

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

Enclosing class:

UserMenu

protected static class UserMenu.ViewUserMenuItemImpl
extends JmixUserMenu.AbstractTextUserMenuItem
implements ViewUserMenuItem

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

Field Summary

Fields

Modifier and Type	Field	Description
protected DialogWindows	dialogWindows
protected OpenMode	openMode
protected Class<? extends View<?>>	viewClass
protected String	viewId
protected ViewNavigators	viewNavigators

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

PROP_CHECKABLE, PROP_CHECKED, PROP_ENABLED, PROP_VISIBLE

Fields inherited from interface io.jmix.flowui.component.usermenu.ViewUserMenuItem

PROP_ICON, PROP_OPEN_MODE, PROP_TEXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ViewUserMenuItemImpl(String id, JmixUserMenu<?> userMenu, JmixMenuItem item, String text, ViewNavigators viewNavigators, DialogWindows dialogWindows)
	ViewUserMenuItemImpl(String id, JmixUserMenu<?> userMenu, JmixMenuItem item, String text, Class<? extends View<?>> viewClass, ViewNavigators viewNavigators, DialogWindows dialogWindows)
	ViewUserMenuItemImpl(String id, JmixUserMenu<?> userMenu, JmixMenuItem item, String text, String viewId, ViewNavigators viewNavigators, DialogWindows dialogWindows)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.component.Component	getIcon()	Retrieves the icon associated with this user menu item, if one exists.
OpenMode	getOpenMode()	Returns the view open mode.
String	getText()	Returns the text contained within this user menu item.
Class<? extends View<?>>	getViewClass()	Returns the view class if it was set.
String	getViewId()	Returns the view id if it was set.
protected void	initItem()
protected void	navigate()
protected void	openDialog()
protected void	openView(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.contextmenu.MenuItem> event)
void	setIcon(com.vaadin.flow.component.Component icon)	Sets the icon for this user menu item.
void	setOpenMode(OpenMode openMode)	Sets the view open mode.
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, getSubMenu, 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

Field Details

viewId

protected String viewId

viewClass

protected Class<? extends View<?>> viewClass

openMode

protected OpenMode openMode

viewNavigators

protected ViewNavigators viewNavigators

dialogWindows

protected DialogWindows dialogWindows

Constructor Details

ViewUserMenuItemImpl

public ViewUserMenuItemImpl(String id,
 JmixUserMenu<?> userMenu,
 JmixMenuItem item,
 String text,
 Class<? extends View<?>> viewClass,
 ViewNavigators viewNavigators,
 DialogWindows dialogWindows)

ViewUserMenuItemImpl

public ViewUserMenuItemImpl(String id,
 JmixUserMenu<?> userMenu,
 JmixMenuItem item,
 String text,
 String viewId,
 ViewNavigators viewNavigators,
 DialogWindows dialogWindows)

ViewUserMenuItemImpl

protected ViewUserMenuItemImpl(String id,
 JmixUserMenu<?> userMenu,
 JmixMenuItem item,
 String text,
 ViewNavigators viewNavigators,
 DialogWindows dialogWindows)

Method Details

initItem

protected void initItem()

openView

protected void openView(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.contextmenu.MenuItem> event)

openDialog

protected void openDialog()

navigate

protected void navigate()

getText

public String getText()

Description copied from interface: ViewUserMenuItem

Returns the text contained within this user menu item.

Specified by:

getText in interface ViewUserMenuItem

Overrides:

getText in class JmixUserMenu.AbstractTextUserMenuItem

Returns:

the text of the menu item

setText

public void setText(String text)

Description copied from interface: ViewUserMenuItem

Sets the text contained within this user menu item.

Specified by:

setText in interface ViewUserMenuItem

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: ViewUserMenuItem

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

Specified by:

getIcon in interface ViewUserMenuItem

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: ViewUserMenuItem

Sets the icon for this user menu item.

Specified by:

setIcon in interface ViewUserMenuItem

Overrides:

setIcon in class JmixUserMenu.AbstractTextUserMenuItem

Parameters:

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

getOpenMode

@Nullable
public OpenMode getOpenMode()

Description copied from interface: ViewUserMenuItem

Returns the view open mode.

Specified by:

getOpenMode in interface ViewUserMenuItem

Returns:

the open mode, or null if not set

setOpenMode

public void setOpenMode(@Nullable
 OpenMode openMode)

Description copied from interface: ViewUserMenuItem

Sets the view open mode.

Specified by:

setOpenMode in interface ViewUserMenuItem

Parameters:

openMode - the open mode to set

getViewId

@Nullable
public String getViewId()

Description copied from interface: ViewUserMenuItem

Returns the view id if it was set.

Specified by:

getViewId in interface ViewUserMenuItem

Returns:

the view id if it was set, otherwise returns null

getViewClass

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

Description copied from interface: ViewUserMenuItem

Returns the view class if it was set.

Specified by:

getViewClass in interface ViewUserMenuItem

Returns:

the view class, otherwise returns null.