Merge branch 'develop' into feature/JAL-3551Pymol
[jalview.git] / src / jalview / jbgui / GStructureViewer.java
index 8116d82..6c0beda 100644 (file)
@@ -1,28 +1,80 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview 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 General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.jbgui;
 
-import javax.swing.*;
-import java.awt.event.ActionListener;
+import java.awt.BorderLayout;
+import java.awt.GridLayout;
 import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
 
-public class GStructureViewer extends JInternalFrame
+import javax.swing.JInternalFrame;
+import javax.swing.JLabel;
+import javax.swing.JMenu;
+import javax.swing.JMenuBar;
+import javax.swing.JMenuItem;
+import javax.swing.JPanel;
+import javax.swing.JRadioButtonMenuItem;
+
+import jalview.api.structures.JalviewStructureDisplayI;
+import jalview.gui.ColourMenuHelper.ColourChangeListener;
+import jalview.util.ImageMaker.TYPE;
+import jalview.util.MessageManager;
+
+@SuppressWarnings("serial")
+public abstract class GStructureViewer extends JInternalFrame
+        implements JalviewStructureDisplayI, ColourChangeListener
 {
+  // private AAStructureBindingModel bindingModel;
+
+  protected JMenu savemenu;
+
+  protected JMenu viewMenu;
+
+  protected JMenu colourMenu;
+
+  protected JMenu chainMenu;
+
+  protected JMenu viewerActionMenu;
+
+  protected JMenuItem alignStructs;
+
+  protected JMenuItem fitToWindow;
+
+  protected JRadioButtonMenuItem seqColour;
+
+  protected JRadioButtonMenuItem chainColour;
+
+  protected JRadioButtonMenuItem chargeColour;
+
+  protected JRadioButtonMenuItem viewerColour;
+
+  protected JMenuItem helpItem;
+
+  protected JLabel statusBar;
+
+  protected JPanel statusPanel;
+
+  /**
+   * Constructor
+   */
   public GStructureViewer()
   {
     try
@@ -36,362 +88,181 @@ public class GStructureViewer extends JInternalFrame
 
   private void jbInit() throws Exception
   {
+
+    setName("jalview-structureviewer");
+
+    JMenuBar menuBar = new JMenuBar();
     this.setJMenuBar(menuBar);
-    fileMenu.setText("File");
-    savemenu.setActionCommand("Save Image");
-    savemenu.setText("Save As");
-    pdbFile.setText("PDB File");
+
+    JMenu fileMenu = new JMenu();
+    fileMenu.setText(MessageManager.getString("action.file"));
+
+    savemenu = new JMenu();
+    savemenu.setActionCommand(
+            MessageManager.getString("action.save_image"));
+    savemenu.setText(MessageManager.getString("action.save_as"));
+
+    JMenuItem pdbFile = new JMenuItem();
+    pdbFile.setText(MessageManager.getString("label.pdb_file"));
     pdbFile.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        pdbFile_actionPerformed(actionEvent);
+        pdbFile_actionPerformed();
       }
     });
+
+    JMenuItem png = new JMenuItem();
     png.setText("PNG");
     png.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        png_actionPerformed(actionEvent);
+        makePDBImage(TYPE.PNG);
       }
     });
+
+    JMenuItem eps = new JMenuItem();
     eps.setText("EPS");
     eps.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        eps_actionPerformed(actionEvent);
+        makePDBImage(TYPE.EPS);
       }
     });
-    viewMapping.setText("View Mapping");
+
+    JMenuItem viewMapping = new JMenuItem();
+    viewMapping.setText(MessageManager.getString("label.view_mapping"));
     viewMapping.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        viewMapping_actionPerformed(actionEvent);
-      }
-    });
-    viewMenu.setText("View");
-    chainMenu.setText("Show Chain");
-    colourMenu.setText("Colours");
-    backGround.setText("Background Colour...");
-    backGround.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        backGround_actionPerformed(actionEvent);
-      }
-    });
-    seqColour.setSelected(false);
-    seqColour.setText("By Sequence");
-    seqColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        seqColour_actionPerformed(actionEvent);
-      }
-    });
-    chainColour.setText("By Chain");
-    chainColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        chainColour_actionPerformed(actionEvent);
-      }
-    });
-    chargeColour.setText("Charge & Cysteine");
-    chargeColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        chargeColour_actionPerformed(actionEvent);
-      }
-    });
-    zappoColour.setText("Zappo");
-    zappoColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        zappoColour_actionPerformed(actionEvent);
-      }
-    });
-    taylorColour.setText("Taylor");
-    taylorColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        taylorColour_actionPerformed(actionEvent);
-      }
-    });
-    hydroColour.setText("Hydro");
-    hydroColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        hydroColour_actionPerformed(actionEvent);
-      }
-    });
-    strandColour.setText("Strand");
-    strandColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        strandColour_actionPerformed(actionEvent);
-      }
-    });
-    helixColour.setText("Helix Propensity");
-    helixColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        helixColour_actionPerformed(actionEvent);
-      }
-    });
-    turnColour.setText("Turn Propensity");
-    turnColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        turnColour_actionPerformed(actionEvent);
+        viewMapping_actionPerformed();
       }
     });
