Package io.jmix.ui.widget

Class JmixSideMenu.MenuItem

java.lang.Object

io.jmix.ui.widget.JmixSideMenu.MenuItem

Direct Known Subclasses:

SideMenuImpl.MenuItemWrapper

Enclosing class:

JmixSideMenu

public static class JmixSideMenu.MenuItem
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected String	badgeText
protected String	caption
protected boolean	captionAsHtml
protected List<JmixSideMenu.MenuItem>	children
protected Consumer<JmixSideMenu.MenuItemTriggeredEvent>	command
protected String	description
protected boolean	expanded
protected com.vaadin.server.Resource	icon
protected String	jTestId
protected JmixSideMenu.MenuItem	parent
protected PropertyChangeSupport	propertyChangeSupport
protected List<String>	styles
protected boolean	visible

Constructor Summary

Constructors

Constructor	Description
MenuItem()
MenuItem(String caption)
MenuItem(String caption, com.vaadin.server.Resource icon)
MenuItem(String caption, com.vaadin.server.Resource icon, Consumer<JmixSideMenu.MenuItemTriggeredEvent> command)

Method Summary

Modifier and Type	Method	Description
void	addChildItem(JmixSideMenu.MenuItem menuItem)
void	addChildItem(JmixSideMenu.MenuItem menuItem, int index)
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addStyleName(String style)
String	getBadgeText()
String	getCaption()
List<JmixSideMenu.MenuItem>	getChildren()
Consumer<JmixSideMenu.MenuItemTriggeredEvent>	getCommand()
String	getDescription()
com.vaadin.server.Resource	getIcon()
String	getJTestId()
JmixSideMenu.MenuItem	getParent()
String	getStyleName()
boolean	hasChildren()
boolean	isCaptionAsHtml()
boolean	isExpanded()
boolean	isVisible()
void	removeChildItem(int index)
void	removeChildItem(JmixSideMenu.MenuItem menuItem)
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removeStyleName(String style)
void	setBadgeText(String badgeText)
void	setCaption(String caption)
void	setCaptionAsHtml(boolean captionAsHtml)
void	setCommand(Consumer<JmixSideMenu.MenuItemTriggeredEvent> command)
void	setDescription(String description)
void	setExpanded(boolean expanded)
void	setIcon(com.vaadin.server.Resource icon)
void	setJTestId(String jTestId)
void	setParent(JmixSideMenu.MenuItem parent)
void	setStyleName(String style)
void	setVisible(boolean visible)

Methods inherited from class java.lang.Object

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

Field Details

caption

protected String caption

description

protected String description

icon

protected com.vaadin.server.Resource icon

captionAsHtml

protected boolean captionAsHtml

visible

protected boolean visible

expanded

protected boolean expanded

badgeText

protected String badgeText

jTestId

protected String jTestId

styles

protected List<String> styles

command

protected Consumer<JmixSideMenu.MenuItemTriggeredEvent> command

children

protected List<JmixSideMenu.MenuItem> children

parent

protected JmixSideMenu.MenuItem parent

propertyChangeSupport

protected PropertyChangeSupport propertyChangeSupport

Constructor Details

MenuItem

public MenuItem()

MenuItem

public MenuItem(String caption)

MenuItem

public MenuItem(String caption,
 com.vaadin.server.Resource icon)

MenuItem

public MenuItem(String caption,
 @Nullable
 com.vaadin.server.Resource icon,
 @Nullable
 Consumer<JmixSideMenu.MenuItemTriggeredEvent> command)

Method Details

getCaption

@Nullable
public String getCaption()

setCaption

public void setCaption(@Nullable
 String caption)

getDescription

@Nullable
public String getDescription()

setDescription

public void setDescription(@Nullable
 String description)

getIcon

@Nullable
public com.vaadin.server.Resource getIcon()

setIcon

public void setIcon(@Nullable
 com.vaadin.server.Resource icon)

isCaptionAsHtml

public boolean isCaptionAsHtml()

setCaptionAsHtml

public void setCaptionAsHtml(boolean captionAsHtml)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isExpanded

public boolean isExpanded()

setExpanded

public void setExpanded(boolean expanded)

getStyleName

public String getStyleName()

setStyleName

public void setStyleName(@Nullable
 String style)

getJTestId

@Nullable
public String getJTestId()

setJTestId

public void setJTestId(String jTestId)

getBadgeText

@Nullable
public String getBadgeText()

setBadgeText

public void setBadgeText(@Nullable
 String badgeText)

getCommand

@Nullable
public Consumer<JmixSideMenu.MenuItemTriggeredEvent> getCommand()

setCommand

public void setCommand(@Nullable
 Consumer<JmixSideMenu.MenuItemTriggeredEvent> command)

addChildItem

public void addChildItem(JmixSideMenu.MenuItem menuItem)

addChildItem

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

removeChildItem

public void removeChildItem(JmixSideMenu.MenuItem menuItem)

removeChildItem

public void removeChildItem(int index)

getChildren

public List<JmixSideMenu.MenuItem> getChildren()

hasChildren

public boolean hasChildren()

getParent

@Nullable
public JmixSideMenu.MenuItem getParent()

setParent

public void setParent(@Nullable
 JmixSideMenu.MenuItem parent)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

removeStyleName

public void removeStyleName(String style)

addStyleName

public void addStyleName(String style)