io.jmix.ui.widget

Class JmixSideMenu

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

io.jmix.ui.widget.JmixSideMenu

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, java.io.Serializable

public class JmixSideMenu
extends com.vaadin.ui.AbstractComponent
implements com.vaadin.ui.Component.Focusable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JmixSideMenu.MenuItem
static class	JmixSideMenu.MenuItemTriggeredEvent

Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Component.HasContextHelp

com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<JmixSideMenu.MenuItem>	badgeUpdates
protected java.util.function.Consumer<JmixSideMenu.MenuItem>	beforeMenuItemTriggeredHandler
protected java.beans.PropertyChangeListener	itemsPropertyChangeListener
protected static java.lang.String	MENU_ITEM_BADGE_TEXT
protected static java.lang.String	MENU_ITEM_CAPTION
protected static java.lang.String	MENU_ITEM_CAPTION_AS_HTML
protected static java.lang.String	MENU_ITEM_CHILDREN
protected static java.lang.String	MENU_ITEM_COMMAND
protected static java.lang.String	MENU_ITEM_DESCRIPTION
protected static java.lang.String	MENU_ITEM_ENABLED
protected static java.lang.String	MENU_ITEM_EXPANDED
protected static java.lang.String	MENU_ITEM_ICON
protected static java.lang.String	MENU_ITEM_ID
protected static java.lang.String	MENU_ITEM_J_TEST_ID
protected static java.lang.String	MENU_ITEM_STYLE_NAME
protected static java.lang.String	MENU_ITEM_VISIBLE
protected java.util.Set<java.lang.String>	menuIconResourceKeys
protected com.vaadin.server.KeyMapper<com.vaadin.server.Resource>	menuIconsKeyMapper
protected com.vaadin.server.KeyMapper<JmixSideMenu.MenuItem>	menuItemIdMapper
protected java.util.List<JmixSideMenu.MenuItem>	menuItems
protected boolean	selectedChanged
protected JmixSideMenu.MenuItem	selectedItem
protected boolean	structureChanged

Fields inherited from class com.vaadin.ui.AbstractComponent

componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
JmixSideMenu()

Method Summary

Modifier and Type	Method and Description
void	addMenuItem(JmixSideMenu.MenuItem menuItem)
void	addMenuItem(JmixSideMenu.MenuItem menuItem, int index)
protected void	addPropertyChangeListenerRecursive(JmixSideMenu.MenuItem menuItem, java.beans.PropertyChangeListener itemsPropertyChangeListener)
void	beforeClientResponse(boolean initial)
void	focus()
java.util.function.Consumer<JmixSideMenu.MenuItem>	getBeforeMenuItemTriggeredHandler()
java.util.List<JmixSideMenu.MenuItem>	getMenuItems()
JmixSideMenu.MenuItem	getSelectedItem()
protected JmixSideMenuState	getState()
protected JmixSideMenuState	getState(boolean markAsDirty)
int	getTabIndex()
boolean	hasMenuItems()
boolean	isSelectOnClick()
boolean	isShowSingleExpandedMenu()
protected void	markMenuStructureAsDirty()
protected void	menuItemPropertyChanged(java.beans.PropertyChangeEvent event)
void	removeMenuItem(int index)
void	removeMenuItem(JmixSideMenu.MenuItem menuItem)
protected void	removePropertyChangeListenerRecursive(JmixSideMenu.MenuItem menuItem, java.beans.PropertyChangeListener itemsPropertyChangeListener)
void	setBeforeMenuItemTriggeredHandler(java.util.function.Consumer<JmixSideMenu.MenuItem> beforeMenuItemTriggeredHandler)
void	setSelectedItem(JmixSideMenu.MenuItem selectedItem)
void	setSelectOnClick(boolean selectOnClick)
void	setShowSingleExpandedMenu(boolean singleExpandedMenu)
void	setTabIndex(int tabIndex)
protected elemental.json.JsonArray	toJson(java.util.List<JmixSideMenu.MenuItem> menuItems)

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, attach, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredError, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getIncorrectConcurrentAccessHandler, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setConnectorResource, setErrorHandler, setIncorrectConcurrentAccessHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setJTestId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Field Detail

MENU_ITEM_ID

protected static final java.lang.String MENU_ITEM_ID

See Also:

Constant Field Values

MENU_ITEM_CAPTION

protected static final java.lang.String MENU_ITEM_CAPTION

See Also:

Constant Field Values

MENU_ITEM_DESCRIPTION

protected static final java.lang.String MENU_ITEM_DESCRIPTION

See Also:

Constant Field Values

MENU_ITEM_STYLE_NAME

protected static final java.lang.String MENU_ITEM_STYLE_NAME

See Also:

Constant Field Values

MENU_ITEM_VISIBLE

protected static final java.lang.String MENU_ITEM_VISIBLE

See Also:

Constant Field Values

MENU_ITEM_ENABLED

protected static final java.lang.String MENU_ITEM_ENABLED

See Also:

Constant Field Values

MENU_ITEM_EXPANDED