-    buriedColour.setText("Buried Index");
-    buriedColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        buriedColour_actionPerformed(actionEvent);
-      }
-    });
-    userColour.setText("User Defined ...");
-    userColour.addActionListener(new ActionListener()
+
+    viewMenu = new JMenu();
+    viewMenu.setText(MessageManager.getString("action.view"));
+
+    chainMenu = new JMenu();
+    chainMenu.setText(MessageManager.getString("action.show_chain"));
+
+    fitToWindow = new JMenuItem();
+    fitToWindow.setText(MessageManager.getString("label.fit_to_window"));
+    fitToWindow.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        userColour_actionPerformed(actionEvent);
+        fitToWindow_actionPerformed();
       }
     });
-    jmolColour.setSelected(false);
-    jmolColour.setText("Colour with Jmol");
-    jmolColour.setToolTipText("Let Jmol manage structure colours.");
-    jmolColour.addActionListener(new ActionListener()
-    {
-      public void actionPerformed(ActionEvent actionEvent)
-      {
-        jmolColour_actionPerformed(actionEvent);
-      }
-    }
-    );
-    helpMenu.setText("Help");
-    jmolHelp.setText("Jmol Help");
-    jmolHelp.addActionListener(new ActionListener()
+
+    JMenu helpMenu = new JMenu();
+    helpMenu.setText(MessageManager.getString("action.help"));
+    helpItem = new JMenuItem();
+    helpItem.setText(MessageManager.getString("label.jmol_help"));
+    helpItem.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        jmolHelp_actionPerformed(actionEvent);
+        showHelp_actionPerformed();
       }
     });
-    alignStructs.setText("Align structures");
+    alignStructs = new JMenuItem();
+    alignStructs.setText(
+            MessageManager.getString("label.superpose_structures"));
     alignStructs.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent actionEvent)
       {
-        alignStructs_actionPerformed(actionEvent);
+        alignStructsWithAllAlignPanels();
       }
     });
-    jmolActionMenu.setText("Jmol");
-    menuBar.add(fileMenu);
-    menuBar.add(viewMenu);
-    menuBar.add(colourMenu);
-    menuBar.add(jmolActionMenu);
-    jmolActionMenu.setVisible(false);
-    menuBar.add(helpMenu);
+
+    viewerActionMenu = new JMenu(); // text set in sub-classes
+    viewerActionMenu.setVisible(false);
+    viewerActionMenu.add(alignStructs);
+    colourMenu = new JMenu();
+    colourMenu.setText(MessageManager.getString("label.colours"));
     fileMenu.add(savemenu);
     fileMenu.add(viewMapping);
     savemenu.add(pdbFile);
     savemenu.add(png);
     savemenu.add(eps);
     viewMenu.add(chainMenu);
+    helpMenu.add(helpItem);
 
