JAL-1355
[jalview.git] / src / jalview / gui / AppJmol.java
index 0e00de4..bab8a2d 100644 (file)
@@ -1,24 +1,28 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 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.gui;
 
 import java.util.*;
 import java.awt.*;
+
 import javax.swing.*;
 import javax.swing.event.*;
 
@@ -26,18 +30,20 @@ import java.awt.event.*;
 import java.io.*;
 
 import jalview.jbgui.GStructureViewer;
-import jalview.api.AlignmentViewPanel;
 import jalview.api.SequenceStructureBinding;
+import jalview.api.structures.JalviewStructureDisplayI;
 import jalview.bin.Cache;
 import jalview.datamodel.*;
 import jalview.gui.ViewSelectionMenu.ViewSetProvider;
-import jalview.structure.*;
 import jalview.datamodel.PDBEntry;
+import jalview.ext.jmol.JalviewJmolBinding;
 import jalview.io.*;
 import jalview.schemes.*;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
 
 public class AppJmol extends GStructureViewer implements Runnable,
-        SequenceStructureBinding, ViewSetProvider
+        ViewSetProvider, JalviewStructureDisplayI
 
 {
   AppJmolBinding jmb;
@@ -98,14 +104,16 @@ public class AppJmol extends GStructureViewer implements Runnable,
    *          - add the alignment panel to the list used for aligning these
    *          structures
    * @param leaveColouringToJmol
-   *          - do not update the colours from any other source. Jmol is handling them
+   *          - do not update the colours from any other source. Jmol is
+   *          handling them
    * @param loadStatus
    * @param bounds
    * @param viewid
    */
   public AppJmol(String[] files, String[] ids, SequenceI[][] seqs,
-          AlignmentPanel ap, boolean usetoColour, boolean useToAlign, boolean leaveColouringToJmol,
-          String loadStatus, Rectangle bounds, String viewid)
+          AlignmentPanel ap, boolean usetoColour, boolean useToAlign,
+          boolean leaveColouringToJmol, String loadStatus,
+          Rectangle bounds, String viewid)
   {
     PDBEntry[] pdbentrys = new PDBEntry[files.length];
     for (int i = 0; i < pdbentrys.length; i++)
@@ -117,7 +125,8 @@ public class AppJmol extends GStructureViewer implements Runnable,
     }
     // / TODO: check if protocol is needed to be set, and if chains are
     // autodiscovered.
-    jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(), pdbentrys, seqs, null, null);
+    jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(),
+            pdbentrys, seqs, null, null);
 
     jmb.setLoadingFromArchive(true);
     addAlignmentPanel(ap);
@@ -159,16 +168,16 @@ public class AppJmol extends GStructureViewer implements Runnable,
   {
     seqColour.setSelected(jmb.isColourBySequence());
     jmolColour.setSelected(!jmb.isColourBySequence());
-    if (_colourwith==null)
+    if (_colourwith == null)
     {
-      _colourwith=new Vector<AlignmentPanel>();
+      _colourwith = new Vector<AlignmentPanel>();
     }
-    if (_alignwith==null)
+    if (_alignwith == null)
     {
-      _alignwith=new Vector<AlignmentPanel>();
+      _alignwith = new Vector<AlignmentPanel>();
     }
-    
-    seqColourBy = new ViewSelectionMenu("Colour by ..", this, _colourwith,
+
+    seqColourBy = new ViewSelectionMenu(MessageManager.getString("label.colour_by"), this, _colourwith,
             new ItemListener()
             {
 
@@ -188,7 +197,7 @@ public class AppJmol extends GStructureViewer implements Runnable,
             });
     viewMenu.add(seqColourBy);
     final ItemListener handler;
-    JMenu alpanels = new ViewSelectionMenu("Superpose with ..", this,
+    JMenu alpanels = new ViewSelectionMenu(MessageManager.getString("label.superpose_with"), this,
             _alignwith, handler = new ItemListener()
             {
 
@@ -196,8 +205,11 @@ public class AppJmol extends GStructureViewer implements Runnable,
               public void itemStateChanged(ItemEvent e)
               {
                 alignStructs.setEnabled(_alignwith.size() > 0);
-                alignStructs.setToolTipText("Align structures using "
-                        + _alignwith.size() + " linked alignment views");
+                alignStructs.setToolTipText(MessageManager
+                        .formatMessage(
+                                "label.align_structures_using_linked_alignment_views",
+                                new String[]
+                                { new Integer(_alignwith.size()).toString() }));
               }
             });
     handler.itemStateChanged(null);
@@ -226,10 +238,12 @@ public class AppJmol extends GStructureViewer implements Runnable,
       }
     });
   }
