io.jmix.ui.component.mainwindow.impl

Class SideMenuImpl.MenuItemImpl

java.lang.Object

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

All Implemented Interfaces:

SideMenu.MenuItem

Enclosing class:

SideMenuImpl

protected static class SideMenuImpl.MenuItemImpl
extends java.lang.Object
implements SideMenu.MenuItem

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<SideMenu.MenuItem>	command
protected JmixSideMenu.MenuItem	delegateItem
protected java.lang.String	icon
protected java.lang.String	id
protected SideMenuImpl	menu

Constructor Summary

Constructors

Constructor and Description
MenuItemImpl(SideMenuImpl menu, java.lang.String id, JmixSideMenu.MenuItem delegateItem)

Method Summary

Modifier and Type	Method and Description
void	addChildItem(SideMenu.MenuItem menuItem) Add menu item to the end of children list.
void	addChildItem(SideMenu.MenuItem menuItem, int index) Add menu item to specified position in the children list.
void	addStyleName(java.lang.String styleName) Adds one or more style names to this component.
java.lang.String	getBadgeText()
java.lang.String	getCaption()
java.util.List<SideMenu.MenuItem>	getChildren()
java.util.function.Consumer<SideMenu.MenuItem>	getCommand()
JmixSideMenu.MenuItem	getDelegateItem()
java.lang.String	getDescription()
java.lang.String	getIcon()
java.lang.String	getId()
protected java.lang.String	getJTestId()
SideMenu	getMenu()
SideMenu.MenuItem	getParent()
SideMenu.MenuItem	getParentNN()
java.lang.String	getStyleName()
boolean	hasChildren()
boolean	isCaptionAsHtml()
boolean	isExpanded()
boolean	isVisible()
protected void	menuSelected(JmixSideMenu.MenuItemTriggeredEvent event)
void	removeAllChildItems() Remove all child items from the children list.
void	removeChildItem(int index) Remove menu item from the children list by index.
void	removeChildItem(SideMenu.MenuItem menuItem) Remove menu item from the children list.
void	removeStyleName(java.lang.String styleName) Removes one or more style names from component.
void	setBadgeText(java.lang.String badgeText) Set badge text for item.
void	setCaption(java.lang.String caption) Set item caption.
void	setCaptionAsHtml(boolean captionAsHtml) Enable or disable HTML mode for caption.
void	setCommand(java.util.function.Consumer<SideMenu.MenuItem> command) Set item command
void	setDescription(java.lang.String description) Set description.
void	setExpanded(boolean expanded) Expand or collapse sub menu with children by default.
void	setIcon(java.lang.String icon) Set icon.
protected void	setJTestId(java.lang.String jTestId)
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 SideMenuImpl menu

id

protected java.lang.String id

delegateItem

protected JmixSideMenu.MenuItem delegateItem

command

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

icon

protected java.lang.String icon

Constructor Detail

MenuItemImpl

public MenuItemImpl(SideMenuImpl menu,
                    java.lang.String id,
                    JmixSideMenu.MenuItem delegateItem)

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface SideMenu.MenuItem

Returns:

id

getMenu

public SideMenu getMenu()

Specified by:

getMenu in interface SideMenu.MenuItem

Returns:

owner

getDelegateItem

public JmixSideMenu.MenuItem getDelegateItem()

getCaption

@Nullable
public java.lang.String getCaption()

Specified by:

getCaption in interface SideMenu.MenuItem

Returns:

caption

setCaption

public void setCaption(@Nullable
                       java.lang.String caption)

Description copied from interface: SideMenu.MenuItem

Set item caption.

Specified by:

setCaption in interface SideMenu.MenuItem

Parameters:

caption - caption

getDescription

@Nullable
public java.lang.String getDescription()

Specified by:

getDescription in interface SideMenu.MenuItem

Returns:

description

setDescription

public void setDescription(@Nullable
                           java.lang.String description)

Description copied from interface: SideMenu.MenuItem

Set description.

Specified by:

setDescription in interface SideMenu.MenuItem

Parameters:

description - description

getIcon

@Nullable
public java.lang.String getIcon()

Specified by:

getIcon in interface SideMenu.MenuItem

Returns:

icon name

setIcon

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

Description copied from interface: SideMenu.MenuItem

Set icon.

Specified by:

setIcon in interface SideMenu.MenuItem

Parameters:

icon - icon name

isCaptionAsHtml

public boolean isCaptionAsHtml()

Specified by:

isCaptionAsHtml in interface SideMenu.MenuItem

Returns:

true if caption is inserted to DOM as HTML

setCaptionAsHtml

public void setCaptionAsHtml(boolean captionAsHtml)

