Package io.jmix.flowui.menu

Class MenuItem

java.lang.Object
io.jmix.flowui.menu.MenuItem
public class MenuItem extends Object
Main menu item descriptor.

  • Field Details

  • Constructor Details

    • MenuItem

      public MenuItem(@Nullable MenuItem parent, String id)

    • MenuItem

      public MenuItem(String id)

  • Method Details

    • isMenu

      public boolean isMenu()

    • setMenu

      public void setMenu(boolean isMenu)

    • getParent

      @Nullable public MenuItem getParent()
      Parent item. Null if this is root item.

    • getChildren

      public List<MenuItem> getChildren()
      Children items

    • getId

      public String getId()
      Menu item ID as defined in menu-config.xml

    • getDescriptor

      public org.dom4j.Element getDescriptor()

    • setDescriptor

      public void setDescriptor(org.dom4j.Element descriptor)

    • getTitle

      public String getTitle()
      Returns:
      a raw string from menu XML config, can be a reference to localization message, e.g. mainMsg://menuitem.title
      See Also:

    • setTitle

      public void setTitle(String caption)
      Sets the given caption to menu item.
      Parameters:
      caption - menu item caption
      See Also:

    • getDescription

      public String getDescription()
      Returns:
      a raw string from menu XML config, can be a reference to localization message, e.g. mainMsg://menuitem.description

    • setDescription

      public void setDescription(String description)
      Sets the given description to menu item.
      Parameters:
      description - menu item description

    • getClassNames

      public String getClassNames()

    • setClassNames

      public void setClassNames(String classNames)

    • getShortcutCombination

      @Nullable public KeyCombination getShortcutCombination()

    • setShortcutCombination

      public void setShortcutCombination(@Nullable KeyCombination shortcutCombination)

    • isSeparator

      public boolean isSeparator()

    • setSeparator

      public void setSeparator(boolean separator)

    • getIcon

      @Nullable public String getIcon()

    • setIcon

      public void setIcon(@Nullable String icon)

    • isOpened

      public boolean isOpened()

    • setOpened

      public void setOpened(boolean expanded)

    • getView

      @Nullable public String getView()

    • setView

      public void setView(@Nullable String view)

    • getBean

      @Nullable public String getBean()

    • setBean

      public void setBean(@Nullable String bean)

    • getBeanMethod

      @Nullable public String getBeanMethod()

    • setBeanMethod

      public void setBeanMethod(@Nullable String beanMethod)

    • getProperties

      public List<MenuItem.MenuItemProperty> getProperties()

    • setProperties

      public void setProperties(List<MenuItem.MenuItemProperty> properties)

    • getUrlQueryParameters

      public List<MenuItem.MenuItemParameter> getUrlQueryParameters()

    • setUrlQueryParameters

      public void setUrlQueryParameters(List<MenuItem.MenuItemParameter> urlQueryParameters)

    • getRouteParameters

      public List<MenuItem.MenuItemParameter> getRouteParameters()

    • setRouteParameters

      public void setRouteParameters(List<MenuItem.MenuItemParameter> routeParameters)