io.jmix.ui.component.mainwindow.impl

Class AppMenuImpl.MenuItemImpl

java.lang.Object

io.jmix.ui.component.mainwindow.impl.AppMenuImpl.MenuItemImpl

All Implemented Interfaces:

AppMenu.MenuItem

Enclosing class:

AppMenuImpl

protected class AppMenuImpl.MenuItemImpl
extends java.lang.Object
implements AppMenu.MenuItem

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<AppMenu.MenuItem>	command
protected com.vaadin.ui.MenuBar.MenuItem	delegateItem
protected java.lang.String	icon
protected java.lang.String	id
protected AppMenuImpl	menu
protected boolean	separator

Constructor Summary

Constructors

Constructor and Description
MenuItemImpl(AppMenuImpl menu, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	addChildItem(AppMenu.MenuItem menuItem) Add menu item to the end of children list.
void	addChildItem(AppMenu.MenuItem menuItem, int index) Add menu item to specified position in the children list.
java.lang.String	getCaption()
java.util.List<AppMenu.MenuItem>	getChildren()
java.util.function.Consumer<AppMenu.MenuItem>	getCommand()
com.vaadin.ui.MenuBar.MenuItem	getDelegateItem()
java.lang.String	getDescription()
java.lang.String	getIcon()
java.lang.String	getId()
AppMenu	getMenu()
java.lang.String	getStyleName()
boolean	hasChildren()
boolean	isSeparator()
boolean	isVisible()
protected void	menuSelected(com.vaadin.ui.MenuBar.MenuItem event)
void	removeChildItem(AppMenu.MenuItem menuItem) Remove menu item from the children list.
void	removeChildItem(int index) Remove menu item from the children list by index.
void	setCaption(java.lang.String caption) Set item caption.
void	setCommand(java.util.function.Consumer<AppMenu.MenuItem> command) Set item command
void	setDelegateItem(com.vaadin.ui.MenuBar.MenuItem delegateItem)
void	setDescription(java.lang.String description) Set description.
void	setIcon(java.lang.String icon) Set icon.
protected void	setSeparator(boolean separator)
void	setStyleName(java.lang.String styleName) Sets one or more user-defined style names of the component, replacing any previous user-defined styles.
void	setVisible(boolean visible) Show or hide item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

menu

protected AppMenuImpl menu

id

protected java.lang.String id

delegateItem

protected com.vaadin.ui.MenuBar.MenuItem delegateItem

command

protected java.util.function.Consumer<AppMenu.MenuItem> command

icon

protected java.lang.String icon

separator

protected boolean separator

Constructor Detail

MenuItemImpl

public MenuItemImpl(AppMenuImpl menu,
                    @Nullable
                    java.lang.String id)

Method Detail

getId

@Nullable
public java.lang.String getId()

Specified by:

getId in interface AppMenu.MenuItem

Returns:

id

getMenu

public AppMenu getMenu()

Specified by:

getMenu in interface AppMenu.MenuItem

Returns:

owner

getDelegateItem

public com.vaadin.ui.MenuBar.MenuItem getDelegateItem()

setDelegateItem

public void setDelegateItem(com.vaadin.ui.MenuBar.MenuItem delegateItem)

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface AppMenu.MenuItem

Returns:

caption

setCaption

public void setCaption(java.lang.String caption)

Description copied from interface: AppMenu.MenuItem

Set item caption.

Specified by:

setCaption in interface AppMenu.MenuItem

Parameters:

caption - caption

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface AppMenu.MenuItem

Returns:

description

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: AppMenu.MenuItem

Set description.

Specified by:

setDescription in interface AppMenu.MenuItem

Parameters:

description - description

getIcon

@Nullable
public java.lang.String getIcon()

Specified by:

getIcon in interface AppMenu.MenuItem

Returns:

icon name

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

Description copied from interface: AppMenu.MenuItem

Set icon.

Specified by:

setIcon in interface AppMenu.MenuItem

Parameters:

icon - icon name

isVisible

public boolean isVisible()

Specified by:

isVisible in interface AppMenu.MenuItem

Returns:

true if item will be sent to the client side

setVisible

public void setVisible(boolean visible)

Description copied from interface: AppMenu.MenuItem

Show or hide item.

Specified by:

setVisible in interface AppMenu.MenuItem

Parameters:

visible - pass false to hide menu item

getStyleName

public java.lang.String getStyleName()

Specified by:

getStyleName in interface AppMenu.MenuItem

Returns:

all user-defined CSS style names of a component. If the item has multiple style names defined, the return string is a space-separated list of style names.

setStyleName

public void setStyleName(java.lang.String styleName)

Description copied from interface: AppMenu.MenuItem

Sets one or more user-defined style names of the component, replacing any previous user-defined styles. Multiple styles can be specified as a space-separated list of style names. The style names must be valid CSS class names.

Specified by:

setStyleName in interface AppMenu.MenuItem

Parameters:

styleName - style name string

getCommand

@Nullable
public java.util.function.Consumer<AppMenu.MenuItem> getCommand()

Specified by:

getCommand in interface AppMenu.MenuItem

Returns:

item command

setCommand

public void setCommand(@Nullable
                       java.util.function.Consumer<AppMenu.MenuItem> command)

Description copied from interface: AppMenu.MenuItem

Set item command

Specified by:

setCommand in interface AppMenu.MenuItem

Parameters:

command - item command

addChildItem

public void addChildItem(AppMenu.MenuItem menuItem)

Description copied from interface: AppMenu.MenuItem

Add menu item to the end of children list.

Specified by:

addChildItem in interface AppMenu.MenuItem

Parameters:

menuItem - menu item

addChildItem

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

Description copied from interface: AppMenu.MenuItem

Add menu item to specified position in the children list.

Specified by:

addChildItem in interface AppMenu.MenuItem

Parameters:

menuItem - menu item

index - target index

removeChildItem

public void removeChildItem(AppMenu.MenuItem menuItem)

Description copied from interface: AppMenu.MenuItem

Remove menu item from the children list.

Specified by:

removeChildItem in interface AppMenu.MenuItem

Parameters:

menuItem - menu item

removeChildItem

public void removeChildItem(int index)

Description copied from interface: AppMenu.MenuItem

Remove menu item from the children list by index.

Specified by:

removeChildItem in interface AppMenu.MenuItem

Parameters:

index - index

getChildren

public java.util.List<AppMenu.MenuItem> getChildren()

Specified by:

getChildren in interface AppMenu.MenuItem

Returns:

child items

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface AppMenu.MenuItem

Returns:

true if the menu item has child items

isSeparator

public boolean isSeparator()

Specified by:

isSeparator in interface AppMenu.MenuItem

Returns:

true if item is separator

setSeparator

protected void setSeparator(boolean separator)

menuSelected

protected void menuSelected(com.vaadin.ui.MenuBar.MenuItem event)