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

All Implemented Interfaces:

MenuItem

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.RouteParameters	routeParameters
protected com.vaadin.flow.router.QueryParameters	urlQueryParameters

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

classNames, clickHandler, description, id, MENU_ITEM_CLASS_NAME, MENU_ITEM_PREFIX_COMPONENT, MENU_ITEM_SUFFIX_COMPONENT, menuComponent, openedChangeHandler, prefixComponent, propertyChangeSupport, shortcutCombination, suffixComponent, title, visible

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.
boolean	equals(Object obj)
@Nullable Class<? extends View<?>>	getControllerClass()
@Nullable com.vaadin.flow.router.RouteParameters	getRouteParameters()
@Nullable com.vaadin.flow.router.QueryParameters	getUrlQueryParameters()
int	hashCode()
JmixListMenu.ViewMenuItem	withClassNames(List<String> classNames)	Sets class names that should be added to the menu item.
JmixListMenu.ViewMenuItem	withControllerClass(@Nullable Class<? extends View<?>> controllerClass)	Sets view class that should be shown when the user clicks on the menu item.
JmixListMenu.ViewMenuItem	withDescription(@Nullable String description)	Sets menu item description that should be shown when the user moves cursor on item.
JmixListMenu.ViewMenuItem	withPrefixComponent(com.vaadin.flow.component.Component prefixComponent)	Sets prefix component of the item.
JmixListMenu.ViewMenuItem	withRouteParameters(List<MenuItem.MenuItemParameter> routeParameters)
JmixListMenu.ViewMenuItem	withShortcutCombination(@Nullable KeyCombination shortcutCombination)
JmixListMenu.ViewMenuItem	withSuffixComponent(com.vaadin.flow.component.Component suffixComponent)	Sets suffix component of the item.
JmixListMenu.ViewMenuItem	withTitle(@Nullable String title)	Sets displayed menu item text.
JmixListMenu.ViewMenuItem	withUrlQueryParameters(List<MenuItem.MenuItemParameter> queryParameters)
JmixListMenu.ViewMenuItem	withVisible(boolean visible)	Sets whether a menu item should be visible.

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

addClassNames, addPropertyChangeListener, createMenuBar, getClassNames, getClickHandler, getDescription, getId, getMenuComponent, getOpenedChangeHandler, getPrefixComponent, getShortcutCombination, getSuffixComponent, getTitle, isAttachedToMenu, isMenu, isSeparator, isVisible, removePropertyChangeListener, setMenuComponent, setPrefixComponent, setSuffixComponent, setVisible, toString, withClickHandler, withOpenedChangeHandler

Methods inherited from class java.lang.Object

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

Field Details

controllerClass

protected Class<? extends View<?>> controllerClass

urlQueryParameters

protected com.vaadin.flow.router.QueryParameters urlQueryParameters

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

withVisible

public JmixListMenu.ViewMenuItem withVisible(boolean visible)

Description copied from class: ListMenu.MenuItem

Sets whether a menu item should be visible.

Overrides:

withVisible in class ListMenu.MenuItem

Parameters:

visible - true if menu item should be visible, false otherwise

Returns:

current menu item 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

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

withSuffixComponent

public JmixListMenu.ViewMenuItem withSuffixComponent(com.vaadin.flow.component.Component suffixComponent)

Description copied from class: ListMenu.MenuItem

Sets suffix component of the item.

Overrides:

withSuffixComponent in class ListMenu.MenuItem

Parameters:

suffixComponent - component to set

Returns:

current menu item instance

withPrefixComponent

public JmixListMenu.ViewMenuItem withPrefixComponent(com.vaadin.flow.component.Component prefixComponent)

Description copied from class: ListMenu.MenuItem

Sets prefix component of the item.

Overrides:

withPrefixComponent in class ListMenu.MenuItem

Parameters:

prefixComponent - component to set

Returns:

current menu item instance

withShortcutCombination

public JmixListMenu.ViewMenuItem withShortcutCombination(@Nullable KeyCombination shortcutCombination)

Overrides:

withShortcutCombination in class ListMenu.MenuItem

getUrlQueryParameters

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

withUrlQueryParameters

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

getRouteParameters

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

withRouteParameters

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

getControllerClass

public @Nullable 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

equals

public boolean equals(Object obj)

Overrides:

equals in class ListMenu.MenuItem

hashCode

public int hashCode()

Overrides:

hashCode in class ListMenu.MenuItem