DefaultUserMenu.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2019 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.elephant.user.menu;
 
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Function;
import org.turro.elephant.context.ElephantContext;
import org.turro.file.Document;
import org.turro.string.Strings;
import org.turro.util.CompareUtil;
 
public abstract class DefaultUserMenu implements IUserMenu, Comparable<IUserMenu> {
 
  protected IUserMenu parent;
  protected Set<IUserMenu> children;
  protected String id, label, image, link;
  protected int order;
  protected Function<IUserMenu, Boolean> command;
 
  public DefaultUserMenu(String label, String image) {
    this(null, label, image, null, null, 0);
  } 
 
  public DefaultUserMenu(String label, String image, String link) {
    this(null, label, image, link, null, 0);
  } 
 
  public DefaultUserMenu(String label, String image, Function<IUserMenu, Boolean> command) {
    this(null, label, image, null, command, 0);
  }
  
  public DefaultUserMenu(String label, String image, int order) {
    this(null, label, image, null, null, order);
  } 
 
  public DefaultUserMenu(String label, String image, String link, int order) {
    this(null, label, image, link, null, order);
  } 
 
  public DefaultUserMenu(String id, String label, String image, Function<IUserMenu, Boolean> command, int order) {
    this(id, label, image, null, command, order);
  }
  
  protected DefaultUserMenu(String id, String label, String image, String link, Function<IUserMenu, Boolean> command, int order) {
    this.id = Strings.isBlank(id) ? (Strings.isBlank(label) ? Strings.asVar(image) : Strings.asVar(label)) : id;
    this.label = label;
    this.image = image;
    this.link = link;
    this.command = command;
    this.order = order;
  } 
 
  @Override
  public String getId() {
    return id;
  }
  
  @Override
  public String getLabel() {
    return label;
  }
 
  @Override
  public String getImage() {
    return image;
  }
 
  @Override
  public int getOrder() {
    return order;
  }
 
  @Override
  public String getLink() {
    return link == null ? (command == null ? null : MenuCommand.createURL(this)) : link;
  }
 
  @Override
  public boolean isValid() {
    return !Strings.isBlank(id) && 
           !(Strings.isBlank(label) && Strings.isBlank(image));
  }
 
  @Override
  public boolean isCaption() {
    return Strings.isBlank(link) && (command == null);
  }
 
  @Override
  public boolean isOnlyLabel() {
    return Strings.isBlank(image);
  }
 
  @Override
  public boolean isOnlyImage() {
    return Strings.isBlank(label);
  }
 
  @Override
  public boolean isActive() {
    String currentPath = UserMenus.getActive();
    return !Strings.isBlank(currentPath) &&
           !Strings.isBlank(getLink()) &&
           getLink().equals(currentPath);
  }
 
  @Override
  public IUserMenu getParent() {
    return parent;
  }
 
  @Override
  public Set<IUserMenu> getChildren() {
    return children;
  }
 
  @Override
  public IUserMenu addChild(IUserMenu menu) {
    if(children == null) {
      children = new TreeSet<>();
    }
    if(menu.isValid()) {
      if((menu instanceof DefaultUserMenu) && menu.getOrder() == 0) {
        ((DefaultUserMenu) menu).setOrder(children.size() + 1);
      }
      children.add(menu);
    }
    return menu;
  }
 
  protected void setOrder(int order) {
    this.order = order;
  }
  
  @Override
  public boolean execute() {
    return command.apply(this);
  }
 
  @Override
  public void initMenu() {
    // do nothing
  }
  
  @Override
  public int compareTo(IUserMenu o) {
    int result = CompareUtil.compare(order, o.getOrder());
    if(result == 0) {
      result = CompareUtil.compare(label, o.getLabel());
    }
    if(result == 0) {
      result = CompareUtil.compare(id, o.getId());
    }
    return result;
  }
 
  @Override
  public abstract boolean isInRole();
  
  @Override
  public abstract Object getDetail();
  
  public boolean isHidden() {
    return Document.from(ElephantContext.getRealPath("/WEB-INF/elephant/conf/hidden/" + this.getClass().getSimpleName())).exists();
  }
  
}