com.haulmont.cuba.web.gui.components.mainwindow

Class WebAppMenu

java.lang.Object

com.haulmont.bali.events.EventRouter

com.haulmont.cuba.web.gui.components.WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaMenuBar>

com.haulmont.cuba.web.gui.components.mainwindow.WebAppMenu

All Implemented Interfaces:

Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, AppMenu

public class WebAppMenu
extends WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaMenuBar>
implements AppMenu

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.mainwindow.AppMenu

AppMenu.MenuItem

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MENU_STYLENAME

Fields inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

ICON_STYLE, UNIT_SYMBOLS

Fields inherited from interface com.haulmont.cuba.gui.components.mainwindow.AppMenu

NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
WebAppMenu()

Method Summary

Modifier and Type	Method and Description
void	addMenuItem(AppMenu.MenuItem menuItem) Add menu item to the end of root items list.
void	addMenuItem(AppMenu.MenuItem menuItem, int index) Add menu item to specified position in the root items list.
AppMenu.MenuItem	createMenuItem(java.lang.String id) Create new menu item.
AppMenu.MenuItem	createMenuItem(java.lang.String id, java.lang.String caption) Create new menu item.
AppMenu.MenuItem	createMenuItem(java.lang.String id, java.lang.String caption, java.lang.String icon, java.util.function.Consumer<AppMenu.MenuItem> command) Create new menu item.
AppMenu.MenuItem	createSeparator() Creates menu separator
AppMenu.MenuItem	getMenuItem(java.lang.String id)
AppMenu.MenuItem	getMenuItemNN(java.lang.String id)
java.util.List<AppMenu.MenuItem>	getMenuItems()
java.lang.String	getStyleName() Styles implementation is client-type-specific.
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
boolean	hasMenuItems()
void	loadMenu() Load menu structure from MenuConfig
void	removeMenuItem(AppMenu.MenuItem menuItem) Remove menu item from the root items list.
void	removeMenuItem(int index) Remove menu item from the root items list by index.
void	setMenuItemShortcutCaption(AppMenu.MenuItem menuItem, java.lang.String shortcut) Sets caption to MenuItem with value of shortcut key combination.
void	setStyleName(java.lang.String name) Sets one or more style names of the component, replacing any previous styles.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.

Methods inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getComponentEnabledFlag, getComponentVisibleFlag, getComposition, getDebugId, getDescription, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getWidth, getWidthUnits, getXmlDescriptor, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setDebugId, setDescription, setEnabled, setFrame, setHeight, setIcon, setId, setParent, setResponsive, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class com.haulmont.bali.events.EventRouter

addListener, addListener, fireEvent, hasListeners, removeListener, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

isFocusable, setFocusable

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Field Detail

MENU_STYLENAME

public static final java.lang.String MENU_STYLENAME

See Also:

Constant Field Values

Constructor Detail

WebAppMenu

public WebAppMenu()

Method Detail

setStyleName

public void setStyleName(java.lang.String name)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Overrides:

setStyleName in class WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaMenuBar>

Parameters:

name - one or more style names separated by space.

getStyleName

public java.lang.String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Overrides:

getStyleName in class WebAbstractComponent<com.haulmont.cuba.web.toolkit.ui.CubaMenuBar>

Returns:

current style name.

loadMenu

public void loadMenu()

Description copied from interface: AppMenu

Load menu structure from MenuConfig

Specified by:

loadMenu in interface AppMenu

createMenuItem

public AppMenu.MenuItem createMenuItem(java.lang.String id)

Description copied from interface: AppMenu

Create new menu item. Does not add item to menu. Id must be unique for whole menu.

Specified by:

createMenuItem in interface AppMenu

Parameters:

id - item id

Returns:

menu item instance

createMenuItem

public AppMenu.MenuItem createMenuItem(java.lang.String id,
                                       java.lang.String caption)

Description copied from interface: AppMenu

Create new menu item. Does not add item to menu. Id must be unique for whole menu.

Specified by:

createMenuItem in interface AppMenu

Parameters:

id - item id

caption - item caption

Returns:

menu item instance

createMenuItem

public AppMenu.MenuItem createMenuItem(java.lang.String id,
                                       java.lang.String caption,
                                       @Nullable
                                       java.lang.String icon,
                                       @Nullable
                                       java.util.function.Consumer<AppMenu.MenuItem> command)

Description copied from interface: AppMenu

Create new menu item. Does not add item to menu. Id must be unique for whole menu.

Specified by:

createMenuItem in interface AppMenu

Parameters:

id - item id

caption - item caption

icon - icon

command - command

Returns:

menu item instance

addMenuItem

public void addMenuItem(AppMenu.MenuItem menuItem)

Description copied from interface: AppMenu

Add menu item to the end of root items list.

Specified by:

addMenuItem in interface AppMenu

Parameters:

menuItem - menu item

addMenuItem

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

Description copied from interface: AppMenu

Add menu item to specified position in the root items list.

Specified by:

addMenuItem in interface AppMenu

Parameters:

menuItem - menu item

index - target index

removeMenuItem

public void removeMenuItem(AppMenu.MenuItem menuItem)

Description copied from interface: AppMenu

Remove menu item from the root items list.

Specified by:

removeMenuItem in interface AppMenu

Parameters:

menuItem - menu item

removeMenuItem

public void removeMenuItem(int index)

Description copied from interface: AppMenu

Remove menu item from the root items list by index.

Specified by:

removeMenuItem in interface AppMenu

Parameters:

index - index

getMenuItem

@Nullable
public AppMenu.MenuItem getMenuItem(java.lang.String id)

Specified by:

getMenuItem in interface AppMenu

Parameters:

id - item id

Returns:

item from the menu tree by its id

getMenuItemNN

public AppMenu.MenuItem getMenuItemNN(java.lang.String id)

Specified by:

getMenuItemNN in interface AppMenu

Parameters:

id - item id

Returns:

item from the menu tree by its id

getMenuItems

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

Specified by:

getMenuItems in interface AppMenu

Returns:

root menu items

hasMenuItems

public boolean hasMenuItems()

Specified by:

hasMenuItems in interface AppMenu

Returns:

true if the menu has items

createSeparator

public AppMenu.MenuItem createSeparator()

Description copied from interface: AppMenu

Creates menu separator

Specified by:

createSeparator in interface AppMenu

setMenuItemShortcutCaption

public void setMenuItemShortcutCaption(AppMenu.MenuItem menuItem,
                                       java.lang.String shortcut)

Description copied from interface: AppMenu

Sets caption to MenuItem with value of shortcut key combination.

Specified by:

setMenuItemShortcutCaption in interface AppMenu

Parameters:

menuItem - MenuItem instance

shortcut - shortcut key combination string representation

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index