/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * 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.gui;
-import java.util.regex.*;
-import java.util.*;
-import java.awt.*;
-import javax.swing.*;
-import javax.swing.event.*;
-import java.awt.event.*;
-import java.io.*;
-
-import jalview.jbgui.GStructureViewer;
import jalview.bin.Cache;
-import jalview.datamodel.*;
-import jalview.gui.*;
-import jalview.structure.*;
+import jalview.datamodel.AlignmentI;
import jalview.datamodel.PDBEntry;
-import jalview.io.*;
-import jalview.schemes.*;
-import jalview.ws.ebi.EBIFetchClient;
-
-import org.jmol.api.*;
-import org.jmol.adapter.smarter.SmarterJmolAdapter;
-import org.jmol.popup.*;
-import org.jmol.viewer.JmolConstants;
-
-public class AppJmol extends GStructureViewer implements StructureListener,
- JmolStatusListener, Runnable
-
+import jalview.datamodel.SequenceI;
+import jalview.gui.StructureViewer.ViewerType;
+import jalview.structures.models.AAStructureBindingModel;
+import jalview.util.BrowserLauncher;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.ws.dbsources.Pdb;
+
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.Graphics;
+import java.awt.Rectangle;
+import java.awt.event.ActionEvent;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Vector;
+
+import javax.swing.JCheckBoxMenuItem;
+import javax.swing.JPanel;
+import javax.swing.JSplitPane;
+import javax.swing.SwingUtilities;
+import javax.swing.event.InternalFrameAdapter;
+import javax.swing.event.InternalFrameEvent;
+
+public class AppJmol extends StructureViewerBase
{
- JmolViewer viewer;
-
- JmolPopup jmolpopup;
-
- ScriptWindow scriptWindow;
+ // ms to wait for Jmol to load files
+ private static final int JMOL_LOAD_TIMEOUT = 20000;
- PDBEntry pdbentry;
+ private static final String SPACE = " ";
- SequenceI[] sequence;
+ private static final String QUOTE = "\"";
- String[] chains;
+ AppJmolBinding jmb;
- StructureSelectionManager ssm;
+ JPanel scriptWindow;
JSplitPane splitPane;
RenderPanel renderPanel;
- AlignmentPanel ap;
-
- String fileLoadingError;
-
- boolean colourBySequence = true;
-
- boolean loadingFromArchive = false;
-
- Vector atomsPicked = new Vector();
-
- public AppJmol(String file, String id, SequenceI[] seq,
- AlignmentPanel ap, String loadStatus, Rectangle bounds)
- {
- this(file, id, seq, ap, loadStatus, bounds, null);
- }
-
- public AppJmol(String file, String id, SequenceI[] seq,
- AlignmentPanel ap, String loadStatus, Rectangle bounds,
+ /**
+ *
+ * @param files
+ * @param ids
+ * @param seqs
+ * @param ap
+ * @param usetoColour
+ * - add the alignment panel to the list used for colouring these
+ * structures
+ * @param useToAlign
+ * - 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
+ * @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)
{
- loadingFromArchive = true;
- pdbentry = new PDBEntry();
- pdbentry.setFile(file);
- pdbentry.setId(id);
- this.sequence = seq;
- this.ap = ap;
+ PDBEntry[] pdbentrys = new PDBEntry[files.length];
+ for (int i = 0; i < pdbentrys.length; i++)
+ {
+ // PDBEntry pdbentry = new PDBEntry(files[i], ids[i]);
+ PDBEntry pdbentry = new PDBEntry(ids[i], null, PDBEntry.Type.PDB,
+ files[i]);
+ pdbentrys[i] = pdbentry;
+ }
+ // / TODO: check if protocol is needed to be set, and if chains are
+ // autodiscovered.
+ jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(),
+ pdbentrys, seqs, null);
+
+ jmb.setLoadingFromArchive(true);
+ addAlignmentPanel(ap);
+ if (useToAlign)
+ {
+ useAlignmentPanelForSuperposition(ap);
+ }
+ initMenus();
+ if (leaveColouringToJmol || !usetoColour)
+ {
+ jmb.setColourBySequence(false);
+ seqColour.setSelected(false);
+ viewerColour.setSelected(true);
+ }
+ else if (usetoColour)
+ {
+ useAlignmentPanelForColourbyseq(ap);
+ jmb.setColourBySequence(true);
+ seqColour.setSelected(true);
+ viewerColour.setSelected(false);
+ }
this.setBounds(bounds);
- colourBySequence = false;
- seqColour.setSelected(false);
- viewId = viewid;
+ setViewId(viewid);
// jalview.gui.Desktop.addInternalFrame(this, "Loading File",
// bounds.width,bounds.height);
- initJmol(loadStatus);
-
this.addInternalFrameListener(new InternalFrameAdapter()
{
- public void internalFrameClosing(InternalFrameEvent internalFrameEvent)
+ @Override
+ public void internalFrameClosing(
+ InternalFrameEvent internalFrameEvent)
{
- closeViewer();
+ closeViewer(false);
}
});
+ initJmol(loadStatus); // pdbentry, seq, JBPCHECK!
}
- public synchronized void addSequence(SequenceI[] seq)
+ @Override
+ protected void initMenus()
{
- Vector v = new Vector();
- for (int i = 0; i < sequence.length; i++)
- v.addElement(sequence[i]);
+ super.initMenus();
- for (int i = 0; i < seq.length; i++)
- if (!v.contains(seq[i]))
- v.addElement(seq[i]);
+ viewerActionMenu.setText(MessageManager.getString("label.jmol"));
- SequenceI[] tmp = new SequenceI[v.size()];
- v.copyInto(tmp);
- sequence = tmp;
+ viewerColour
+ .setText(MessageManager.getString("label.colour_with_jmol"));
+ viewerColour.setToolTipText(MessageManager
+ .getString("label.let_jmol_manage_structure_colours"));
}
+ IProgressIndicator progressBar = null;
+
+ @Override
+ protected IProgressIndicator getIProgressIndicator()
+ {
+ return progressBar;
+ }
+
+ /**
+ * display a single PDB structure in a new Jmol view
+ *
+ * @param pdbentry
+ * @param seq
+ * @param chains
+ * @param ap
+ */
public AppJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains,
- AlignmentPanel ap)
+ final AlignmentPanel ap)
{
- // ////////////////////////////////
- // Is the pdb file already loaded?
- String alreadyMapped = StructureSelectionManager
- .getStructureSelectionManager().alreadyMappedToFile(
- pdbentry.getId());
-
- if (alreadyMapped != null)
- {
- int option = JOptionPane
- .showInternalConfirmDialog(
- Desktop.desktop,
- pdbentry.getId()
- + " is already displayed."
- + "\nDo you want to map sequences to the visible structure?",
- "Map Sequences to Visible Window: "
- + pdbentry.getId(), JOptionPane.YES_NO_OPTION);
-
- if (option == JOptionPane.YES_OPTION)
- {
- StructureSelectionManager.getStructureSelectionManager()
- .setMapping(seq, chains, alreadyMapped,
- AppletFormatAdapter.FILE);
- if (ap.seqPanel.seqCanvas.fr != null)
- {
- ap.seqPanel.seqCanvas.fr.featuresAdded();
- ap.paintAlignment(true);
- }
+ progressBar = ap.alignFrame;
- // Now this AppJmol is mapped to new sequences. We must add them to
- // the exisiting array
- JInternalFrame[] frames = Desktop.instance.getAllFrames();
-
- for (int i = 0; i < frames.length; i++)
- {
- if (frames[i] instanceof AppJmol)
- {
- AppJmol topJmol = ((AppJmol) frames[i]);
- if (topJmol.pdbentry.getFile().equals(alreadyMapped))
- {
- topJmol.addSequence(seq);
- break;
- }
- }
- }
+ openNewJmol(ap, alignAddedStructures, new PDBEntry[] { pdbentry },
+ new SequenceI[][]
+ { seq });
+ }
- return;
- }
- }
- // /////////////////////////////////
+ private void openNewJmol(AlignmentPanel ap, boolean alignAdded,
+ PDBEntry[] pdbentrys,
+ SequenceI[][] seqs)
+ {
+ progressBar = ap.alignFrame;
+ jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(),
+ pdbentrys, seqs, null);
+ addAlignmentPanel(ap);
+ useAlignmentPanelForColourbyseq(ap);
- this.ap = ap;
- this.pdbentry = pdbentry;
- this.sequence = seq;
- this.setSize(400, 400);
- // jalview.gui.Desktop.addInternalFrame(this, "Jmol
- // View"+(pdbentry.getId()!=null ? "for "+pdbentry.getId()
- // : ""), 400, 400);
+ alignAddedStructures = alignAdded;
+ useAlignmentPanelForSuperposition(ap);
- if (pdbentry.getFile() != null)
- {
- initJmol("load \"" + pdbentry.getFile() + "\"");
- }
- else
- {
- Thread worker = new Thread(this);
- worker.start();
- }
+ jmb.setColourBySequence(true);
+ setSize(400, 400); // probably should be a configurable/dynamic default here
+ initMenus();
+ addingStructures = false;
+ worker = new Thread(this);
+ worker.start();
this.addInternalFrameListener(new InternalFrameAdapter()
{
- public void internalFrameClosing(InternalFrameEvent internalFrameEvent)
+ @Override
+ public void internalFrameClosing(
+ InternalFrameEvent internalFrameEvent)
{
- closeViewer();
+ closeViewer(false);
}
});
+
+ }
+
+ /**
+ * create a new Jmol containing several structures optionally superimposed
+ * using the given alignPanel.
+ *
+ * @param ap
+ * @param alignAdded
+ * - true to superimpose
+ * @param pe
+ * @param seqs
+ */
+ public AppJmol(AlignmentPanel ap, boolean alignAdded, PDBEntry[] pe,
+ SequenceI[][] seqs)
+ {
+ openNewJmol(ap, alignAdded, pe, seqs);
}
+
void initJmol(String command)
{
+ jmb.setFinishedInit(false);
renderPanel = new RenderPanel();
-
+ // TODO: consider waiting until the structure/view is fully loaded before
+ // displaying
this.getContentPane().add(renderPanel, java.awt.BorderLayout.CENTER);
-
- StringBuffer title = new StringBuffer(sequence[0].getName() + ":"
- + pdbentry.getId());
-
- if (pdbentry.getProperty() != null)
- {
- if (pdbentry.getProperty().get("method") != null)
- {
- title.append(" Method: ");
- title.append(pdbentry.getProperty().get("method"));
- }
- if (pdbentry.getProperty().get("chains") != null)
- {
- title.append(" Chain:");
- title.append(pdbentry.getProperty().get("chains"));
- }
- }
-
- this.setTitle(title.toString());
- jalview.gui.Desktop.addInternalFrame(this, title.toString(),
+ jalview.gui.Desktop.addInternalFrame(this, jmb.getViewerTitle(),
getBounds().width, getBounds().height);
- // * OK, but safer to assign htmlName, URL bases, comandOptions, and
- // statusListener now.
-
- viewer = org.jmol.api.JmolViewer.allocateViewer(renderPanel,
- new SmarterJmolAdapter(), "", null, null, "", this);
-
- jmolpopup = JmolPopup.newJmolPopup(viewer, true, "Jmol", true);
-
- viewer.evalStringQuiet(command);
- }
-
- void setChainMenuItems(Vector chains)
- {
- chainMenu.removeAll();
-
- JMenuItem menuItem = new JMenuItem("All");
- menuItem.addActionListener(new ActionListener()
+ if (scriptWindow == null)
{
- public void actionPerformed(ActionEvent evt)
- {
- allChainsSelected = true;
- for (int i = 0; i < chainMenu.getItemCount(); i++)
- {
- if (chainMenu.getItem(i) instanceof JCheckBoxMenuItem)
- ((JCheckBoxMenuItem) chainMenu.getItem(i)).setSelected(true);
- }
- centerViewer();
- allChainsSelected = false;
- }
- });
-
- chainMenu.add(menuItem);
+ BorderLayout bl = new BorderLayout();
+ bl.setHgap(0);
+ bl.setVgap(0);
+ scriptWindow = new JPanel(bl);
+ scriptWindow.setVisible(false);
+ }
- for (int c = 0; c < chains.size(); c++)
+ jmb.allocateViewer(renderPanel, true, "", null, null, "", scriptWindow,
+ null);
+ // jmb.newJmolPopup("Jmol");
+ if (command == null)
{
- menuItem = new JCheckBoxMenuItem(chains.elementAt(c).toString(), true);
- menuItem.addItemListener(new ItemListener()
- {
- public void itemStateChanged(ItemEvent evt)
- {
- if (!allChainsSelected)
- centerViewer();
- }
- });
-
- chainMenu.add(menuItem);
+ command = "";
}
+ jmb.evalStateCommand(command);
+ jmb.evalStateCommand("set hoverDelay=0.1");
+ jmb.setFinishedInit(true);
}
- boolean allChainsSelected = false;
-
- void centerViewer()
+ @Override
+ void showSelectedChains()
{
- StringBuffer cmd = new StringBuffer();
+ Vector<String> toshow = new Vector<>();
for (int i = 0; i < chainMenu.getItemCount(); i++)
{
if (chainMenu.getItem(i) instanceof JCheckBoxMenuItem)
{
JCheckBoxMenuItem item = (JCheckBoxMenuItem) chainMenu.getItem(i);
if (item.isSelected())
- cmd.append(":" + item.getText() + " or ");
+ {
+ toshow.addElement(item.getText());
+ }
}
}
-
- if (cmd.length() > 0)
- cmd.setLength(cmd.length() - 4);
-
- viewer.evalStringQuiet("select *;restrict " + cmd + ";cartoon;center "
- + cmd);
+ jmb.centerViewer(toshow);
}
- void closeViewer()
+ @Override
+ public void closeViewer(boolean closeExternalViewer)
{
- viewer.setModeMouse(org.jmol.viewer.JmolConstants.MOUSE_NONE);
- viewer.evalStringQuiet("zap");
- viewer.setJmolStatusListener(null);
- viewer = null;
-
- // We'll need to find out what other
- // listeners need to be shut down in Jmol
- StructureSelectionManager.getStructureSelectionManager()
- .removeStructureViewerListener(this, pdbentry.getFile());
+ // Jmol does not use an external viewer
+ if (jmb != null)
+ {
+ jmb.closeViewer();
+ }
+ setAlignmentPanel(null);
+ _aps.clear();
+ _alignwith.clear();
+ _colourwith.clear();
+ // TODO: check for memory leaks where instance isn't finalised because jmb
+ // holds a reference to the window
+ jmb = null;
}
+ @Override
public void run()
{
+ _started = true;
try
{
- // TODO: replace with reference fetching/transfer code (validate PDBentry
- // as a DBRef?)
- jalview.ws.dbsources.Pdb pdbclient = new jalview.ws.dbsources.Pdb();
- AlignmentI pdbseq;
- if ((pdbseq = pdbclient.getSequenceRecords(pdbentry.getId())) != null)
+ List<String> files = fetchPdbFiles();
+ if (files.size() > 0)
{
- // just transfer the file name from the first seuqence's first PDBEntry
- pdbentry.setFile(((PDBEntry) pdbseq.getSequenceAt(0).getPDBId()
- .elementAt(0)).getFile());
- initJmol("load " + pdbentry.getFile());
+ showFilesInViewer(files);
}
- else
- {
- JOptionPane
- .showInternalMessageDialog(
- Desktop.desktop,
- pdbentry.getId()
- + " could not be retrieved. Please try downloading the file manually.",
- "Couldn't load file", JOptionPane.ERROR_MESSAGE);
-
- }
- } catch (OutOfMemoryError oomerror)
+ } finally
{
- new OOMWarning("Retrieving PDB id " + pdbentry.getId() + " from MSD",
- oomerror);
- } catch (Exception ex)
- {
- ex.printStackTrace();
+ _started = false;
+ worker = null;
}
}
- public void pdbFile_actionPerformed(ActionEvent actionEvent)
+ /**
+ * Either adds the given files to a structure viewer or opens a new viewer to
+ * show them
+ *
+ * @param files
+ * list of absolute paths to structure files
+ */
+ void showFilesInViewer(List<String> files)
{
- JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache
- .getProperty("LAST_DIRECTORY"));
-
- chooser.setFileView(new JalviewFileView());
- chooser.setDialogTitle("Save PDB File");
- chooser.setToolTipText("Save");
-
- int value = chooser.showSaveDialog(this);
+ long lastnotify = jmb.getLoadNotifiesHandled();
+ StringBuilder fileList = new StringBuilder();
+ for (String s : files)
+ {
+ fileList.append(SPACE).append(QUOTE)
+ .append(Platform.escapeBackslashes(s)).append(QUOTE);
+ }
+ String filesString = fileList.toString();
- if (value == JalviewFileChooser.APPROVE_OPTION)
+ if (!addingStructures)
{
try
{
- BufferedReader in = new BufferedReader(new FileReader(pdbentry
- .getFile()));
- File outFile = chooser.getSelectedFile();
-
- PrintWriter out = new PrintWriter(new FileOutputStream(outFile));
- String data;
- while ((data = in.readLine()) != null)
- {
- if (!(data.indexOf("<PRE>") > -1 || data.indexOf("</PRE>") > -1))
- {
- out.println(data);
- }
- }
- out.close();
+ initJmol("load FILES " + filesString);
+ } catch (OutOfMemoryError oomerror)
+ {
+ new OOMWarning("When trying to open the Jmol viewer!", oomerror);
+ Cache.log.debug("File locations are " + filesString);
} catch (Exception ex)
{
- ex.printStackTrace();
+ Cache.log.error("Couldn't open Jmol viewer!", ex);
}
}
- }
-
- public void viewMapping_actionPerformed(ActionEvent actionEvent)
- {
- jalview.gui.CutAndPasteTransfer cap = new jalview.gui.CutAndPasteTransfer();
- jalview.gui.Desktop.addInternalFrame(cap, "PDB - Sequence Mapping",
- 550, 600);
- cap.setText(StructureSelectionManager.getStructureSelectionManager()
- .printMapping(pdbentry.getFile()));
- }
-
- /**
- * DOCUMENT ME!
- *
- * @param e
- * DOCUMENT ME!
- */
- public void eps_actionPerformed(ActionEvent e)
- {
- makePDBImage(jalview.util.ImageMaker.EPS);
- }
-
- /**
- * DOCUMENT ME!
- *
- * @param e
- * DOCUMENT ME!
- */
- public void png_actionPerformed(ActionEvent e)
- {
- makePDBImage(jalview.util.ImageMaker.PNG);
- }
-
- void makePDBImage(int type)
- {
- int width = getWidth();
- int height = getHeight();
-
- jalview.util.ImageMaker im;
-
- if (type == jalview.util.ImageMaker.PNG)
- {
- im = new jalview.util.ImageMaker(this, jalview.util.ImageMaker.PNG,
- "Make PNG image from view", width, height, null, null);
- }
else
{
- im = new jalview.util.ImageMaker(this, jalview.util.ImageMaker.EPS,
- "Make EPS file from view", width, height, null, this
- .getTitle());
- }
-
- if (im.getGraphics() != null)
- {
- Rectangle rect = new Rectangle(width, height);
- viewer.renderScreenImage(im.getGraphics(), rect.getSize(), rect);
- im.writeImage();
- }
- }
-
- public void seqColour_actionPerformed(ActionEvent actionEvent)
- {
- lastCommand = null;
- colourBySequence = seqColour.isSelected();
- colourBySequence(ap.alignFrame.alignPanel);
- }
-
- public void chainColour_actionPerformed(ActionEvent actionEvent)
- {
- colourBySequence = false;
- seqColour.setSelected(false);
- viewer.evalStringQuiet("select *;color chain");
- }
-
- public void chargeColour_actionPerformed(ActionEvent actionEvent)
- {
- colourBySequence = false;
- seqColour.setSelected(false);
- viewer.evalStringQuiet("select *;color white;select ASP,GLU;color red;"
- + "select LYS,ARG;color blue;select CYS;color yellow");
- }
-
- public void zappoColour_actionPerformed(ActionEvent actionEvent)
- {
- setJalviewColourScheme(new ZappoColourScheme());
- }
-
- public void taylorColour_actionPerformed(ActionEvent actionEvent)
- {
- setJalviewColourScheme(new TaylorColourScheme());
- }
-
- public void hydroColour_actionPerformed(ActionEvent actionEvent)
- {
- setJalviewColourScheme(new HydrophobicColourScheme());
- }
-
- public void helixColour_actionPerformed(ActionEvent actionEvent)
- {
- setJalviewColourScheme(new HelixColourScheme());
- }
-
- public void strandColour_actionPerformed(ActionEvent actionEvent)
- {
- setJalviewColourScheme(new StrandColourScheme());
- }
-
- public void turnColour_actionPerformed(ActionEvent actionEvent)
- {
- setJalviewColourScheme(new TurnColourScheme());
- }
-
- public void buriedColour_actionPerformed(ActionEvent actionEvent)
- {
- setJalviewColourScheme(new BuriedColourScheme());
- }
-
- public void setJalviewColourScheme(ColourSchemeI cs)
- {
- colourBySequence = false;
- seqColour.setSelected(false);
-
- if (cs == null)
- return;
-
- String res;
- int index;
- Color col;
-
- Enumeration en = ResidueProperties.aa3Hash.keys();
- StringBuffer command = new StringBuffer("select *;color white;");
- while (en.hasMoreElements())
- {
- res = en.nextElement().toString();
- index = ((Integer) ResidueProperties.aa3Hash.get(res)).intValue();
- if (index > 20)
- continue;
-
- col = cs.findColour(ResidueProperties.aa[index].charAt(0));
-
- command.append("select " + res + ";color[" + col.getRed() + ","
- + col.getGreen() + "," + col.getBlue() + "];");
- }
-
- viewer.evalStringQuiet(command.toString());
- }
-
- public void userColour_actionPerformed(ActionEvent actionEvent)
- {
- new UserDefinedColours(this, null);
- }
-
- public void backGround_actionPerformed(ActionEvent actionEvent)
- {
- java.awt.Color col = JColorChooser.showDialog(this,
- "Select Background Colour", null);
-
- if (col != null)
- {
- viewer.evalStringQuiet("background [" + col.getRed() + ","
- + col.getGreen() + "," + col.getBlue() + "];");
- }
- }
-
- public void jmolHelp_actionPerformed(ActionEvent actionEvent)
- {
- try
- {
- jalview.util.BrowserLauncher
- .openURL("http://jmol.sourceforge.net/docs/JmolUserGuide/");
- } catch (Exception ex)
- {
- }
- }
-
- // ////////////////////////////////
- // /StructureListener
- public String getPdbFile()
- {
- return pdbentry.getFile();
- }
-
- Pattern pattern = Pattern
- .compile("\\[(.*)\\]([0-9]+)(:[a-zA-Z]*)?\\.([a-zA-Z]+)(/[0-9]*)?");
+ StringBuilder cmd = new StringBuilder();
+ cmd.append("loadingJalviewdata=true\nload APPEND ");
+ cmd.append(filesString);
+ cmd.append("\nloadingJalviewdata=null");
+ final String command = cmd.toString();
+ lastnotify = jmb.getLoadNotifiesHandled();
- String lastMessage;
-
- public void mouseOverStructure(int atomIndex, String strInfo)
- {
- Matcher matcher = pattern.matcher(strInfo);
- matcher.find();
- matcher.group(1);
- int pdbResNum = Integer.parseInt(matcher.group(2));
- String chainId = matcher.group(3);
-
- if (chainId != null)
- chainId = chainId.substring(1, chainId.length());
- else
- {
- chainId = " ";
+ try
+ {
+ jmb.evalStateCommand(command);
+ } catch (OutOfMemoryError oomerror)
+ {
+ new OOMWarning("When trying to add structures to the Jmol viewer!",
+ oomerror);
+ Cache.log.debug("File locations are " + filesString);
+ } catch (Exception ex)
+ {
+ Cache.log.error("Couldn't add files to Jmol viewer!", ex);
+ }
}
- if (lastMessage == null || !lastMessage.equals(strInfo))
+ // need to wait around until script has finished
+ int waitMax = JMOL_LOAD_TIMEOUT;
+ int waitFor = 35;
+ int waitTotal = 0;
+ while (addingStructures ? lastnotify >= jmb.getLoadNotifiesHandled()
+ : !(jmb.isFinishedInit() && jmb.getStructureFiles() != null
+ && jmb.getStructureFiles().length == files.size()))
{
- ssm.mouseOverStructure(pdbResNum, chainId, pdbentry.getFile());
+ try
+ {
+ Cache.log.debug("Waiting around for jmb notify.");
+ Thread.sleep(waitFor);
+ waitTotal += waitFor;
+ } catch (Exception e)
+ {
+ }
+ if (waitTotal > waitMax)
+ {
+ System.err.println("Timed out waiting for Jmol to load files after "
+ + waitTotal + "ms");
+ // System.err.println("finished: " + jmb.isFinishedInit()
+ // + "; loaded: " + Arrays.toString(jmb.getPdbFile())
+ // + "; files: " + files.toString());
+ jmb.getStructureFiles();
+ break;
+ }
}
- lastMessage = strInfo;
- }
-
- StringBuffer resetLastRes = new StringBuffer();
- StringBuffer eval = new StringBuffer();
-
- public void highlightAtom(int atomIndex, int pdbResNum, String chain,
- String pdbfile)
- {
- // TODO: rna: remove CA dependency in select string
- if (!pdbfile.equals(pdbentry.getFile()))
- return;
-
- if (resetLastRes.length() > 0)
+ // refresh the sequence colours for the new structure(s)
+ for (AlignmentPanel ap : _colourwith)
{
- viewer.evalStringQuiet(resetLastRes.toString());
+ jmb.updateColours(ap);
}
-
- eval.setLength(0);
- eval.append("select " + pdbResNum);
-
- resetLastRes.setLength(0);
- resetLastRes.append("select " + pdbResNum);
-
- eval.append(":");
- resetLastRes.append(":");
- if (!chain.equals(" "))
+ // do superposition if asked to
+ if (alignAddedStructures)
{
- eval.append(chain);
- resetLastRes.append(chain);
+ alignAddedStructures();
}
-
- eval.append(";wireframe 100;" + eval.toString() + " and not hetero;"); // ".*;");
-
- resetLastRes.append(";wireframe 0;" + resetLastRes.toString()
- // + ".*;spacefill 0;");
- + " and not hetero;spacefill 0;");
-
- eval.append("spacefill 200;select none");
- // System.out.println("jmol:\n"+eval+"\n");
- viewer.evalStringQuiet(eval.toString());
- }
-
- public Color getColour(int atomIndex, int pdbResNum, String chain,
- String pdbfile)
- {
- if (!pdbfile.equals(pdbentry.getFile()))
- return null;
-
- return new Color(viewer.getAtomArgb(atomIndex));
+ addingStructures = false;
}
- public void updateColours(Object source)
- {
- colourBySequence((AlignmentPanel) source);
- }
-
- // End StructureListener
- // //////////////////////////
-
- String lastCommand;
-
- FeatureRenderer fr = null;
-
- public void colourBySequence(AlignmentPanel sourceap)
+ /**
+ * Queues a thread to align structures with Jalview alignments
+ */
+ void alignAddedStructures()
{
- this.ap = sourceap;
-
- if (!colourBySequence || ap.alignFrame.getCurrentView() != ap.av)
- return;
-
- StructureMapping[] mapping = ssm.getMapping(pdbentry.getFile());
-
- if (mapping.length < 1)
- return;
-
- SequenceRenderer sr = new SequenceRenderer(ap.av);
-
- boolean showFeatures = false;
-
- if (ap.av.showSequenceFeatures)
+ javax.swing.SwingUtilities.invokeLater(new Runnable()
{
- showFeatures = true;
- if (fr == null)
+ @Override
+ public void run()
{
- fr = new jalview.gui.FeatureRenderer(ap);
+ if (jmb.viewer.isScriptExecuting())
+ {
+ SwingUtilities.invokeLater(this);
+ try
+ {
+ Thread.sleep(5);
+ } catch (InterruptedException q)
+ {
+ }
+ return;
+ }
+ else
+ {
+ alignStructs_withAllAlignPanels();
+ }
}
+ });
- fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer());
- }
+ }
- StringBuffer command = new StringBuffer();
+ /**
+ * Retrieves and saves as file any modelled PDB entries for which we do not
+ * already have a file saved. Returns a list of absolute paths to structure
+ * files which were either retrieved, or already stored but not modelled in
+ * the structure viewer (i.e. files to add to the viewer display).
+ *
+ * @return
+ */
+ List<String> fetchPdbFiles()
+ {
+ // todo - record which pdbids were successfully imported.
+ StringBuilder errormsgs = new StringBuilder();
- int lastPos = -1;
- for (int sp, s = 0; s < sequence.length; s++)
+ List<String> files = new ArrayList<>();
+ String pdbid = "";
+ try
{
- for (int m = 0; m < mapping.length; m++)
+ String[] filesInViewer = jmb.getStructureFiles();
+ // TODO: replace with reference fetching/transfer code (validate PDBentry
+ // as a DBRef?)
+ Pdb pdbclient = new Pdb();
+ for (int pi = 0; pi < jmb.getPdbCount(); pi++)
{
- if (mapping[m].getSequence() == sequence[s]
- && (sp = ap.av.alignment.findIndex(sequence[s])) > -1)
+ String file = jmb.getPdbEntry(pi).getFile();
+ if (file == null)
{
- SequenceI asp = ap.av.alignment.getSequenceAt(sp);
- for (int r = 0; r < asp.getLength(); r++)
+ // todo: extract block as method and pull up (also ChimeraViewFrame)
+ // retrieve the pdb and store it locally
+ AlignmentI pdbseq = null;
+ pdbid = jmb.getPdbEntry(pi).getId();
+ long hdl = pdbid.hashCode() - System.currentTimeMillis();
+ if (progressBar != null)
{
- // No mapping to gaps in sequence.
- if (jalview.util.Comparison.isGap(asp.getCharAt(r)))
- {
- continue;
- }
- int pos = mapping[m].getPDBResNum(asp.findPosition(r));
-
- if (pos < 1 || pos == lastPos)
- continue;
-
- lastPos = pos;
-
- Color col = sr.getResidueBoxColour(asp, r);
-
- if (showFeatures)
- col = fr.findFeatureColour(col, asp, r);
-
- if (command.toString().endsWith(
- ":" + mapping[m].getChain() + ";color[" + col.getRed()
- + "," + col.getGreen() + "," + col.getBlue()
- + "]"))
+ progressBar.setProgressBar(MessageManager
+ .formatMessage("status.fetching_pdb", new String[]
+ { pdbid }), hdl);
+ }
+ try
+ {
+ pdbseq = pdbclient.getSequenceRecords(pdbid);
+ } catch (OutOfMemoryError oomerror)
+ {
+ new OOMWarning("Retrieving PDB id " + pdbid, oomerror);
+ } catch (Exception ex)
+ {
+ ex.printStackTrace();
+ errormsgs.append("'").append(pdbid).append("'");
+ } finally
+ {
+ if (progressBar != null)
{
- command = condenseCommand(command, pos);
- continue;
+ progressBar.setProgressBar(
+ MessageManager.getString("label.state_completed"),
+ hdl);
}
-
- command.append(";select " + pos);
-
- if (!mapping[m].getChain().equals(" "))
+ }
+ if (pdbseq != null)
+ {
+ // just transfer the file name from the first sequence's first
+ // PDBEntry
+ file = new File(pdbseq.getSequenceAt(0).getAllPDBEntries()
+ .elementAt(0).getFile()).getAbsolutePath();
+ jmb.getPdbEntry(pi).setFile(file);
+ files.add(file);
+ }
+ else
+ {
+ errormsgs.append("'").append(pdbid).append("' ");
+ }
+ }
+ else
+ {
+ if (filesInViewer != null && filesInViewer.length > 0)
+ {
+ addingStructures = true; // already files loaded.
+ for (int c = 0; c < filesInViewer.length; c++)
{
- command.append(":" + mapping[m].getChain());
+ if (Platform.pathEquals(filesInViewer[c], file))
+ {
+ file = null;
+ break;
+ }
}
-
- command.append(";color[" + col.getRed() + "," + col.getGreen()
- + "," + col.getBlue() + "]");
-
}
- break;
+ if (file != null)
+ {
+ files.add(file);
+ }
}
}
- }
-
- if (lastCommand == null || !lastCommand.equals(command.toString()))
+ } catch (OutOfMemoryError oomerror)
{
- viewer.evalStringQuiet(command.toString());
- }
- lastCommand = command.toString();
- }
-
- StringBuffer condenseCommand(StringBuffer command, int pos)
- {
- StringBuffer sb = new StringBuffer(command.substring(0, command
- .lastIndexOf("select") + 7));
-
- command.delete(0, sb.length());
-
- String start;
-
- if (command.indexOf("-") > -1)
+ new OOMWarning("Retrieving PDB files: " + pdbid, oomerror);
+ } catch (Exception ex)
{
- start = command.substring(0, command.indexOf("-"));
+ ex.printStackTrace();
+ errormsgs.append("When retrieving pdbfiles : current was: '")
+ .append(pdbid).append("'");
}
- else
+ if (errormsgs.length() > 0)
{
- start = command.substring(0, command.indexOf(":"));
+ JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+ MessageManager.formatMessage(
+ "label.pdb_entries_couldnt_be_retrieved", new String[]
+ { errormsgs.toString() }),
+ MessageManager.getString("label.couldnt_load_file"),
+ JvOptionPane.ERROR_MESSAGE);
}
-
- sb.append(start + "-" + pos + command.substring(command.indexOf(":")));
-
- return sb;
+ return files;
}
- // ///////////////////////////////
- // JmolStatusListener
-
- public String eval(String strEval)
- {
- // System.out.println(strEval);
- // "# 'eval' is implemented only for the applet.";
- return null;
- }
-
- public void createImage(String file, String type, int quality)
- {
- System.out.println("JMOL CREATE IMAGE");
- }
-
- public void notifyFileLoaded(String fullPathName, String fileName,
- String modelName, String errorMsg, int modelParts)
- {
- if (errorMsg != null)
- {
- fileLoadingError = errorMsg;
- repaint();
- return;
- }
-
- fileLoadingError = null;
-
- if (fileName != null)
- {
- // TODO: do some checking using the modelPts number of parts against our own estimate of the number of chains
- // FILE LOADED OK
- ssm = StructureSelectionManager.getStructureSelectionManager();
- MCview.PDBfile pdbFile = ssm.setMapping(sequence, chains, pdbentry
- .getFile(), AppletFormatAdapter.FILE);
- ssm.addStructureViewerListener(this);
- Vector chains = new Vector();
- for (int i = 0; i < pdbFile.chains.size(); i++)
- {
- chains
- .addElement(((MCview.PDBChain) pdbFile.chains.elementAt(i)).id);
- }
- setChainMenuItems(chains);
-
- jmolpopup.updateComputedMenus();
-
- if (!loadingFromArchive)
- {
- viewer
- .evalStringQuiet("select backbone;restrict;cartoon;wireframe off;spacefill off");
-
- colourBySequence(ap);
- }
- if (fr != null)
- fr.featuresAdded();
-
- loadingFromArchive = false;
- }
- else
- return;
- }
-
- public void sendConsoleEcho(String strEcho)
- {
- if (scriptWindow != null)
- scriptWindow.sendConsoleEcho(strEcho);
- }
-
- public void sendConsoleMessage(String strStatus)
+ @Override
+ public void eps_actionPerformed(ActionEvent e)
{
- if (scriptWindow != null)
- scriptWindow.sendConsoleMessage(strStatus);
+ makePDBImage(jalview.util.ImageMaker.TYPE.EPS);
}
- public void notifyScriptTermination(String strStatus, int msWalltime)
+ @Override
+ public void png_actionPerformed(ActionEvent e)
{
- if (scriptWindow != null)
- scriptWindow.notifyScriptTermination(strStatus, msWalltime);
+ makePDBImage(jalview.util.ImageMaker.TYPE.PNG);
}
- public void handlePopupMenu(int x, int y)
+ void makePDBImage(jalview.util.ImageMaker.TYPE type)
{
- jmolpopup.show(x, y);
- }
+ int width = getWidth();
+ int height = getHeight();
- public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
- {
- notifyAtomPicked(iatom, strMeasure, null);
- }
+ jalview.util.ImageMaker im;
- public void notifyAtomPicked(int atomIndex, String strInfo, String strData)
- {
- if (strData!=null)
+ if (type == jalview.util.ImageMaker.TYPE.PNG)
{
- Cache.log.info("Non null pick data string: "+strData+" (other info: '"+strInfo+"' pos "+atomIndex+")");
+ im = new jalview.util.ImageMaker(this,
+ jalview.util.ImageMaker.TYPE.PNG, "Make PNG image from view",
+ width, height, null, null, null, 0, false);
}
- Matcher matcher = pattern.matcher(strInfo);
- matcher.find();
-
- matcher.group(1);
- String resnum = new String(matcher.group(2));
- String chainId = matcher.group(3);
-
- String picked = resnum;
-
- if (chainId != null)
- picked += (":" + chainId.substring(1, chainId.length()));
-
- picked = "(("+picked+".CA" + ")|("+picked+".P"+"))";
-
- if (!atomsPicked.contains(picked))
+ else if (type == jalview.util.ImageMaker.TYPE.EPS)
{
- if (chainId != null)
- viewer.evalString("select " + picked + ";label %n %r:%c");
- else
- viewer.evalString("select " + picked + ";label %n %r");
- atomsPicked.addElement(picked);
+ im = new jalview.util.ImageMaker(this,
+ jalview.util.ImageMaker.TYPE.EPS, "Make EPS file from view",
+ width, height, null, this.getTitle(), null, 0, false);
}
else
{
- viewer.evalString("select " + picked + ";label off");
- atomsPicked.removeElement(picked);
- }
- if (scriptWindow != null)
- {
- scriptWindow.sendConsoleMessage(strInfo);
- scriptWindow.sendConsoleMessage("\n");
+ im = new jalview.util.ImageMaker(this,
+ jalview.util.ImageMaker.TYPE.SVG, "Make SVG file from PCA",
+ width, height, null, this.getTitle(), null, 0, false);
}
- }
- public void notifyAtomHovered(int atomIndex, String strInfo, String data)
- {
- if (data!=null)
+ if (im.getGraphics() != null)
{
- Cache.log.info("Non null hover data string: "+data+" (other info: '"+strInfo+"' pos "+atomIndex+")");
+ jmb.viewer.renderScreenImage(im.getGraphics(), width, height);
+ im.writeImage();
}
- mouseOverStructure(atomIndex, strInfo);
}
@Override
- public void showUrl(String url)
+ public void showHelp_actionPerformed(ActionEvent actionEvent)
{
- try {
- jalview.util.BrowserLauncher.openURL(url);
- } catch (IOException e)
+ try
{
- Cache.log.error("Failed to launch Jmol-associated url "+url,e);
- // TODO: 2.6 : warn user if browser was not configured.
+ BrowserLauncher
+ .openURL("http://jmol.sourceforge.net/docs/JmolUserGuide/");
+ } catch (Exception ex)
+ {
+ System.err.println("Show Jmol help failed with: " + ex.getMessage());
}
}
public void showConsole(boolean showConsole)
{
- if (scriptWindow == null)
- scriptWindow = new ScriptWindow(this);
if (showConsole)
{
splitPane.setTopComponent(renderPanel);
splitPane.setBottomComponent(scriptWindow);
this.getContentPane().add(splitPane, BorderLayout.CENTER);
+ splitPane.setDividerLocation(getHeight() - 200);
+ scriptWindow.setVisible(true);
+ scriptWindow.validate();
+ splitPane.validate();
}
- splitPane.setDividerLocation(getHeight() - 200);
- splitPane.validate();
}
else
{
if (splitPane != null)
+ {
splitPane.setVisible(false);
+ }
splitPane = null;
validate();
}
- public float[][] functionXY(String functionName, int x, int y)
- {
- return null;
- }
-
- // /End JmolStatusListener
- // /////////////////////////////
-
class RenderPanel extends JPanel
{
final Dimension currentSize = new Dimension();
- final Rectangle rectClip = new Rectangle();
-
+ @Override
public void paintComponent(Graphics g)
{
getSize(currentSize);
- g.getClipBounds(rectClip);
- if (viewer == null)
+ if (jmb != null && jmb.hasFileLoadingError())
{
g.setColor(Color.black);
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.error_loading_file")
+ + "...", 20, currentSize.height / 2);
+ StringBuffer sb = new StringBuffer();
+ int lines = 0;
+ for (int e = 0; e < jmb.getPdbCount(); e++)
+ {
+ sb.append(jmb.getPdbEntry(e).getId());
+ if (e < jmb.getPdbCount() - 1)
+ {
+ sb.append(",");
+ }
+
+ if (e == jmb.getPdbCount() - 1 || sb.length() > 20)
+ {
+ lines++;
+ g.drawString(sb.toString(), 20, currentSize.height / 2
+ - lines * g.getFontMetrics().getHeight());
+ }
+ }
}
- else if (fileLoadingError != null)
+ else if (jmb == null || jmb.viewer == null || !jmb.isFinishedInit())
{
g.setColor(Color.black);
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..." + pdbentry.getId(), 20,
- currentSize.height / 2);
+ g.drawString(MessageManager.getString("label.retrieving_pdb_data"),
+ 20, currentSize.height / 2);
}
else
{
- viewer.renderScreenImage(g, currentSize, rectClip);
+ jmb.viewer.renderScreenImage(g, currentSize.width,
+ currentSize.height);
}
}
}
- String viewId = null;
-
- public String getViewId()
- {
- if (viewId == null)
- {
- viewId = System.currentTimeMillis() + "." + this.hashCode();
- }
- return viewId;
- }
-
- @Override
- public String createImage(String fileName, String type,
- Object textOrBytes, int quality)
- {
- // TODO Auto-generated method stub
- return null;
- }
-
@Override
- public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
+ public AAStructureBindingModel getBinding()
{
- // TODO Auto-generated method stub
- return null;
+ return this.jmb;
}
@Override
- public Hashtable getRegistryInfo()
+ public String getStateInfo()
{
- // TODO Auto-generated method stub
- return null;
+ return jmb == null ? null : jmb.viewer.getStateInfo();
}
@Override
- public void notifyCallback(int type, Object[] data)
+ public ViewerType getViewerType()
{
- try {
- switch (type)
- {
- case JmolConstants.CALLBACK_LOADSTRUCT:
- notifyFileLoaded((String) data[1], (String) data[2],
- (String) data[3], (String) data[4], ((Integer) data[5]).intValue());
-
- break;
- case JmolConstants.CALLBACK_PICK:
- notifyAtomPicked(((Integer) data[2]).intValue(), (String) data[1], (String) data[0]);
- // also highlight in alignment
- case JmolConstants.CALLBACK_HOVER:
- notifyAtomHovered(((Integer) data[2]).intValue(), (String) data[1], (String) data[0]);
- break;
- case JmolConstants.CALLBACK_SCRIPT:
- notifyScriptTermination((String)data[2], ((Integer)data[3]).intValue());
- break;
- case JmolConstants.CALLBACK_ECHO:
- sendConsoleEcho((String)data[1]);
- break;
- case JmolConstants.CALLBACK_MESSAGE:
- sendConsoleMessage((data==null) ? ((String) null) : (String)data[1]);
- break;
- case JmolConstants.CALLBACK_MEASURE:
- case JmolConstants.CALLBACK_CLICK:
- default:
- System.err.println("Unhandled callback "+type+" "+data);
- break;
- }
- }
- catch (Exception e)
- {
- Cache.log.warn("Squashed Jmol callback handler error: ",e);
- }
+ return ViewerType.JMOL;
}
@Override
- public boolean notifyEnabled(int callbackPick)
+ protected String getViewerName()
{
- switch (callbackPick)
- {
- case JmolConstants.CALLBACK_ECHO:
- case JmolConstants.CALLBACK_LOADSTRUCT:
- case JmolConstants.CALLBACK_MEASURE:
- case JmolConstants.CALLBACK_MESSAGE:
- case JmolConstants.CALLBACK_PICK:
- case JmolConstants.CALLBACK_SCRIPT:
- case JmolConstants.CALLBACK_HOVER:
- case JmolConstants.CALLBACK_ERROR:
- return true;
- case JmolConstants.CALLBACK_CLICK:
- case JmolConstants.CALLBACK_ANIMFRAME:
- case JmolConstants.CALLBACK_MINIMIZATION:
- case JmolConstants.CALLBACK_RESIZE:
- case JmolConstants.CALLBACK_SYNC:
- }
- return false;
- }
-
- @Override
- public void setCallbackFunction(String callbackType,
- String callbackFunction)
- {
- Cache.log.debug("Ignoring set-callback request to associate "+callbackType+" with function "+callbackFunction);
-
+ return "Jmol";
}
-
}