{GuiGraphic,Interaction}Frame: Convert toolbars to proper menu bar

And enable MacOS system integration

Author: bvlj

lib/src/main/java/jtamaro/interaction/InteractionFrame.java

@@ -8,17 +8,31 @@
 import java.awt.event.MouseEvent;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
+import javax.swing.Box;
+import javax.swing.JButton;
 import javax.swing.JFrame;
+import javax.swing.JLabel;
+import javax.swing.JMenu;
+import javax.swing.JMenuBar;
+import javax.swing.JMenuItem;
+import javax.swing.JPanel;
+import javax.swing.KeyStroke;
 import javax.swing.SwingUtilities;
 import javax.swing.Timer;
 import jtamaro.graphic.Graphic;
 import jtamaro.graphic.GuiGraphicCanvas;
+import jtamaro.io.IO;
 
 /**
  * GUI that allows the user to interact with an {@link Interaction}.
  */
 final class InteractionFrame<M> extends JFrame {
 
+  static {
+    // Use system menu bar on macOS
+    System.setProperty("apple.laf.useScreenMenuBar", "true");
+  }
+
   private final Interaction<M> interaction;
 
   private final InteractionState<M> state;
@@ -27,6 +41,12 @@ final class InteractionFrame<M> extends JFrame {
 
   private final Timer timer;
 
+  private final JMenuItem startStopItem;
+
+  private final JButton startStopButton;
+
+  private final JLabel tickLabel;
+
   private final GuiGraphicCanvas graphicCanvas;
 
   public InteractionFrame(Interaction<M> interaction) {
@@ -36,14 +56,66 @@ public InteractionFrame(Interaction<M> interaction) {
     this.timer = new Timer(interaction.getMsBetweenTicks(), this::onTick);
 
     setTitle(interaction.getName());
+    setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
+    addWindowListener(new WindowAdapter() {
+      @Override
+      public void windowClosing(WindowEvent winEvt) {
+        // No need to call the stopTimer() method, we don't need
+        // to update UI components at this point.
+        timer.stop();
+      }
+    });
+
+    // Menu bar
+    final JMenuBar menuBar = new JMenuBar();
+    setJMenuBar(menuBar);
+
+    final JMenu fileMenu = new JMenu("File");
+    fileMenu.setMnemonic(KeyEvent.VK_F);
+    menuBar.add(fileMenu);
+
+    startStopItem = new JMenuItem();
+    startStopItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F8, 0));
+    startStopItem.addActionListener(e -> toggleTimer());
+    fileMenu.add(startStopItem);
+
+    final JMenuItem viewFrame = new JMenuItem("Inspect Frame");
+    viewFrame.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F1, 0));
+    viewFrame.addActionListener(e -> SwingUtilities.invokeLater(() -> {
+      stopTimer();
+      IO.show(interaction.getRenderer().apply(state.getModel()));
+    }));
+    fileMenu.add(viewFrame);
+
+    final JMenu viewMenu = new JMenu("View");
+    viewMenu.setMnemonic(KeyEvent.VK_V);
+    menuBar.add(viewMenu);
+
+    final JMenuItem viewTrace = new JMenuItem("Trace");
+    viewTrace.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F2, 0));
+    viewTrace.addActionListener(e -> SwingUtilities.invokeLater(() ->
+        new TraceFrame(eventsTrace).setVisible(true)));
+    viewMenu.add(viewTrace);
+
+    final JMenuItem viewModel = new JMenuItem("Model");
+    viewModel.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F3, 0));
+    viewModel.addActionListener(e -> SwingUtilities.invokeLater(() ->
+        new ModelFrame<>(interaction, eventsTrace).setVisible(true)));
+    viewMenu.add(viewModel);
 
     // Toolbar
-    final InteractionToolbar<M> toolbar = new InteractionToolbar<>(interaction,
-        state,
-        timer,
-        eventsTrace);
+    final JPanel toolbar = new JPanel();
     add(toolbar, BorderLayout.NORTH);
 
+    tickLabel = new JLabel();
+    toolbar.add(tickLabel, BorderLayout.WEST);
+
+    toolbar.add(Box.createHorizontalStrut(20));
+
+    startStopButton = new JButton();
+    startStopButton.addActionListener(e -> toggleTimer());
+    toolbar.add(startStopButton, BorderLayout.EAST);
+
     // Canvas component
     int canvasWidth = interaction.getCanvasWidth();
     int canvasHeight = interaction.getCanvasHeight();
@@ -104,14 +176,6 @@ public void mouseDragged(MouseEvent ev) {
         traceEvent(new TraceEvent.MouseMoved(coordinate));
       }
     });
-
-    setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
-    addWindowListener(new WindowAdapter() {
-      @Override
-      public void windowClosing(WindowEvent winEvt) {
-        timer.stop();
-      }
-    });
     add(graphicCanvas, BorderLayout.CENTER);
 
     pack();
@@ -122,18 +186,47 @@ public void windowClosing(WindowEvent winEvt) {
       graphicCanvas.requestFocus();
 
       // Start the timer
-      timer.start();
+      startTimer();
       // The timer is now running, configure the toolbar buttons
-      toolbar.configureButtons();
+      viewFrame.setEnabled(true);
     });
   }
 
+  private void toggleTimer() {
+    if (timer.isRunning()) {
+      stopTimer();
+    } else {
+      startTimer();
+    }
+  }
+
+  private void stopTimer() {
+    if (!timer.isRunning()) {
+      return;
+    }
+
+    startStopItem.setText("Start");
+    startStopButton.setText("Start");
+    timer.stop();
+  }
+
+  private void startTimer() {
+    if (timer.isRunning()) {
+      return;
+    }
+
+    startStopItem.setText("Stop");
+    startStopButton.setText("Stop");
+    timer.start();
+  }
+
   private void onTick(ActionEvent ev) {
     if (interaction.getStoppingPredicate().apply(state.getModel())) {
-      timer.stop();
+      stopTimer();
     } else {
       traceEvent(new TraceEvent.Tick());
       state.tick();
+      tickLabel.setText(String.valueOf(state.getTick()));
     }
   }
 

lib/src/main/java/jtamaro/interaction/InteractionState.java

@@ -1,21 +1,16 @@
 package jtamaro.interaction;
 
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Objects;
 
 final class InteractionState<M> {
 
-  private final List<InteractionStateListener<M>> listeners;
-
   private final Interaction<M> interaction;
 
   private M model;
 
   private long tick;
 
   public InteractionState(Interaction<M> interaction) {
-    this.listeners = new ArrayList<>();
     this.interaction = interaction;
 
     final M initialModel = interaction.getInitialModel();
@@ -31,7 +26,6 @@ public void tick() {
   public void update(String what, M model) {
     check(what, model);
     this.model = model;
-    fireStateChanged();
   }
 
   public long getTick() {
@@ -42,20 +36,10 @@ public M getModel() {
     return model;
   }
 
-  public void addBigBangStateListener(InteractionStateListener<M> listener) {
-    listeners.add(listener);
-  }
-
   private void check(String what, M model) {
     Objects.requireNonNull(model);
     if (!interaction.getWellFormedPredicate().apply(model)) {
       throw new IllegalStateException(what + " is not well formed");
     }
   }
-
-  private void fireStateChanged() {
-    for (final InteractionStateListener<M> listener : listeners) {
-      listener.stateChanged(this);
-    }
-  }
 }