Package io.jmix.flowui.component.main

Class JmixListMenu.ViewMenuItem

java.lang.Object

io.jmix.flowui.kit.component.main.ListMenu.MenuItem

io.jmix.flowui.component.main.JmixListMenu.ViewMenuItem

Enclosing class:

JmixListMenu

public static class JmixListMenu.ViewMenuItem
extends ListMenu.MenuItem

Describes menu item that should navigate to the view.

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<? extends View<?>>	controllerClass
protected com.vaadin.flow.router.QueryParameters	queryParameters
protected com.vaadin.flow.router.RouteParameters	routeParameters

Fields inherited from class io.jmix.flowui.kit.component.main.ListMenu.MenuItem

classNames, clickHandler, description, icon, id, menuComponent, propertyChangeSupport, shortcutCombination, title

Constructor Summary

Constructors

Constructor	Description
ViewMenuItem(String id)

Method Summary

Modifier and Type	Method	Description
static ListMenu.MenuItem	create(Class<? extends View<?>> controllerClass)
static JmixListMenu.ViewMenuItem	create(String viewId)	Creates menu item that should navigate to the view with provided ID.
Class<? extends View<?>>	getControllerClass()
com.vaadin.flow.router.QueryParameters	getQueryParameters()
com.vaadin.flow.router.RouteParameters	getRouteParameters()
JmixListMenu.ViewMenuItem	withClassNames(List<String> classNames)	Sets class names that should be added to the menu item.
JmixListMenu.ViewMenuItem	withControllerClass(Class<? extends View<?>> controllerClass)	Sets view class that should be shown when the user clicks on the menu item.
JmixListMenu.ViewMenuItem	withDescription(String description)	Sets menu item description that should be shown when the user moves cursor on item.
JmixListMenu.ViewMenuItem	withIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Sets icon that should be displayed to the left of the ListMenu.MenuItem.getTitle().
JmixListMenu.ViewMenuItem	withQueryParameters(List<MenuItem.MenuItemParameter> queryParameters)
JmixListMenu.ViewMenuItem	withRouteParameters(List<MenuItem.MenuItemParameter> routeParameters)
JmixListMenu.ViewMenuItem	withShortcutCombination(KeyCombination shortcutCombination)
JmixListMenu.ViewMenuItem	withTitle(String title)	Sets displayed menu item text.

Methods inherited from class io.jmix.flowui.kit.component.main.ListMenu.MenuItem

addClassNames, addPropertyChangeListener, createMenuBar, equals, getClassNames, getClickHandler, getDescription, getIcon, getId, getMenuComponent, getShortcutCombination, getTitle, hashCode, isAttachedToMenu, isMenu, isSeparator, removePropertyChangeListener, setMenuComponent, toString, withClickHandler

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

controllerClass

protected Class<? extends View<?>> controllerClass

queryParameters

protected com.vaadin.flow.router.QueryParameters queryParameters

routeParameters

protected com.vaadin.flow.router.RouteParameters routeParameters

Constructor Details

ViewMenuItem

public ViewMenuItem(String id)

Method Details

create

public static JmixListMenu.ViewMenuItem create(String viewId)

Creates menu item that should navigate to the view with provided ID.

Parameters:

viewId - view ID

Returns:

menu item

create

public static ListMenu.MenuItem create(Class<? extends View<?>> controllerClass)

withTitle

public JmixListMenu.ViewMenuItem withTitle(@Nullable
 String title)

Description copied from class: ListMenu.MenuItem

Sets displayed menu item text.

Overrides:

withTitle in class ListMenu.MenuItem

Parameters:

title - displayed text

Returns:

current menu instance

withDescription

public JmixListMenu.ViewMenuItem withDescription(@Nullable
 String description)

Description copied from class: ListMenu.MenuItem

Sets menu item description that should be shown when the user moves cursor on item.

Overrides:

withDescription in class ListMenu.MenuItem

Parameters:

description - description to set

Returns:

current menu instance

withIcon

public JmixListMenu.ViewMenuItem withIcon(@Nullable
 com.vaadin.flow.component.icon.VaadinIcon icon)

Description copied from class: ListMenu.MenuItem

Sets icon that should be displayed to the left of the ListMenu.MenuItem.getTitle().

Overrides:

withIcon in class ListMenu.MenuItem

Parameters:

icon - icon to set

Returns:

current menu instance

withClassNames

public JmixListMenu.ViewMenuItem withClassNames(List<String> classNames)

Description copied from class: ListMenu.MenuItem

Sets class names that should be added to the menu item.

Overrides:

withClassNames in class ListMenu.MenuItem

Parameters:

classNames - class names to add

Returns:

current menu instance

withShortcutCombination

public JmixListMenu.ViewMenuItem withShortcutCombination(@Nullable
 KeyCombination shortcutCombination)

Overrides:

withShortcutCombination in class ListMenu.MenuItem

getQueryParameters

@Nullable
public com.vaadin.flow.router.QueryParameters getQueryParameters()

withQueryParameters

public JmixListMenu.ViewMenuItem withQueryParameters(List<MenuItem.MenuItemParameter> queryParameters)

getRouteParameters

@Nullable
public com.vaadin.flow.router.RouteParameters getRouteParameters()

withRouteParameters

public JmixListMenu.ViewMenuItem withRouteParameters(List<MenuItem.MenuItemParameter> routeParameters)

getControllerClass

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

Returns:

view class or null if not set

withControllerClass

public JmixListMenu.ViewMenuItem withControllerClass(@Nullable
 Class<? extends View<?>> controllerClass)

Sets view class that should be shown when the user clicks on the menu item. If not set, ListMenu.MenuItem.getId() will be used as view id to navigate.

Parameters:

controllerClass - view class to set

Returns:

current menu instance