+
   IProgressIndicator progressBar = null;
 
   /**
    * add a single PDB structure to a new or existing Jmol view
+   * 
    * @param pdbentry
    * @param seq
    * @param chains
@@ -241,22 +255,23 @@ public class AppJmol extends GStructureViewer implements Runnable,
     progressBar = ap.alignFrame;
     // ////////////////////////////////
     // Is the pdb file already loaded?
-    String alreadyMapped = ap.getStructureSelectionManager().alreadyMappedToFile(
-                    pdbentry.getId());
+    String alreadyMapped = ap.getStructureSelectionManager()
+            .alreadyMappedToFile(pdbentry.getId());
 
     if (alreadyMapped != null)
     {
       int option = JOptionPane.showInternalConfirmDialog(Desktop.desktop,
-              pdbentry.getId() + " is already displayed."
-                      + "\nDo you want to re-use this viewer ?",
-              "Map Sequences to Visible Window: " + pdbentry.getId(),
-              JOptionPane.YES_NO_OPTION);
+              MessageManager.formatMessage(
+                      "label.pdb_entry_is_already_displayed", new String[]
+                      { pdbentry.getId() }), MessageManager.formatMessage(
+                      "label.map_sequences_to_visible_window", new String[]
+                      { pdbentry.getId() }), JOptionPane.YES_NO_OPTION);
 
       if (option == JOptionPane.YES_OPTION)
       {
         // TODO : Fix multiple seq to one chain issue here.
-        ap.getStructureSelectionManager().setMapping(seq, chains, alreadyMapped,
-                        AppletFormatAdapter.FILE);
+        ap.getStructureSelectionManager().setMapping(seq, chains,
+                alreadyMapped, AppletFormatAdapter.FILE);
         if (ap.seqPanel.seqCanvas.fr != null)
         {
           ap.seqPanel.seqCanvas.fr.featuresAdded();
@@ -283,7 +298,8 @@ public class AppJmol extends GStructureViewer implements Runnable,
                 // add it to the set used for colouring
                 topJmol.useAlignmentPanelForColourbyseq(ap);
                 topJmol.buildJmolActionMenu();
-                ap.getStructureSelectionManager().sequenceColoursChanged(ap);
+                ap.getStructureSelectionManager()
+                        .sequenceColoursChanged(ap);
                 break;
               }
             }
@@ -304,11 +320,15 @@ public class AppJmol extends GStructureViewer implements Runnable,
       {
         AppJmol topJmol = (AppJmol) jm.nextElement();
         // TODO: highlight topJmol in view somehow
-        int option = JOptionPane.showInternalConfirmDialog(Desktop.desktop,
-                "Do you want to add " + pdbentry.getId()
-                        + " to the view called\n'" + topJmol.getTitle()
-                        + "'\n", "Align to existing structure view",
-                JOptionPane.YES_NO_OPTION);
+        int option = JOptionPane
+                .showInternalConfirmDialog(
+                        Desktop.desktop,
+                        MessageManager.formatMessage(
+                                "label.add_pdbentry_to_view", new String[]
+                                { pdbentry.getId(), topJmol.getTitle() }),
+                        MessageManager
+                                .getString("label.align_to_existing_structure_view"),
+                        JOptionPane.YES_NO_OPTION);
         if (option == JOptionPane.YES_OPTION)
         {
           topJmol.useAlignmentPanelForSuperposition(ap);
@@ -318,27 +338,33 @@ public class AppJmol extends GStructureViewer implements Runnable,
       }
     }
     // /////////////////////////////////
-    openNewJmol(ap, new PDBEntry[] { pdbentry }, new SequenceI[][] { seq });
+    openNewJmol(ap, new PDBEntry[]
+    { pdbentry }, new SequenceI[][]
+    { seq });
   }
-  private void openNewJmol(AlignmentPanel ap, PDBEntry[] pdbentrys, SequenceI[][] seqs) {
+
+  private void openNewJmol(AlignmentPanel ap, PDBEntry[] pdbentrys,
+          SequenceI[][] seqs)
+  {
     progressBar = ap.alignFrame;
-    jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(), pdbentrys, seqs, null, null);
+    jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(),
+            pdbentrys, seqs, null, null);
     addAlignmentPanel(ap);
     useAlignmentPanelForColourbyseq(ap);
-    if (pdbentrys.length>1)
+    if (pdbentrys.length > 1)
     {
-      alignAddedStructures=true;
+      alignAddedStructures = true;
       useAlignmentPanelForSuperposition(ap);
     }
     jmb.setColourBySequence(true);
     setSize(400, 400); // probably should be a configurable/dynamic default here
     initMenus();
-    worker=null;
-      {
-        addingStructures = false;
-        worker = new Thread(this);
-        worker.start();
-      }
+    worker = null;
+    {
+      addingStructures = false;
+      worker = new Thread(this);
+      worker.start();
+    }
     this.addInternalFrameListener(new InternalFrameAdapter()
     {
       public void internalFrameClosing(InternalFrameEvent internalFrameEvent)
@@ -350,7 +376,9 @@ public class AppJmol extends GStructureViewer implements Runnable,
   }
 
   /**
-   * create a new Jmol containing several structures superimposed using the given alignPanel.
+   * create a new Jmol containing several structures superimposed using the
+   * given alignPanel.
+   * 
    * @param ap
    * @param pe
    * @param seqs
@@ -461,13 +489,15 @@ public class AppJmol extends GStructureViewer implements Runnable,
     }
   }
 
-  public void useAlignmentPanelForColourbyseq(AlignmentPanel nap, boolean enableColourBySeq)
+  public void useAlignmentPanelForColourbyseq(AlignmentPanel nap,
+          boolean enableColourBySeq)
   {
     useAlignmentPanelForColourbyseq(nap);
     jmb.setColourBySequence(enableColourBySeq);
     seqColour.setSelected(enableColourBySeq);
     jmolColour.setSelected(!enableColourBySeq);
   }
+
   public void useAlignmentPanelForColourbyseq(AlignmentPanel nap)
   {
     addAlignmentPanel(nap);
@@ -588,9 +618,9 @@ public class AppJmol extends GStructureViewer implements Runnable,
     jmb.allocateViewer(renderPanel, true, "", null, null, "", scriptWindow,
             null);
     jmb.newJmolPopup(true, "Jmol", true);
-    if (command==null)
+    if (command == null)
     {
-      command="";
+      command = "";
     }
     jmb.evalStateCommand(command);
     jmb.setFinishedInit(true);
@@ -603,7 +633,8 @@ public class AppJmol extends GStructureViewer implements Runnable,
     {
       return;
     }
-    JMenuItem menuItem = new JMenuItem("All");
+    JMenuItem menuItem = new JMenuItem(
+            MessageManager.getString("label.all"));
     menuItem.addActionListener(new ActionListener()
     {
       public void actionPerformed(ActionEvent evt)
@@ -660,7 +691,7 @@ public class AppJmol extends GStructureViewer implements Runnable,
     jmb.centerViewer(toshow);
   }
 
-  void closeViewer()
+  public void closeViewer()
   {
     jmb.closeViewer();
     ap = null;
@@ -722,9 +753,11 @@ public class AppJmol extends GStructureViewer implements Runnable,
           {
             // just transfer the file name from the first sequence's first
             // PDBEntry
-            jmb.pdbentry[pi].setFile(file = ((PDBEntry) pdbseq
-                    .getSequenceAt(0).getPDBId().elementAt(0)).getFile());
-            files.append(" \"" + file + "\"");
+            file = new File(((PDBEntry) pdbseq.getSequenceAt(0).getPDBId()
+                    .elementAt(0)).getFile()).getAbsolutePath();
+            jmb.pdbentry[pi].setFile(file);
+
+            files.append(" \"" + Platform.escapeString(file) + "\"");
           }
           else
           {
@@ -747,7 +780,7 @@ public class AppJmol extends GStructureViewer implements Runnable,
           }
           if (file != null)
           {
-            files.append(" \"" + file + "\"");
+            files.append(" \"" + Platform.escapeString(file) + "\"");
           }
         }
       }
@@ -763,11 +796,12 @@ public class AppJmol extends GStructureViewer implements Runnable,
     if (errormsgs.length() > 0)
     {
 
-      JOptionPane.showInternalMessageDialog(Desktop.desktop,
-              "The following pdb entries could not be retrieved from the PDB:\n"
-                      + errormsgs.toString()
-                      + "\nPlease try downloading them manually.",
-              "Couldn't load file", JOptionPane.ERROR_MESSAGE);
+      JOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
+              .formatMessage("label.pdb_entries_couldnt_be_retrieved",
+                      new String[]
+                      { errormsgs.toString() }), MessageManager
+              .getString("label.couldnt_load_file"),
+              JOptionPane.ERROR_MESSAGE);
 
     }
     long lastnotify = jmb.getLoadNotifiesHandled();
@@ -797,7 +831,7 @@ public class AppJmol extends GStructureViewer implements Runnable,
         final String command = cmd.toString();
         cmd = null;
         lastnotify = jmb.getLoadNotifiesHandled();
-        
+
         try
         {
           jmb.evalStateCommand(command);
@@ -812,10 +846,11 @@ public class AppJmol extends GStructureViewer implements Runnable,
           Cache.log.error("Couldn't add files to Jmol viewer!", ex);
         }
       }
-    
+
       // need to wait around until script has finished
       while (addingStructures ? lastnotify >= jmb.getLoadNotifiesHandled()
-              : (jmb.isFinishedInit() && jmb.getPdbFile().length!=jmb.pdbentry.length))
+              : (jmb.isFinishedInit() && jmb.getPdbFile() != null && jmb
+                      .getPdbFile().length != jmb.pdbentry.length))
       {
         try
         {
@@ -857,7 +892,7 @@ public class AppJmol extends GStructureViewer implements Runnable,
 
     chooser.setFileView(new JalviewFileView());
     chooser.setDialogTitle("Save PDB File");
-    chooser.setToolTipText("Save");
+    chooser.setToolTipText(MessageManager.getString("action.save"));
 
     int value = chooser.showSaveDialog(this);
 
@@ -894,8 +929,7 @@ public class AppJmol extends GStructureViewer implements Runnable,
     {
       for (int pdbe = 0; pdbe < jmb.pdbentry.length; pdbe++)
       {
-        cap.appendText(jmb.printMapping(
-                        jmb.pdbentry[pdbe].getFile()));
+        cap.appendText(jmb.printMapping(jmb.pdbentry[pdbe].getFile()));
         cap.appendText("\n");
       }
     } catch (OutOfMemoryError e)
@@ -906,8 +940,9 @@ public class AppJmol extends GStructureViewer implements Runnable,
       cap.dispose();
       return;
     }
-    jalview.gui.Desktop.addInternalFrame(cap, "PDB - Sequence Mapping",
-            550, 600);
+    jalview.gui.Desktop.addInternalFrame(cap,
+            MessageManager.getString("label.pdb_sequence_mapping"), 550,
+            600);
   }
 
   /**
@@ -958,13 +993,16 @@ public class AppJmol extends GStructureViewer implements Runnable,
       im.writeImage();
     }
   }
+
   public void jmolColour_actionPerformed(ActionEvent actionEvent)
   {
-    if (jmolColour.isSelected()) {
+    if (jmolColour.isSelected())
+    {
       // disable automatic sequence colouring.
       jmb.setColourBySequence(false);
     }
   }
+
   public void seqColour_actionPerformed(ActionEvent actionEvent)
   {
     jmb.setColourBySequence(seqColour.isSelected());
@@ -976,7 +1014,8 @@ public class AppJmol extends GStructureViewer implements Runnable,
     {
       if (!jmb.isLoadingFromArchive())
       {
-        if (_colourwith.size()==0 && ap!=null) {
+        if (_colourwith.size() == 0 && ap != null)
+        {
           // Make the currently displayed alignment panel the associated view
           _colourwith.add(ap.alignFrame.alignPanel);
         }
@@ -1043,6 +1082,11 @@ public class AppJmol extends GStructureViewer implements Runnable,
     jmb.setJalviewColourScheme(new BuriedColourScheme());
   }
 
+  public void purinePyrimidineColour_actionPerformed(ActionEvent actionEvent)
+  {
+    setJalviewColourScheme(new PurinePyrimidineColourScheme());
+  }
+
   public void userColour_actionPerformed(ActionEvent actionEvent)
   {
     userColour.setSelected(true);
@@ -1120,7 +1164,8 @@ public class AppJmol extends GStructureViewer implements Runnable,
         g.fillRect(0, 0, currentSize.width, currentSize.height);
         g.setColor(Color.white);
         g.setFont(new Font("Verdana", Font.BOLD, 14));
-        g.drawString("Error loading file...", 20, currentSize.height / 2);
+        g.drawString(MessageManager.getString("label.error_loading_file")
+                + "...", 20, currentSize.height / 2);
         StringBuffer sb = new StringBuffer();
         int lines = 0;
         for (int e = 0; e < jmb.pdbentry.length; e++)
@@ -1145,7 +1190,8 @@ public class AppJmol extends GStructureViewer implements Runnable,
         g.fillRect(0, 0, currentSize.width, currentSize.height);
         g.setColor(Color.white);
         g.setFont(new Font("Verdana", Font.BOLD, 14));
-        g.drawString("Retrieving PDB data....", 20, currentSize.height / 2);
+        g.drawString(MessageManager.getString("label.retrieving_pdb_data"),
+                20, currentSize.height / 2);
       }
       else
       {
@@ -1311,7 +1357,11 @@ public class AppJmol extends GStructureViewer implements Runnable,
   public boolean isColouredByJmol()
   {
     return !jmb.isColourBySequence();
-    }
-  
+  }
+
+  public JalviewJmolBinding getBinding()
+  {
+    return jmb;
+  }
 
 }