Package io.jmix.flowui.kit.component.main

Class ListMenu.MenuBarItem

java.lang.Object

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

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

All Implemented Interfaces:

MenuItem, ParentMenuItem<ListMenu.MenuItem>

Enclosing class:

ListMenu

public static class ListMenu.MenuBarItem
extends ListMenu.MenuItem
implements ParentMenuItem<ListMenu.MenuItem>

Describes menu item that can contain other menu items.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ListMenu.MenuItem>	children
protected boolean	isOpened
protected static final String	MENU_ITEM_OPENED

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, prefixComponent, propertyChangeSupport, shortcutCombination, suffixComponent, title

Constructor Summary

Constructors

Constructor	Description
MenuBarItem(String id)

Method Summary

Modifier and Type	Method	Description
void	addChildItem(ListMenu.MenuItem menuItem)	Adds menu item to the sub menu list.
void	addChildItem(ListMenu.MenuItem menuItem, int index)	Adds menu item to the sub menu list by index.
List<ListMenu.MenuItem>	getChildItems()
List<ListMenu.MenuItem>	getChildren()	Deprecated. use getChildItems()
boolean	hasChildren()
boolean	isMenu()
boolean	isOpened()
void	removeAllChildItems()	Removes all child items.
void	removeChildItem(int index)	Removes menu item from the child items by index.
void	removeChildItem(ListMenu.MenuItem menuItem)	Removes menu item from the child items.
void	setOpened(boolean opened)	Sets whether menu bar item should open sub menu when it's added to the menu.
ListMenu.MenuBarItem	withClassNames(List<String> classNames)	Sets class names that should be added to the menu item.
ListMenu.MenuBarItem	withDescription(String description)	Sets menu item description that should be shown when the user moves cursor on item.
ListMenu.MenuBarItem	withIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Deprecated, for removal: This API element is subject to removal in a future version.
ListMenu.MenuBarItem	withOpened(boolean opened)	Sets whether menu bar item should open sub menu when it's added to the menu.
ListMenu.MenuBarItem	withPrefixComponent(com.vaadin.flow.component.Component prefixComponent)	Sets prefix component of the item.
ListMenu.MenuBarItem	withSuffixComponent(com.vaadin.flow.component.Component suffixComponent)	Sets suffix component of the item.
ListMenu.MenuBarItem	withTitle(String title)	Sets displayed menu item text.

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

addClassNames, addPropertyChangeListener, create, createMenuBar, equals, getClassNames, getClickHandler, getDescription, getIcon, getId, getMenuComponent, getPrefixComponent, getShortcutCombination, getSuffixComponent, getTitle, hashCode, isAttachedToMenu, isSeparator, removePropertyChangeListener, setMenuComponent, setPrefixComponent, setSuffixComponent, toString, withClickHandler, withShortcutCombination

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.kit.component.menu.MenuItem

getTitle

Field Details

MENU_ITEM_OPENED

protected static final String MENU_ITEM_OPENED

See Also:

• Constant Field Values

children

protected List<ListMenu.MenuItem> children

isOpened

protected boolean isOpened

Constructor Details

MenuBarItem

public MenuBarItem(String id)

Method Details

withTitle

public ListMenu.MenuBarItem 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 ListMenu.MenuBarItem 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 ListMenu.MenuBarItem 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 ListMenu.MenuBarItem 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 ListMenu.MenuBarItem 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 ListMenu.MenuBarItem 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

isOpened

public boolean isOpened()

Specified by:

isOpened in interface ParentMenuItem<ListMenu.MenuItem>

Returns:

true if menu bar item initially should open list of sub menu items, false otherwise

setOpened

public void setOpened(boolean opened)

Sets whether menu bar item should open sub menu when it's added to the menu.

Specified by:

setOpened in interface ParentMenuItem<ListMenu.MenuItem>

Parameters:

opened - open option

withOpened

public ListMenu.MenuBarItem withOpened(boolean opened)

Sets whether menu bar item should open sub menu when it's added to the menu.

Parameters:

opened - open option

Returns:

current menu bar item instance

addChildItem

public void addChildItem(ListMenu.MenuItem menuItem)

Adds menu item to the sub menu list.

Specified by:

addChildItem in interface ParentMenuItem<ListMenu.MenuItem>

Parameters:

menuItem - menu item to add

addChildItem

public void addChildItem(ListMenu.MenuItem menuItem,
 int index)

Adds menu item to the sub menu list by index.

If child items already contain provided menu item, it will be moved to the provided index.

Specified by:

addChildItem in interface ParentMenuItem<ListMenu.MenuItem>

Parameters:

menuItem - menu item to add

index - index in children collection to add at

removeChildItem

public void removeChildItem(ListMenu.MenuItem menuItem)

Removes menu item from the child items.

Specified by:

removeChildItem in interface ParentMenuItem<ListMenu.MenuItem>

Parameters:

menuItem - menu item to remove

removeChildItem

public void removeChildItem(int index)

Removes menu item from the child items by index.

Parameters:

index - index to remove

removeAllChildItems

public void removeAllChildItems()

Removes all child items.

Specified by:

removeAllChildItems in interface ParentMenuItem<ListMenu.MenuItem>

getChildren

@Deprecated
public List<ListMenu.MenuItem> getChildren()

Deprecated.

use getChildItems()

Returns:

immutable list of child items

getChildItems

public List<ListMenu.MenuItem> getChildItems()

Specified by:

getChildItems in interface ParentMenuItem<ListMenu.MenuItem>

Returns:

child items of this parent item

hasChildren

public boolean hasChildren()

Returns:

true if menu bar item contains menu items, false otherwise

isMenu

public boolean isMenu()

Overrides:

isMenu in class ListMenu.MenuItem

Returns:

true if menu item is ListMenu.MenuBarItem that contains other items, false otherwise