ElephantSubmenu.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.menu;
 
import java.util.Collection;
import java.util.function.BiConsumer;
import org.turro.string.Strings;
import org.turro.elephant.util.Components;
import org.turro.elephant.util.Images;
import org.turro.i18n.I_;
import org.turro.security.Permission;
import org.turro.zul.frame.Framework;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.EventListener;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zul.Menuitem;
import org.zkoss.zul.Menupopup;
import org.zkoss.zul.Menuseparator;
import org.zkoss.zul.Toolbarbutton;
 
public class ElephantSubmenu extends Menupopup {
  
  private boolean separator = false;
  
  public ElephantMenuBar getMenuBar() {
    return Components.from(this).parent(ElephantMenuBar.class);
  }
 
  public ElephantMenu getParentMenu() {
    return Components.from(this).parent(ElephantMenu.class);
  }
 
  public ElephantSubmenu getParentSubmenu() {
    return Components.from(this).parent(ElephantSubmenu.class);
  }
 
  public ElephantMenu addMenu(String label) {
    return addMenu(label, null, null);
  }
  
  public ElephantMenu addMenu(String label, String image) {
    return addMenu(label, image, null);
  }
 
  public ElephantMenu addMenu(String label, Permission permission) {
    return addMenu(label, null, permission);
  }
  
  public ElephantMenu addMenu(String label, String image, Permission permission) {
    checkSeparator();
    ElephantMenu m = image == null ? new ElephantMenu(label) : new ElephantMenu(label, image);
    appendChild(m);
    if(permission != null) m.setVisible(permission.check());
    return m;
  }
 
  public ElephantSubmenu addMenuitem(String label, String include) {
    return addMenuitem(label, null, include);
  }
  
  public ElephantSubmenu addMenuitem(String label, EventListener listener) {
    return addMenuitem(label, null, listener);
  }
 
  public ElephantSubmenu addMenuitem(String label, EventListener listener, boolean toolButton) {
    return addMenuitem(label, null, listener, toolButton);
  }
 
  public ElephantSubmenu addMenuitem(String label, String image, String include) {
    return addMenuitem(label, image, include, false);
  }
  
  public ElephantSubmenu addMenuitem(String label, String image, EventListener listener) {
    return addMenuitem(label, image, listener, false);
  }
 
  public ElephantSubmenu addMenuitem(String label, String image, String include, boolean toolButton) {
    return addMenuitem(label, image, include, toolButton, null);
  }
 
  public ElephantSubmenu addMenuitem(String label, String image, EventListener listener, boolean toolButton) {
    return addMenuitem(label, image, listener, toolButton, null);
  }
 
  public ElephantSubmenu addMenuitem(String label, String include, Permission permission) {
    return addMenuitem(label, null, include, permission);
  }
  
  public ElephantSubmenu addMenuitem(String label, EventListener listener, Permission permission) {
    return addMenuitem(label, null, listener, permission);
  }
 
  public ElephantSubmenu addMenuitem(String label, String include, boolean toolButton, Permission permission) {
    return addMenuitem(label, null, include, toolButton, permission);
  }
 
  public ElephantSubmenu addMenuitem(String label, EventListener listener, boolean toolButton, Permission permission) {
    return addMenuitem(label, null, listener, toolButton, permission);
  }
 
  public ElephantSubmenu addMenuitem(String label, String image, String include, Permission permission) {
    return addMenuitem(label, image, include, false, permission);
  }
  
  public ElephantSubmenu addMenuitem(String label, String image, EventListener listener, Permission permission) {
    return addMenuitem(label, image, listener, false, permission);
  }
 
  public ElephantSubmenu addMenuitem(String label, String image, String include, boolean toolButton, Permission permission) {
    if(permission == null || permission.check()) {
      EventListener listener = null;
      if(include != null) {
        listener = (EventListener) (Event event) -> {
          Framework.getCurrent().addContent(I_.get(label), ElephantMenu.makeInclude(include));
        };
      }
      return addMenuitem(label, image, listener, toolButton, permission);
    }
    return this;
  }
 
  public ElephantSubmenu addMenuitem(String label, String image, EventListener listener, boolean toolButton, Permission permission) {
    if(permission == null || permission.check()) {
      ElephantToolbar toolbar = getToolbar();
      if(toolButton && toolbar != null) {
        Toolbarbutton button = new Toolbarbutton();
        toolbar.addComponent(button);
        button.setTooltiptext(I_.get(label));
        if(!Strings.isBlank(image)) {
          button.setImage(Images.getImage(image));
        }
        if(listener != null) {
          button.addEventListener(Events.ON_CLICK, listener);
        }
      }
      checkSeparator();
      Menuitem mi = new Menuitem(I_.get(label));
      if(!Strings.isBlank(image)) {
        mi.setImage(Images.getImage(image));
      }
      appendChild(mi);
      if(listener != null) {
        mi.addEventListener(Events.ON_CLICK, listener);
      }
    }
    return this;
  }
 
  public ElephantSubmenu addMenuSeparator() {
    if(!getChildren().isEmpty()) separator = true;
    return this;
  }
  
  public ElephantSubmenu addExternalsToSession(Collection<ElephantMenu> externals) {
    for(ElephantMenu em : externals) {
      em.addToSessionMenu(this);
    }
    return this;
  }
 
  public ElephantSubmenu addExternalsToTools(Collection<ElephantMenu> externals) {
    for(ElephantMenu em : externals) {
      em.addToToolsMenu(this);
    }
    return this;
  }
 
  public ElephantSubmenu addToolbarSeparator(boolean bar) {
    getToolbar().addSeparator(false);
    return this;
  }
 
  public <T> ElephantSubmenu addCollecction(Collection<T> items, BiConsumer<ElephantSubmenu, T> consumer) {
    items.stream().forEach((i) -> consumer.accept(ElephantSubmenu.this, i));
    return this;
  }
  
  public <T> ElephantSubmenu addObject(T item, BiConsumer<ElephantSubmenu, T> consumer) {
   consumer.accept(ElephantSubmenu.this, item);
   return this;
  }
  
  private ElephantToolbar getToolbar() {
    ElephantMenuBar emb = getMenuBar();
    return emb != null ? emb.getToolbar() : null;
  }
 
  private void checkSeparator() {
    if(separator) {
      appendChild(new Menuseparator());
      separator = false;
    }
  }
 
}