MenuConfig

id - a unique identifier of the element.

caption - a caption of the menu element. If not set, the caption will be determined by the rule explained below.

description - a text shown as a tooltip on mouse hover. You can use localized messages from the message bundle.

icon - an icon of the menu element. See Icons for details.

insertBefore, insertAfter - determine whether the item should be inserted before or after a particular element or a menu item with the specified identifier. These attributes are used to insert an item to the appropriate place in the menu defined in the files of add-ons. Do not use the insertBefore and insertAfter attributes at the same time.

stylename - defines a style name for the menu item. See Themes for details.

expanded - determines whether the menu element should be expanded when opening the main screen. The default value is false.

id - a unique identifier of the element. If no screen, bean, class attributes are defined, the id is used to point to a screen with the same id. When the user clicks on the menu item, the corresponding screen will be opened on the main screen.

<item id="User.browse"/>

caption - a caption of the item element. If not set, the caption will be determined by the rule explained below.

<item screen="sample_CustomerScreen"
      caption="msg://ui.ex2.screen.customer/customerScreen.caption"/>

description - a text which is shown as a tooltip on mouse hover. You can also use localized messages from the message bundle.

screen - a screen identifier. It can be used to include one screen into the menu multiple times. When the user clicks on the menu item, the corresponding screen will be opened on the main screen.

<item screen="sample_City.browse" id="cities"/>
<item screen="sample_City.browse" id="cities2"/>

bean - a bean name. Must be used together with beanMethod. When the user clicks on the menu item, the method of the bean is invoked.

<item bean="sample_MenuBean"
      beanMethod="showCityBrowse"
      caption="Show Cities"/>

@Component("sample_MenuBean")
public class MenuBean {
    @Autowired
    private ScreenBuilders screenBuilders;

    public void showCityBrowse(){
        final Screen frameOwner = AppUI.getCurrent()
                .getTopLevelWindowNN().getFrameOwner();
        screenBuilders.screen(frameOwner)
                .withScreenClass(CityBrowse.class)
                .build()
                .show();
    }
}

<item bean="sample_MenuBean" beanMethod="openLink"
      id="openBeanWithParams" caption="OpenBeanWithParams">
    <properties>
        <property name="url" value="https://jmix.io"/>
    </properties>
</item>

@Component("sample_MenuBean")
public class MenuBean {

    @Autowired
    private ObjectProvider<WebBrowserTools> webBrowserToolsProvider;

    public void openLink(Map<String, Object> parameters) {
        String url = (String) parameters.get("url");
        if (url == null) {
            return;
        }

        webBrowserToolsProvider.getObject().showWebPage(
                url, ParamsMap.of("target", "_blank"));
    }
}

class - a fully qualified name of a class that implements the MenuItemRunnable interface. When the user clicks on the menu item, an instance of the specified class is created and its method is invoked.

<item class="ui.ex2.app.CustomMenu" id="jmix" caption="Open page"/>

public class CustomMenu implements MenuItemRunnable, ApplicationContextAware {

    private ApplicationContext applicationContext;

    public void openLink(String url) {
        applicationContext.getBean(WebBrowserTools.class)
                .showWebPage(url, ParamsMap.of("target", "_blank"));
    }

    @Override
    public void run(FrameOwner origin, MenuItem menuItem) {
        if (menuItem.getId().equals("jmix")) {
            openLink("https://jmix.io");
        } else {
            openLink("https://google.com");
        }
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext)
            throws BeansException {
        this.applicationContext = applicationContext;
    }
}

shortcut - a keyboard shortcut for this menu item. Possible modifiers - ALT, CTRL, SHIFT - are separated with “-”. For example:

<item screen="sample_City.browse"
      id="cities3"
      shortcut="ALT-C"/>

<item screen="sample_City.browse"
      id="cities4"
      shortcut="${sample.menu.city}"/>

sample.menu.city=ALT-CTRL-C

The openMode attribute defines how a screen will be opened. It corresponds to the OpenMode enumeration with the values: NEW_TAB, DIALOG, NEW_WINDOW. Default value is NEW_TAB.

<item screen="sample_City.browse"
      id="cities5"
      openMode="DIALOG"/>

icon - an icon of the item element. See Icons for details.

insertBefore, insertAfter - determine whether the item should be inserted before or after a particular element or a menu item with the specified identifier.

resizable - only relevant to the DIALOG screen open mode. Controls window resizing ability. Possible values − true, false. By default, the main menu does not affect the ability to resize dialog windows.

stylename - defines a style name for the menu item. See Themes for details.

name - property name.

value - property value for non-entity properties.

entityClass - class of the entity property.

entityId - id of the entity property.

entityFetchPlan - optional fetch plan for loading an entity property.