GAM: Add context menu to NPC list panels for quick CRE structure access

Author: Argent77

src/org/infinity/resource/gam/Viewer.java

@@ -9,16 +9,27 @@
 import java.awt.GridBagLayout;
 import java.awt.GridLayout;
 import java.awt.Insets;
+import java.awt.Point;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.util.Objects;
 
 import javax.swing.BorderFactory;
 import javax.swing.DefaultListCellRenderer;
 import javax.swing.JList;
+import javax.swing.JMenuItem;
 import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
 
 import org.infinity.datatype.Flag;
 import org.infinity.datatype.ResourceRef;
+import org.infinity.gui.ViewFrame;
 import org.infinity.gui.ViewerUtil;
 import org.infinity.gui.ViewerUtil.ListValueRenderer;
+import org.infinity.gui.ViewerUtil.StructListPanel;
+import org.infinity.icon.Icons;
 import org.infinity.resource.AbstractStruct;
 import org.infinity.resource.AbstractVariable;
 import org.infinity.resource.StructEntry;
@@ -95,10 +106,12 @@ private static JPanel makeMiscPanel(GamResource gam) {
   }
 
   Viewer(GamResource gam) {
-    final JPanel stats1Panel = ViewerUtil.makeListPanel("Non-player characters", gam, NonPartyNPC.class, NPC_ENTRY);
-    final JPanel stats2Panel = ViewerUtil.makeListPanel("Player characters", gam, PartyNPC.class, NPC_ENTRY);
+    final StructListPanel stats1Panel = ViewerUtil.makeListPanel("Non-player characters", gam, NonPartyNPC.class, NPC_ENTRY);
+    new NpcContextMenu(stats1Panel);
+    final StructListPanel stats2Panel = ViewerUtil.makeListPanel("Player characters", gam, PartyNPC.class, NPC_ENTRY);
+    new NpcContextMenu(stats2Panel);
 
-    JPanel var1Panel = ViewerUtil.makeListPanel("Variables", gam, Variable.class, AbstractVariable.VAR_NAME,
+    StructListPanel var1Panel = ViewerUtil.makeListPanel("Variables", gam, Variable.class, AbstractVariable.VAR_NAME,
         new VariableListRenderer());
 
     setLayout(new GridLayout(2, 3, 3, 3));
@@ -137,4 +150,119 @@ public String getListValue(Object value) {
       return "";
     }
   }
+
+  /**
+   * Handles a context menu associated with a {@code PartyNPC} list panel.
+   */
+  private static class NpcContextMenu extends MouseAdapter implements ActionListener {
+    private final JPopupMenu popup = new JPopupMenu();
+    private final JMenuItem miOpenChr = new JMenuItem("View/Edit CHR", Icons.ICON_ZOOM_16.getIcon());
+    private final JMenuItem miOpenCre = new JMenuItem("View/Edit CRE", Icons.ICON_ZOOM_16.getIcon());
+
+    private final StructListPanel panel;
+    private final JList<StructEntry> npcList;
+
+    public NpcContextMenu(StructListPanel npcPanel) {
+      this.panel = Objects.requireNonNull(npcPanel);
+      this.npcList = Objects.requireNonNull(this.panel.getList());
+      init();
+    }
+
+//    /** Returns the associated {@code StructListPanel} instance. */
+//    public StructListPanel getPanel() {
+//      return panel;
+//    }
+
+//    /** Returns the {@code JPopupMenu} associated with the list panel. */
+//    public JPopupMenu getPopupMenu() {
+//      return popup;
+//    }
+
+    @Override
+    public void mousePressed(MouseEvent e) {
+      showPopup(e, true);
+    }
+
+    @Override
+    public void mouseReleased(MouseEvent e) {
+      showPopup(e, true);
+    }
+
+    @Override
+    public void actionPerformed(ActionEvent e) {
+      if (miOpenChr.equals(e.getSource())) {
+        final PartyNPC npc = getSelectedNpc(null, false);
+        if (npc != null) {
+          new ViewFrame(panel.getTopLevelAncestor(), npc);
+        }
+      } else if (miOpenCre.equals(e.getSource())) {
+        final PartyNPC npc = getSelectedNpc(null, false);
+        if (npc != null) {
+          final StructEntry se = npc.getAttribute(PartyNPC.GAM_NPC_CRE_RESOURCE);
+          if (se instanceof CreResource) {
+            new ViewFrame(panel.getTopLevelAncestor(), (CreResource) se);
+          }
+        }
+      }
+    }
+
+    /**
+     * Triggers the context menu addressed by the specified {@code MouseEvent}.
+     *
+     * @param e {@code MouseEvent} to handle.
+     * @param autoSelect Indicates whether the list item at the current mouse coordinate should be selected.
+     */
+    private void showPopup(MouseEvent e, boolean autoSelect) {
+      if (e.isPopupTrigger()) {
+        final PartyNPC npc = getSelectedNpc(new Point(e.getX(), e.getY()), autoSelect);
+        if (npc != null) {
+          miOpenCre.setEnabled(hasCreData(npc));
+          popup.show(e.getComponent(), e.getX(), e.getY());
+        }
+      }
+    }
+
+    /**
+     * Returns whether the specified {@code PartyNPC} structure contains a valid CRE resource substructure.
+     */
+    private boolean hasCreData(PartyNPC npc) {
+      return npc != null && npc.getAttribute(PartyNPC.GAM_NPC_CRE_RESOURCE) instanceof CreResource;
+    }
+
+    /**
+     * Returns the NPC list element at the specified coordinate.
+     *
+     * @param p A location relative to the {@code npcList} component. Can be {@code null}.
+     * @param autoSelect Indicates whether the list item at the specified location should be selected.
+     * @return Returns the {@code PartyNPC} list item closest to the specified location. Returns the selected list item
+     *         if location is {@code null}.
+     */
+    private PartyNPC getSelectedNpc(Point p, boolean autoSelect) {
+      if (p != null && autoSelect) {
+        int index = npcList.locationToIndex(p);
+        if (index >= 0) {
+          npcList.setSelectedIndex(index);
+        }
+      }
+
+      int index = (p != null && !autoSelect) ? npcList.locationToIndex(p) : npcList.getSelectedIndex();
+      if (index >= 0) {
+        final Object listItem = npcList.getModel().getElementAt(index);
+        if (listItem instanceof PartyNPC) {
+          return (PartyNPC) listItem;
+        }
+      }
+      return null;
+    }
+
+    private void init() {
+      miOpenChr.addActionListener(this);
+      miOpenCre.addActionListener(this);
+
+      popup.add(miOpenChr);
+      popup.add(miOpenCre);
+
+      npcList.addMouseListener(this);
+    }
+  }
 }