org.opentcs.operationsdesk.application.menus.VehiclePopupMenu Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.operationsdesk.application.menus;

import static java.util.Objects.requireNonNull;

import com.google.inject.assistedinject.Assisted;
import jakarta.inject.Inject;
import java.util.Collection;
import javax.swing.Action;
import javax.swing.JCheckBoxMenuItem;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JPopupMenu;
import org.opentcs.data.model.Vehicle;
import org.opentcs.data.order.ReroutingType;
import org.opentcs.guing.base.model.elements.VehicleModel;
import org.opentcs.guing.common.persistence.ModelManager;
import org.opentcs.operationsdesk.application.action.ActionFactory;
import org.opentcs.operationsdesk.util.I18nPlantOverviewOperating;
import org.opentcs.operationsdesk.util.OperationsDeskConfiguration;
import org.opentcs.thirdparty.guing.common.jhotdraw.util.ResourceBundleUtil;

/**
 * A popup menu for actions for multiple selected vehicles.
 */
public class VehiclePopupMenu
    extends
      JPopupMenu {

  /**
   * Creates a new instance.
   *
   * @param modelManager Provides access to the current system model.
   * @param actionFactory A factory for menu actions.
   * @param configuration The application configuration.
   * @param vehicles a set of all currently selected Vehicles.
   */
  @Inject
  @SuppressWarnings("this-escape")
  public VehiclePopupMenu(
      ModelManager modelManager,
      ActionFactory actionFactory,
      OperationsDeskConfiguration configuration,
      @Assisted
      Collection vehicles
  ) {
    requireNonNull(modelManager, "modelManager");
    requireNonNull(actionFactory, "actionFactory");
    requireNonNull(vehicles, "vehicles");

    final ResourceBundleUtil bundle
        = ResourceBundleUtil.getBundle(I18nPlantOverviewOperating.VEHICLEPOPUP_PATH);
    VehicleModel singleVehicle = vehicles.stream().findFirst().get();
    JCheckBoxMenuItem checkBoxMenuItem;
    Action action;

    JMenuItem mi = new JMenuItem();
    mi.setEnabled(false);
    if (vehicles.size() == 1) {
      mi.setText(
          bundle.getString("vehiclePopupMenu.menuItem_singleVehicle.text") + singleVehicle.getName()
      );
    }
    else {
      mi.setText(bundle.getString("vehiclePopupMenu.menuItem_multipleVehicles.text"));
    }
    add(mi);

    addSeparator();

    if (vehicles.size() == 1) {
      action = actionFactory.createScrollToVehicleAction(singleVehicle);
      add(action);

      action = actionFactory.createFollowVehicleAction(singleVehicle);
      JCheckBoxMenuItem followCheckBox = new JCheckBoxMenuItem();
      followCheckBox.setAction(action);
      followCheckBox.setSelected(singleVehicle.isViewFollows());
      add(followCheckBox);

      addSeparator();
    }

    if (vehicles.size() == 1) {
      action = actionFactory.createSendVehicleToPointAction(singleVehicle);
      action.setEnabled(
          singleVehicle.isAvailableForOrder()
              && !modelManager.getModel().getPointModels().isEmpty()
      );
      add(action);

      action = actionFactory.createSendVehicleToLocationAction(singleVehicle);
      action.setEnabled(
          singleVehicle.isAvailableForOrder()
              && !modelManager.getModel().getLocationModels().isEmpty()
      );
      add(action);

      addSeparator();
    }

    JMenu pauseSubMenu = new JMenu(bundle.getString("vehiclePopupMenu.subMenu_pause.text"));

    action = actionFactory.createPauseAction(vehicles, true);
    checkBoxMenuItem = new JCheckBoxMenuItem(action);
    checkBoxMenuItem.setSelected(allPaused(vehicles));
    pauseSubMenu.add(checkBoxMenuItem);

    action = actionFactory.createPauseAction(vehicles, false);
    checkBoxMenuItem = new JCheckBoxMenuItem(action);
    checkBoxMenuItem.setSelected(nonePaused(vehicles));
    pauseSubMenu.add(checkBoxMenuItem);

    add(pauseSubMenu);

    addSeparator();

    JMenu integrateSubMenu
        = new JMenu(bundle.getString("vehiclePopupMenu.subMenu_integrate.text"));

    action = actionFactory.createIntegrationLevelChangeAction(
        vehicles,
        Vehicle.IntegrationLevel.TO_BE_IGNORED
    );
    action.setEnabled(!isAnyProcessingOrder(vehicles));
    checkBoxMenuItem = new JCheckBoxMenuItem(action);
    checkBoxMenuItem.setSelected(
        isAnyAtIntegrationLevel(
            vehicles,
            Vehicle.IntegrationLevel.TO_BE_IGNORED
        )
    );
    integrateSubMenu.add(checkBoxMenuItem);

    action = actionFactory.createIntegrationLevelChangeAction(
        vehicles,
        Vehicle.IntegrationLevel.TO_BE_NOTICED
    );
    action.setEnabled(!isAnyProcessingOrder(vehicles));
    checkBoxMenuItem = new JCheckBoxMenuItem(action);
    checkBoxMenuItem.setSelected(
        isAnyAtIntegrationLevel(
            vehicles,
            Vehicle.IntegrationLevel.TO_BE_NOTICED
        )
    );
    integrateSubMenu.add(checkBoxMenuItem);

    action = actionFactory.createIntegrationLevelChangeAction(
        vehicles,
        Vehicle.IntegrationLevel.TO_BE_RESPECTED
    );
    checkBoxMenuItem = new JCheckBoxMenuItem(action);
    checkBoxMenuItem.setSelected(
        isAnyAtIntegrationLevel(vehicles, Vehicle.IntegrationLevel.TO_BE_RESPECTED)
    );
    integrateSubMenu.add(checkBoxMenuItem);

    action = actionFactory.createIntegrationLevelChangeAction(
        vehicles,
        Vehicle.IntegrationLevel.TO_BE_UTILIZED
    );
    checkBoxMenuItem = new JCheckBoxMenuItem(action);
    checkBoxMenuItem.setSelected(
        isAnyAtIntegrationLevel(vehicles, Vehicle.IntegrationLevel.TO_BE_UTILIZED)
    );
    integrateSubMenu.add(checkBoxMenuItem);

    add(integrateSubMenu);

    addSeparator();

    JMenu rerouteSubMenu
        = new JMenu(bundle.getString("vehiclePopupMenu.subMenu_reroute.text"));

    action = actionFactory.createRerouteAction(vehicles, ReroutingType.REGULAR);
    action.setEnabled(isAnyProcessingOrder(vehicles));
    rerouteSubMenu.add(action);

    action = actionFactory.createRerouteAction(vehicles, ReroutingType.FORCED);
    action.setEnabled(isAnyProcessingOrder(vehicles));
    rerouteSubMenu.add(action);

    add(rerouteSubMenu);

    addSeparator();

    JMenu withdrawSubMenu
        = new JMenu(bundle.getString("vehiclePopupMenu.subMenu_withdraw.text"));

    action = actionFactory.createWithdrawAction(vehicles, false);
    action.setEnabled(isAnyProcessingOrder(vehicles));
    withdrawSubMenu.add(action);

    action = actionFactory.createWithdrawAction(vehicles, true);
    action.setEnabled(configuration.allowForcedWithdrawal() && isAnyProcessingOrder(vehicles));
    withdrawSubMenu.add(action);

    add(withdrawSubMenu);
  }

  private boolean allPaused(Collection vehicles) {
    return vehicles.stream().allMatch(vehicle -> isPaused(vehicle));
  }

  private boolean nonePaused(Collection vehicles) {
    return vehicles.stream().noneMatch(vehicle -> isPaused(vehicle));
  }

  private boolean isAnyProcessingOrder(Collection vehicles) {
    return vehicles.stream().anyMatch(vehicle -> isProcessingOrder(vehicle));
  }

  private boolean isPaused(VehicleModel vehicle) {
    return Boolean.TRUE.equals(vehicle.getPropertyPaused().getValue());
  }

  private boolean isProcessingOrder(VehicleModel vehicle) {
    return vehicle.getPropertyProcState().getValue() == Vehicle.ProcState.PROCESSING_ORDER
        || vehicle.getPropertyProcState().getValue() == Vehicle.ProcState.AWAITING_ORDER;
  }

  private boolean isAnyAtIntegrationLevel(
      Collection vehicles,
      Vehicle.IntegrationLevel level
  ) {
    return vehicles.stream().anyMatch(
        vehicle -> vehicle.getPropertyIntegrationLevel().getComparableValue().equals(level)
    );
  }
}