Package io.jmix.flowui.component.usermenu

Interface HasViewMenuItems

All Superinterfaces:

HasMenuItems

All Known Implementing Classes:

UserMenu, UserMenu.UserMenuSubMenu, UserMenuItemsDelegate

public interface HasViewMenuItems
extends HasMenuItems

Defines a set of methods for JmixUserMenu components where menu items associated with a View.

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.

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

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

Method Details

addViewItem

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

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

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

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.

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

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.

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

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.

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

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

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

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

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.

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

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.

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

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.

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