Package io.jmix.flowui.component.usermenu

Class UserMenuItemsDelegate

java.lang.Object

io.jmix.flowui.kit.component.usermenu.JmixUserMenuItemsDelegate

io.jmix.flowui.component.usermenu.UserMenuItemsDelegate

All Implemented Interfaces:

HasViewMenuItems, HasActionMenuItems, HasComponentMenuItems, HasMenuItems, HasTextMenuItems

@Component("flowui_UserMenuItemsDelegate")
@Scope("prototype")
public class UserMenuItemsDelegate
extends JmixUserMenuItemsDelegate
implements HasViewMenuItems

Delegate class for managing UserMenuItem collection.

Nested Class Summary

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

JmixUserMenuItemsDelegate.SeparatorUserMenuItem

Field Summary

Fields

Modifier and Type	Field	Description
protected DialogWindows	dialogWindows
protected ViewNavigators	viewNavigators

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

items, propertyChangeRegistrations, subMenu, userMenu

Constructor Summary

Constructors

Constructor	Description
UserMenuItemsDelegate(JmixUserMenu<?> userMenu, JmixSubMenu subMenu)

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.
protected ViewUserMenuItem	addViewItemInternal(String id, Class<? extends View<?>> viewClass, String text, com.vaadin.flow.component.Component icon, int index)
protected ViewUserMenuItem	addViewItemInternal(String id, String viewId, String text, com.vaadin.flow.component.Component icon, int index)
protected void	attachItem(UserMenuItem item)
protected void	detachItem(UserMenuItem item)
void	setDialogWindows(DialogWindows dialogWindows)
void	setViewNavigators(ViewNavigators viewNavigators)

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

addActionItem, addActionItem, addComponentItem, addComponentItem, addComponentItem, addComponentItem, addItemInternal, addItemInternal, addItemInternal, addSeparator, addSeparatorAtIndex, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, addTextItem, adjustPhysicalIndex, createMenuItem, findItem, getItem, getItems, onItemPropertyChange, remove, remove, removeAll, updateItemsVisibility

Methods inherited from class java.lang.Object

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

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

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

Field Details

viewNavigators

protected ViewNavigators viewNavigators

dialogWindows

protected DialogWindows dialogWindows

Constructor Details

UserMenuItemsDelegate

public UserMenuItemsDelegate(JmixUserMenu<?> userMenu,
 JmixSubMenu subMenu)

Method Details

setViewNavigators

@Autowired
public void setViewNavigators(ViewNavigators viewNavigators)

setDialogWindows

@Autowired
public void setDialogWindows(DialogWindows dialogWindows)

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

addViewItemInternal

protected ViewUserMenuItem addViewItemInternal(String id,
 Class<? extends View<?>> viewClass,
 String text,
 @Nullable
 com.vaadin.flow.component.Component icon,
 int index)

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

addViewItemInternal

protected ViewUserMenuItem addViewItemInternal(String id,
 String viewId,
 String text,
 @Nullable
 com.vaadin.flow.component.Component icon,
 int index)

attachItem

protected void attachItem(UserMenuItem item)

Overrides:

attachItem in class JmixUserMenuItemsDelegate

detachItem

protected void detachItem(UserMenuItem item)

Overrides:

detachItem in class JmixUserMenuItemsDelegate