Package io.jmix.flowui.component.main

Class JmixListMenu.ScreenMenuItem

java.lang.Object

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

io.jmix.flowui.component.main.JmixListMenu.ScreenMenuItem

Enclosing class:

JmixListMenu

public static class JmixListMenu.ScreenMenuItem
extends ListMenu.MenuItem

Describes menu item that should navigate to the screen.

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<? extends Screen<?>>	controllerClass

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

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

Constructor Summary

Constructors

Constructor	Description
ScreenMenuItem(String id)

Method Summary

Modifier and Type	Method	Description
static ListMenu.MenuItem	create(Class<? extends Screen<?>> controllerClass)
static JmixListMenu.ScreenMenuItem	create(String screenId)	Creates menu item that should navigate to the screen with provided ID.
Class<? extends Screen<?>>	getControllerClass()
JmixListMenu.ScreenMenuItem	withClassNames(List<String> classNames)	Sets class names that should be added to the menu item.
JmixListMenu.ScreenMenuItem	withControllerClass(Class<? extends Screen<?>> controllerClass)	Sets screen class that should be shown when the user clicks on the menu item.
JmixListMenu.ScreenMenuItem	withDescription(String description)	Sets menu item description that should be shown when the user moves cursor on item.
JmixListMenu.ScreenMenuItem	withIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Sets icon that should be displayed to the left of the ListMenu.MenuItem.getTitle().
JmixListMenu.ScreenMenuItem	withTitle(String title)	Sets displayed menu item text.

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

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

Methods inherited from class java.lang.Object

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

Field Details

controllerClass

protected Class<? extends Screen<?>> controllerClass

Constructor Details

ScreenMenuItem

public ScreenMenuItem(String id)

Method Details

create

public static JmixListMenu.ScreenMenuItem create(String screenId)

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

Parameters:

screenId - screen ID

Returns:

menu item

create

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

withTitle

public JmixListMenu.ScreenMenuItem 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.ScreenMenuItem 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.ScreenMenuItem 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.ScreenMenuItem 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

getControllerClass

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

Returns:

screen class or null if not set

withControllerClass

public JmixListMenu.ScreenMenuItem withControllerClass(@Nullable
 Class<? extends Screen<?>> controllerClass)

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

Parameters:

controllerClass - screen class to set

Returns:

current menu instance