Package io.jmix.flowui.component.main

Class JmixListMenu.BeanMenuItem

java.lang.Object

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

io.jmix.flowui.component.main.JmixListMenu.BeanMenuItem

All Implemented Interfaces:

MenuItem

Enclosing class:

JmixListMenu

public static class JmixListMenu.BeanMenuItem
extends ListMenu.MenuItem

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
BeanMenuItem(String id)

Method Summary

Modifier and Type	Method	Description
static JmixListMenu.BeanMenuItem	create(String id)
JmixListMenu.BeanMenuItem	withClassNames(List<String> classNames)	Sets class names that should be added to the menu item.
JmixListMenu.BeanMenuItem	withDescription(String description)	Sets menu item description that should be shown when the user moves cursor on item.
JmixListMenu.BeanMenuItem	withIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Deprecated, for removal: This API element is subject to removal in a future version.
JmixListMenu.BeanMenuItem	withPrefixComponent(com.vaadin.flow.component.Component prefixComponent)	Sets prefix component of the item.
JmixListMenu.BeanMenuItem	withShortcutCombination(KeyCombination shortcutCombination)
JmixListMenu.BeanMenuItem	withSuffixComponent(com.vaadin.flow.component.Component suffixComponent)	Sets suffix component of the item.
JmixListMenu.BeanMenuItem	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, getOpenedChangeHandler, getPrefixComponent, getShortcutCombination, getSuffixComponent, getTitle, hashCode, isAttachedToMenu, isMenu, isSeparator, removePropertyChangeListener, setMenuComponent, setPrefixComponent, setSuffixComponent, toString, withClickHandler, withOpenedChangeHandler

Methods inherited from class java.lang.Object

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

Constructor Details

BeanMenuItem

public BeanMenuItem(String id)

Method Details

create

public static JmixListMenu.BeanMenuItem create(String id)

withTitle

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

@Deprecated(since="2.2",
            forRemoval=true)
public JmixListMenu.BeanMenuItem withIcon(@Nullable
 com.vaadin.flow.component.icon.VaadinIcon icon)

Deprecated, for removal: This API element is subject to removal in a future version.

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.BeanMenuItem 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.BeanMenuItem 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.BeanMenuItem 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.BeanMenuItem withShortcutCombination(@Nullable
 KeyCombination shortcutCombination)

Overrides:

withShortcutCombination in class ListMenu.MenuItem