org.opentcs.guing.common.components.drawing.DrawingViewPlacardPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opentcs-plantoverview-common Show documentation
opentcs-plantoverview-common
There is a newer version: 6.2.0
Show newest version
/**
 * 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.guing.common.components.drawing;

import static java.util.Objects.requireNonNull;

import java.awt.FlowLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ItemEvent;
import java.beans.PropertyChangeEvent;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JPanel;
import javax.swing.JToggleButton;
import org.opentcs.guing.common.util.I18nPlantOverview;
import org.opentcs.guing.common.util.ImageDirectory;
import org.opentcs.thirdparty.guing.common.jhotdraw.util.ResourceBundleUtil;

/**
 * A placard panel for drawing views.
 */
public class DrawingViewPlacardPanel
    extends
      JPanel {

  /**
   * This instance's resource bundle.
   */
  private final ResourceBundleUtil labels
      = ResourceBundleUtil.getBundle(I18nPlantOverview.MODELVIEW_PATH);
  /**
   * A combo box for selecting the zoom level.
   */
  private final JComboBox zoomComboBox;
  /**
   * A toggle button for turning rulers on/off.
   */
  private final JToggleButton toggleRulersButton;
  /**
   * The drawing options.
   */
  private final DrawingOptions drawingOptions;

  /**
   * Creates a new instance.
   *
   * @param drawingView The drawing view.
   * @param drawingOptions The drawing options.
   */
  @SuppressWarnings("this-escape")
  public DrawingViewPlacardPanel(
      OpenTCSDrawingView drawingView,
      DrawingOptions drawingOptions
  ) {
    requireNonNull(drawingView, "drawingView");
    this.drawingOptions = requireNonNull(drawingOptions, "drawingOptions");

    setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));

    // Create an extra panel so that the contents can be centered vertically.
    JPanel vCenteringPanel = new JPanel();
    vCenteringPanel.setLayout(new FlowLayout(FlowLayout.CENTER, 0, 0));
    this.add(Box.createVerticalGlue());
    this.add(vCenteringPanel);

    this.zoomComboBox = zoomComboBox(drawingView);
    vCenteringPanel.add(zoomComboBox);

    vCenteringPanel.add(zoomViewToWindowButton(drawingView));

    // Show/hide grid
    JToggleButton toggleConstrainerButton = toggleConstrainerButton(drawingView);
    toggleConstrainerButton.setSelected(drawingView.isConstrainerVisible());
    vCenteringPanel.add(toggleConstrainerButton);

    // Show/hide rulers
    toggleRulersButton = toggleRulersButton();
    vCenteringPanel.add(toggleRulersButton);

    // Show/hide leabels
    JToggleButton toggleLabelsButton = toggleLabelsButton(drawingView);
    toggleLabelsButton.setSelected(drawingView.isLabelsVisible());
    vCenteringPanel.add(toggleLabelsButton);

    // Show/hide blocks
    JToggleButton toggleBlocksButton = toggleBlocksButton(drawingView);
    toggleBlocksButton.setSelected(drawingOptions.isBlocksVisible());
    vCenteringPanel.add(toggleBlocksButton);
  }

  public JComboBox getZoomComboBox() {
    return zoomComboBox;
  }

  public JToggleButton getToggleRulersButton() {
    return toggleRulersButton;
  }

  /**
   * Creates the combo box with different zoom factors.
   *
   * @param drawingView The DrawingView this combo box will belong to.
   * @return The created combo box.
   */
  private JComboBox zoomComboBox(final OpenTCSDrawingView drawingView) {
    final JComboBox comboBox = new JComboBox<>();
    comboBox.setEditable(true);
    comboBox.setFocusable(true);

    final double[] scaleFactors = {
        5.00, 4.00, 3.00, 2.00, 1.50, 1.25, 1.00, 0.75, 0.50, 0.25, 0.10
    };
    for (int i = 0; i < scaleFactors.length; i++) {
      comboBox.addItem(new ZoomItem(scaleFactors[i]));

      if (scaleFactors[i] == 1.0) {
        comboBox.setSelectedIndex(i);
      }
    }

    comboBox.addActionListener((ActionEvent e) -> {
      final double scaleFactor;

      if (comboBox.getSelectedItem() instanceof ZoomItem) {
        // A zoom step of the array scaleFactors[]
        ZoomItem item = (ZoomItem) comboBox.getSelectedItem();
        scaleFactor = item.getScaleFactor();
      }
      else {
        try {
          // Text input in the combo box
          String text = (String) comboBox.getSelectedItem();
          double factor = Double.parseDouble(text.split(" ")[0]);
          scaleFactor = factor * 0.01;  // Eingabe in %
          comboBox.setSelectedItem((int) (factor + 0.5) + " %");
        }
        catch (NumberFormatException ex) {
          comboBox.setSelectedIndex(0);
          return;
        }
      }

      drawingView.setScaleFactor(scaleFactor);
    });

    drawingView.addPropertyChangeListener((PropertyChangeEvent evt) -> {
      // String constants are interned
      if ("scaleFactor".equals(evt.getPropertyName())) {
        double scaleFactor = (double) evt.getNewValue();

        for (int i = 0; i < comboBox.getItemCount(); i++) {
          // One of the predefined scale factors was selected
          if (scaleFactor == comboBox.getItemAt(i).getScaleFactor()) {
            comboBox.setSelectedIndex(i);
            break;
          }

          if (i + 1 < comboBox.getItemCount()
              && scaleFactor < comboBox.getItemAt(i).getScaleFactor()
              && scaleFactor > comboBox.getItemAt(i + 1).getScaleFactor()) {
            // Insert the new scale factor between the next smaller / larger entries
            ZoomItem newItem = new ZoomItem(scaleFactor);
            comboBox.insertItemAt(newItem, i + 1);
            comboBox.setSelectedItem(newItem);
          }
          else if (scaleFactor > comboBox.getItemAt(0).getScaleFactor()) {
            // Insert new item for scale factor larger than the largest predefined factor
            ZoomItem newItem = new ZoomItem(scaleFactor);
            comboBox.insertItemAt(newItem, 0);
            comboBox.setSelectedItem(newItem);
          }
          else if (scaleFactor < comboBox.getItemAt(comboBox.getItemCount() - 1).getScaleFactor()) {
            // Insert new item for scale factor larger than the largest predefined factor
            ZoomItem newItem = new ZoomItem(scaleFactor);
            comboBox.insertItemAt(newItem, comboBox.getItemCount());
            comboBox.setSelectedItem(newItem);
          }
        }
      }
    });

    return comboBox;
  }

  /**
   * Creates a button that zooms the drawing to a scale factor so that
   * it fits the window size.
   *
   * @return The created button.
   */
  private JButton zoomViewToWindowButton(final OpenTCSDrawingView drawingView) {
    final JButton button = new JButton();

    button.setToolTipText(
        labels.getString("drawingViewPlacardPanel.button_zoomViewToWindow.tooltipText")
    );

    button.setIcon(ImageDirectory.getImageIcon("/menu/zoom-fit-best-4.png"));

    button.setMargin(new Insets(0, 0, 0, 0));
    button.setFocusable(false);

    button.addActionListener((ActionEvent e) -> drawingView.zoomViewToWindow());

    return button;
  }

  /**
   * Creates a button to toggle the grid in the drawing.
   *
   * @param view The DrawingView the button will belong to.
   * @return The created button.
   */
  private JToggleButton toggleConstrainerButton(final OpenTCSDrawingView drawingView) {
    final JToggleButton toggleButton = new JToggleButton();

    toggleButton.setToolTipText(
        labels.getString("drawingViewPlacardPanel.button_toggleGrid.tooltipText")
    );

    toggleButton.setIcon(ImageDirectory.getImageIcon("/menu/view-split.png"));

    toggleButton.setMargin(new Insets(0, 0, 0, 0));
    toggleButton.setFocusable(false);

    toggleButton.addItemListener(
        (ItemEvent event) -> drawingView.setConstrainerVisible(toggleButton.isSelected())
    );

    return toggleButton;
  }

  /**
   * Creates a button to toggle the rulers in the drawing.
   *
   * @return The created button.
   */
  private JToggleButton toggleRulersButton() {
    final JToggleButton toggleButton = new JToggleButton();

    toggleButton.setToolTipText(
        labels.getString("drawingViewPlacardPanel.button_toggleRulers.tooltipText")
    );

    toggleButton.setIcon(ImageDirectory.getImageIcon("/toolbar/document-page-setup.16x16.png"));

    toggleButton.setMargin(new Insets(0, 0, 0, 0));
    toggleButton.setFocusable(false);

    return toggleButton;
  }

  /**
   * Creates a button to toglle the labels.
   *
   * @param view The DrawingView the button will belong to.
   * @return The created button.
   */
  private JToggleButton toggleLabelsButton(final OpenTCSDrawingView drawingView) {
    final JToggleButton toggleButton = new JToggleButton();

    toggleButton.setToolTipText(
        labels.getString("drawingViewPlacardPanel.button_toggleLabels.tooltipText")
    );

    toggleButton.setIcon(ImageDirectory.getImageIcon("/menu/comment-add.16.png"));

    toggleButton.setMargin(new Insets(0, 0, 0, 0));
    toggleButton.setFocusable(false);

    toggleButton.addItemListener(
        (ItemEvent event) -> drawingView.setLabelsVisible(toggleButton.isSelected())
    );

    return toggleButton;
  }

  /**
   * Creates a button to toggle the blocks in the drawing.
   *
   * @param view The DrawingView the button will belong to.
   * @return The created button.
   */
  private JToggleButton toggleBlocksButton(final OpenTCSDrawingView drawingView) {
    final JToggleButton toggleButton = new JToggleButton();

    toggleButton.setToolTipText(
        labels.getString("drawingViewPlacardPanel.button_toggleBlocks.tooltipText")
    );

    toggleButton.setIcon(ImageDirectory.getImageIcon("/tree/block.18x18.png"));

    toggleButton.setMargin(new Insets(0, 0, 0, 0));
    toggleButton.setFocusable(false);

    toggleButton.addItemListener(itemEvent -> {
      drawingOptions.setBlocksVisible(toggleButton.isSelected());
      drawingView.drawingOptionsChanged();
    });

    return toggleButton;
  }
}