-    colourMenu.add(seqColour);
-    colourMenu.add(chainColour);
-    colourMenu.add(chargeColour);
-    colourMenu.add(zappoColour);
-    colourMenu.add(taylorColour);
-    colourMenu.add(hydroColour);
-    colourMenu.add(helixColour);
-    colourMenu.add(strandColour);
-    colourMenu.add(turnColour);
-    colourMenu.add(buriedColour);
-    colourMenu.add(userColour);
-    colourMenu.add(jmolColour);
-    colourMenu.add(backGround);
-
-    colourButtons.add(seqColour);
-    colourButtons.add(chainColour);
-    colourButtons.add(chargeColour);
-    colourButtons.add(zappoColour);
-    colourButtons.add(taylorColour);
-    colourButtons.add(hydroColour);
-    colourButtons.add(helixColour);
-    colourButtons.add(strandColour);
-    colourButtons.add(turnColour);
-    colourButtons.add(buriedColour);
-    colourButtons.add(userColour);
-    colourButtons.add(jmolColour);
-
-    helpMenu.add(jmolHelp);
-    jmolActionMenu.add(alignStructs);
-  }
-
-  protected void jmolColour_actionPerformed(ActionEvent actionEvent)
-  {
-  }
-
-  protected void alignStructs_actionPerformed(ActionEvent actionEvent)
-  {
-  }
-
-  JMenuBar menuBar = new JMenuBar();
-
-  JMenu fileMenu = new JMenu();
-
-  JMenu savemenu = new JMenu();
-
-  JMenuItem pdbFile = new JMenuItem();
-
-  JMenuItem png = new JMenuItem();
-
-  JMenuItem eps = new JMenuItem();
-
-  JMenuItem viewMapping = new JMenuItem();
-
-  protected JMenu viewMenu = new JMenu();
-
-  protected JMenu chainMenu = new JMenu();
-
-  JMenu jMenu1 = new JMenu();
-
-  protected JMenu colourMenu = new JMenu();
-
-  protected JMenu jmolActionMenu = new JMenu();
-
-  protected JMenuItem alignStructs = new JMenuItem();
-
-  JMenuItem backGround = new JMenuItem();
-
-  protected JRadioButtonMenuItem seqColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem chainColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem chargeColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem zappoColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem taylorColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem hydroColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem strandColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem helixColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem turnColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem buriedColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem userColour = new JRadioButtonMenuItem();
-
-  protected JRadioButtonMenuItem jmolColour = new JRadioButtonMenuItem();
-
-  protected ButtonGroup colourButtons = new ButtonGroup();
-
-  JMenu helpMenu = new JMenu();
-
-  JMenuItem jmolHelp = new JMenuItem();
-
-  public void pdbFile_actionPerformed(ActionEvent actionEvent)
-  {
-
-  }
-
-  public void png_actionPerformed(ActionEvent actionEvent)
-  {
-
-  }
-
-  public void eps_actionPerformed(ActionEvent actionEvent)
-  {
-
-  }
-
-  public void viewMapping_actionPerformed(ActionEvent actionEvent)
-  {
-
-  }
-
-  public void seqColour_actionPerformed(ActionEvent actionEvent)
-  {
+    menuBar.add(fileMenu);
+    menuBar.add(viewMenu);
+    menuBar.add(colourMenu);
+    menuBar.add(viewerActionMenu);
+    menuBar.add(helpMenu);
 
+    statusPanel = new JPanel();
+    statusPanel.setLayout(new GridLayout());
+    this.getContentPane().add(statusPanel, BorderLayout.SOUTH);
+    statusBar = new JLabel();
+    statusPanel.add(statusBar, null);
   }
 
-  public void chainColour_actionPerformed(ActionEvent actionEvent)
+  protected void fitToWindow_actionPerformed()
   {
-
   }
 
-  public void chargeColour_actionPerformed(ActionEvent actionEvent)
+  protected void highlightSelection_actionPerformed()
   {
-
   }
 
-  public void zappoColour_actionPerformed(ActionEvent actionEvent)
+  protected void viewerColour_actionPerformed()
   {
-
   }
 
-  public void taylorColour_actionPerformed(ActionEvent actionEvent)
-  {
-
-  }
+  protected abstract String alignStructsWithAllAlignPanels();
 
-  public void hydroColour_actionPerformed(ActionEvent actionEvent)
+  public void pdbFile_actionPerformed()
   {
 
   }
 
-  public void helixColour_actionPerformed(ActionEvent actionEvent)
+  public void makePDBImage(TYPE imageType)
   {
 
   }
 
-  public void strandColour_actionPerformed(ActionEvent actionEvent)
+  public void viewMapping_actionPerformed()
   {
 
   }
 
-  public void turnColour_actionPerformed(ActionEvent actionEvent)
+  public void seqColour_actionPerformed()
   {
 
   }
 
-  public void buriedColour_actionPerformed(ActionEvent actionEvent)
+  public void chainColour_actionPerformed()
   {
 
   }
 
-  public void userColour_actionPerformed(ActionEvent actionEvent)
+  public void chargeColour_actionPerformed()
   {
 
   }
 
-  public void backGround_actionPerformed(ActionEvent actionEvent)
+  public void background_actionPerformed()
   {
 
   }
 
-  public void jmolHelp_actionPerformed(ActionEvent actionEvent)
+  public void showHelp_actionPerformed()
   {
 
   }