Description copied from interface: SideMenu.MenuItem

Enable or disable HTML mode for caption.

Specified by:

setCaptionAsHtml in interface SideMenu.MenuItem

Parameters:

captionAsHtml - pass true to enable HTML mode for caption.

isVisible

public boolean isVisible()

Specified by:

isVisible in interface SideMenu.MenuItem

Returns:

true if item will be sent to the client side

setVisible

public void setVisible(boolean visible)

Description copied from interface: SideMenu.MenuItem

Show or hide item.

Specified by:

setVisible in interface SideMenu.MenuItem

Parameters:

visible - pass false to hide menu item

isExpanded

public boolean isExpanded()

Specified by:

isExpanded in interface SideMenu.MenuItem

Returns:

true if sub menu with children will be initially expanded

setExpanded

public void setExpanded(boolean expanded)

Description copied from interface: SideMenu.MenuItem

Expand or collapse sub menu with children by default.

Specified by:

setExpanded in interface SideMenu.MenuItem

Parameters:

expanded - pass true to set sub menu expanded by default.

getStyleName

public java.lang.String getStyleName()

Specified by:

getStyleName in interface SideMenu.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(@Nullable
                         java.lang.String styleName)

Description copied from interface: SideMenu.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 SideMenu.MenuItem

Parameters:

styleName - style name string

addStyleName

public void addStyleName(java.lang.String styleName)

Description copied from interface: SideMenu.MenuItem

Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names. The style name will be rendered as a HTML class name, which can be used in a CSS definition.

Specified by:

addStyleName in interface SideMenu.MenuItem

Parameters:

styleName - style name string

removeStyleName

public void removeStyleName(java.lang.String styleName)

Description copied from interface: SideMenu.MenuItem

Removes one or more style names from component. Multiple styles can be specified as a space-separated list of style names.

Specified by:

removeStyleName in interface SideMenu.MenuItem

Parameters:

styleName - style name string

getBadgeText

@Nullable
public java.lang.String getBadgeText()

Specified by:

getBadgeText in interface SideMenu.MenuItem

Returns:

badge text

setBadgeText

public void setBadgeText(@Nullable
                         java.lang.String badgeText)

Description copied from interface: SideMenu.MenuItem

Set badge text for item. Badges are shown as small widget on the right side of menu items.

Specified by:

setBadgeText in interface SideMenu.MenuItem

Parameters:

badgeText - badge text

getJTestId

protected java.lang.String getJTestId()

setJTestId

protected void setJTestId(java.lang.String jTestId)

getCommand

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

Specified by:

getCommand in interface SideMenu.MenuItem

Returns:

item command

setCommand

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

Description copied from interface: SideMenu.MenuItem

Set item command

Specified by:

setCommand in interface SideMenu.MenuItem

Parameters:

command - item command

addChildItem

public void addChildItem(SideMenu.MenuItem menuItem)

Description copied from interface: SideMenu.MenuItem

Add menu item to the end of children list.

Specified by:

addChildItem in interface SideMenu.MenuItem

Parameters:

menuItem - menu item

addChildItem

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

Description copied from interface: SideMenu.MenuItem

Add menu item to specified position in the children list.

Specified by:

addChildItem in interface SideMenu.MenuItem

Parameters:

menuItem - menu item

index - target index

removeChildItem

public void removeChildItem(SideMenu.MenuItem menuItem)

Description copied from interface: SideMenu.MenuItem

Remove menu item from the children list.

Specified by:

removeChildItem in interface SideMenu.MenuItem

Parameters:

menuItem - menu item

removeAllChildItems

public void removeAllChildItems()

Description copied from interface: SideMenu.MenuItem

Remove all child items from the children list.

Specified by:

removeAllChildItems in interface SideMenu.MenuItem

removeChildItem

public void removeChildItem(int index)

Description copied from interface: SideMenu.MenuItem

Remove menu item from the children list by index.

Specified by:

removeChildItem in interface SideMenu.MenuItem

Parameters:

index - index

getChildren

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

Specified by:

getChildren in interface SideMenu.MenuItem

Returns:

child items

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface SideMenu.MenuItem

Returns:

true if the menu item has child items

getParent

@Nullable
public SideMenu.MenuItem getParent()

Specified by:

getParent in interface SideMenu.MenuItem

Returns:

parent menu item if it's nested item, null otherwise

getParentNN

public SideMenu.MenuItem getParentNN()

Specified by:

getParentNN in interface SideMenu.MenuItem

Returns:

parent menu item if it's nested item, null otherwise

menuSelected

protected void menuSelected(JmixSideMenu.MenuItemTriggeredEvent event)