Class MenuBuilder


  • public class MenuBuilder
    extends java.lang.Object
    Builder to create a Menu.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.List<MenuItem> m_menuBar  
    • Constructor Summary

      Constructors 
      Constructor Description
      MenuBuilder()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMenuItem​(MenuItem menuItem, java.lang.String... parentPath)
      Adds a menu item for path.
      void apply​(com.vaadin.ui.MenuBar rootMenu, java.util.List<VertexRef> targets, OperationContext operationContext, java.lang.Runnable... hooks)  
      protected void applyOrderToChildren​(MenuItem parent)  
      com.vaadin.ui.MenuBar build​(java.util.List<VertexRef> targets, OperationContext operationContext, java.lang.Runnable... hooks)
      Converts the current menu configuration to Vaadin's MenuBar representation.
      void createPath​(java.lang.String... path)
      Creates the provided menu path (e.g.
      protected void determineAndApplyOrder()  
      protected static java.lang.String getGroupForLabel​(java.lang.String label, java.util.List<java.lang.String> submenuOrder)  
      protected static java.lang.String removeLabelProperties​(java.lang.String commandKey)  
      void setSubMenuGroupOrder​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> submenOrderMap)  
      void setTopLevelMenuOrder​(java.util.List<java.lang.String> menuOrder)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • m_menuBar

        protected java.util.List<MenuItem> m_menuBar
    • Constructor Detail

      • MenuBuilder

        public MenuBuilder()
    • Method Detail

      • createPath

        public void createPath​(java.lang.String... path)
        Creates the provided menu path (e.g. File, Save As)
        Parameters:
        path - The path to create
      • addMenuItem

        public void addMenuItem​(MenuItem menuItem,
                                java.lang.String... parentPath)
        Adds a menu item for path. If path is empty, it is added as a root entry.
        Parameters:
        menuItem - The item to add.
        parentPath - The item to add to
      • setTopLevelMenuOrder

        public void setTopLevelMenuOrder​(java.util.List<java.lang.String> menuOrder)
      • setSubMenuGroupOrder

        public void setSubMenuGroupOrder​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> submenOrderMap)
      • determineAndApplyOrder

        protected void determineAndApplyOrder()
      • applyOrderToChildren

        protected void applyOrderToChildren​(MenuItem parent)
      • build

        public com.vaadin.ui.MenuBar build​(java.util.List<VertexRef> targets,
                                           OperationContext operationContext,
                                           java.lang.Runnable... hooks)
        Converts the current menu configuration to Vaadin's MenuBar representation.
        Parameters:
        targets - The current targets (e.g. the selection)
        operationContext - The current OperationContext.
        hooks - Optional hooks to be executed after a menu item's command has been executed.
        Returns:
        The converted MenuBar
      • apply

        public void apply​(com.vaadin.ui.MenuBar rootMenu,
                          java.util.List<VertexRef> targets,
                          OperationContext operationContext,
                          java.lang.Runnable... hooks)
      • getGroupForLabel

        protected static java.lang.String getGroupForLabel​(java.lang.String label,
                                                           java.util.List<java.lang.String> submenuOrder)
      • removeLabelProperties

        protected static java.lang.String removeLabelProperties​(java.lang.String commandKey)