protected static final java.lang.String MENU_ITEM_EXPANDED

See Also:

Constant Field Values

MENU_ITEM_CAPTION_AS_HTML

protected static final java.lang.String MENU_ITEM_CAPTION_AS_HTML

See Also:

Constant Field Values

MENU_ITEM_J_TEST_ID

protected static final java.lang.String MENU_ITEM_J_TEST_ID

See Also:

Constant Field Values

MENU_ITEM_ICON

protected static final java.lang.String MENU_ITEM_ICON

See Also:

Constant Field Values

MENU_ITEM_BADGE_TEXT

protected static final java.lang.String MENU_ITEM_BADGE_TEXT

See Also:

Constant Field Values

MENU_ITEM_CHILDREN

protected static final java.lang.String MENU_ITEM_CHILDREN

See Also:

Constant Field Values

MENU_ITEM_COMMAND

protected static final java.lang.String MENU_ITEM_COMMAND

See Also:

Constant Field Values

menuItems

protected java.util.List<JmixSideMenu.MenuItem> menuItems

selectedItem

protected JmixSideMenu.MenuItem selectedItem

structureChanged

protected boolean structureChanged

selectedChanged

protected boolean selectedChanged

menuItemIdMapper

protected com.vaadin.server.KeyMapper<JmixSideMenu.MenuItem> menuItemIdMapper

menuIconsKeyMapper

protected com.vaadin.server.KeyMapper<com.vaadin.server.Resource> menuIconsKeyMapper

menuIconResourceKeys

protected java.util.Set<java.lang.String> menuIconResourceKeys

badgeUpdates

protected java.util.List<JmixSideMenu.MenuItem> badgeUpdates

itemsPropertyChangeListener

protected java.beans.PropertyChangeListener itemsPropertyChangeListener

beforeMenuItemTriggeredHandler

protected java.util.function.Consumer<JmixSideMenu.MenuItem> beforeMenuItemTriggeredHandler

Constructor Detail

JmixSideMenu

public JmixSideMenu()

Method Detail

getBeforeMenuItemTriggeredHandler

public java.util.function.Consumer<JmixSideMenu.MenuItem> getBeforeMenuItemTriggeredHandler()

setBeforeMenuItemTriggeredHandler

public void setBeforeMenuItemTriggeredHandler(java.util.function.Consumer<JmixSideMenu.MenuItem> beforeMenuItemTriggeredHandler)

getState

protected JmixSideMenuState getState()

Overrides:

getState in class com.vaadin.ui.AbstractComponent

getState

protected JmixSideMenuState getState(boolean markAsDirty)

Overrides:

getState in class com.vaadin.ui.AbstractComponent

beforeClientResponse

public void beforeClientResponse(boolean initial)

Specified by:

beforeClientResponse in interface com.vaadin.server.ClientConnector

Overrides:

beforeClientResponse in class com.vaadin.ui.AbstractComponent

focus

public void focus()

Specified by:

focus in interface com.vaadin.ui.Component.Focusable

Overrides:

focus in class com.vaadin.ui.AbstractComponent

getTabIndex

public int getTabIndex()

Specified by:

getTabIndex in interface com.vaadin.ui.Component.Focusable

setTabIndex

public void setTabIndex(int tabIndex)

Specified by:

setTabIndex in interface com.vaadin.ui.Component.Focusable

isSelectOnClick

public boolean isSelectOnClick()

setSelectOnClick

public void setSelectOnClick(boolean selectOnClick)

setShowSingleExpandedMenu

public void setShowSingleExpandedMenu(boolean singleExpandedMenu)

isShowSingleExpandedMenu

public boolean isShowSingleExpandedMenu()

getSelectedItem

@Nullable
public JmixSideMenu.MenuItem getSelectedItem()

setSelectedItem

public void setSelectedItem(@Nullable
                            JmixSideMenu.MenuItem selectedItem)

addMenuItem

public void addMenuItem(JmixSideMenu.MenuItem menuItem)

addMenuItem

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

removeMenuItem

public void removeMenuItem(JmixSideMenu.MenuItem menuItem)

removeMenuItem

public void removeMenuItem(int index)

getMenuItems

public java.util.List<JmixSideMenu.MenuItem> getMenuItems()

hasMenuItems

public boolean hasMenuItems()

toJson

protected elemental.json.JsonArray toJson(java.util.List<JmixSideMenu.MenuItem> menuItems)

menuItemPropertyChanged

protected void menuItemPropertyChanged(java.beans.PropertyChangeEvent event)

markMenuStructureAsDirty

protected void markMenuStructureAsDirty()

addPropertyChangeListenerRecursive

protected void addPropertyChangeListenerRecursive(JmixSideMenu.MenuItem menuItem,
                                                  java.beans.PropertyChangeListener itemsPropertyChangeListener)

removePropertyChangeListenerRecursive

protected void removePropertyChangeListenerRecursive(JmixSideMenu.MenuItem menuItem,
                                                     java.beans.PropertyChangeListener itemsPropertyChangeListener)