X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FAppJmol.java;h=c5273dd0b86fdcb90666a984e43cf86028e76e3b;hb=c19d2a91ca05e052e3408bf5852d88eb5d0608f1;hp=0204ed2ad3a944c79e099389354095f75d5153ec;hpb=755b20d60ff16e01294e8a917520847222c7ae71;p=jalview.git diff --git a/src/jalview/gui/AppJmol.java b/src/jalview/gui/AppJmol.java index 0204ed2..c5273dd 100644 --- a/src/jalview/gui/AppJmol.java +++ b/src/jalview/gui/AppJmol.java @@ -1,250 +1,401 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1) - * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2) + * Copyright (C) 2015 The Jalview Authors * - * This program 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 2 - * of the License, or (at your option) any later version. + * This file is part of Jalview. * - * This program 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. + * 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. + * + * 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 this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * along with Jalview. If not, see . + * 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.datamodel.*; -import jalview.gui.*; -import jalview.structure.*; +import jalview.bin.Cache; +import jalview.datamodel.Alignment; +import jalview.datamodel.AlignmentI; +import jalview.datamodel.ColumnSelection; 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.*; - -public class AppJmol extends GStructureViewer implements StructureListener, - JmolStatusListener, Runnable - +import jalview.datamodel.SequenceI; +import jalview.gui.StructureViewer.ViewerType; +import jalview.io.JalviewFileChooser; +import jalview.io.JalviewFileView; +import jalview.schemes.BuriedColourScheme; +import jalview.schemes.ColourSchemeI; +import jalview.schemes.HelixColourScheme; +import jalview.schemes.HydrophobicColourScheme; +import jalview.schemes.PurinePyrimidineColourScheme; +import jalview.schemes.StrandColourScheme; +import jalview.schemes.TaylorColourScheme; +import jalview.schemes.TurnColourScheme; +import jalview.schemes.ZappoColourScheme; +import jalview.structures.models.AAStructureBindingModel; +import jalview.util.MessageManager; +import jalview.util.Platform; + +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.awt.event.ActionListener; +import java.awt.event.ItemEvent; +import java.awt.event.ItemListener; +import java.io.BufferedReader; +import java.io.File; +import java.io.FileOutputStream; +import java.io.FileReader; +import java.io.IOException; +import java.io.PrintWriter; +import java.util.ArrayList; +import java.util.List; +import java.util.Vector; + +import javax.swing.JCheckBoxMenuItem; +import javax.swing.JColorChooser; +import javax.swing.JInternalFrame; +import javax.swing.JMenu; +import javax.swing.JMenuItem; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.JSplitPane; +import javax.swing.event.InternalFrameAdapter; +import javax.swing.event.InternalFrameEvent; +import javax.swing.event.MenuEvent; +import javax.swing.event.MenuListener; + +public class AppJmol extends StructureViewerBase { - JmolViewer viewer; - - JmolPopup jmolpopup; - - ScriptWindow scriptWindow; - - PDBEntry pdbentry; + AppJmolBinding jmb; - SequenceI[] sequence; - - String[] chains; - - StructureSelectionManager ssm; + JPanel scriptWindow; JSplitPane splitPane; RenderPanel renderPanel; - AlignmentPanel ap; - - String fileLoadingError; - - boolean colourBySequence = true; + ViewSelectionMenu seqColourBy; - 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, - String viewid) + /** + * + * @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.chains = chains; - 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, null); + + jmb.setLoadingFromArchive(true); + addAlignmentPanel(ap); + if (useToAlign) + { + useAlignmentPanelForSuperposition(ap); + } + 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; + initMenus(); + setViewId(viewid); // jalview.gui.Desktop.addInternalFrame(this, "Loading File", // bounds.width,bounds.height); - initJmol(loadStatus); - this.addInternalFrameListener(new InternalFrameAdapter() { + @Override public void internalFrameClosing(InternalFrameEvent internalFrameEvent) { - closeViewer(); + closeViewer(false); } }); + initJmol(loadStatus); // pdbentry, seq, JBPCHECK! + } - public synchronized void addSequence(SequenceI[] seq) + private void initMenus() { - Vector v = new Vector(); - for (int i = 0; i < sequence.length; i++) - v.addElement(sequence[i]); + seqColour.setSelected(jmb.isColourBySequence()); + viewerColour.setSelected(!jmb.isColourBySequence()); + if (_colourwith == null) + { + _colourwith = new Vector(); + } + if (_alignwith == null) + { + _alignwith = new Vector(); + } - for (int i = 0; i < seq.length; i++) - if (!v.contains(seq[i])) - v.addElement(seq[i]); + seqColourBy = new ViewSelectionMenu( + MessageManager.getString("label.colour_by"), this, _colourwith, + new ItemListener() + { - SequenceI[] tmp = new SequenceI[v.size()]; - v.copyInto(tmp); - sequence = tmp; - } + @Override + public void itemStateChanged(ItemEvent e) + { + if (!seqColour.isSelected()) + { + seqColour.doClick(); + } + else + { + // update the jmol display now. + seqColour_actionPerformed(null); + } + } + }); + viewMenu.add(seqColourBy); + final ItemListener handler; + JMenu alpanels = new ViewSelectionMenu( + MessageManager.getString("label.superpose_with"), this, + _alignwith, handler = new ItemListener() + { - public AppJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains, - 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) + @Override + public void itemStateChanged(ItemEvent e) + { + alignStructs.setEnabled(_alignwith.size() > 0); + alignStructs.setToolTipText(MessageManager + .formatMessage( + "label.align_structures_using_linked_alignment_views", + new String[] { new Integer(_alignwith + .size()).toString() })); + } + }); + handler.itemStateChanged(null); + viewerActionMenu.add(alpanels); + viewerActionMenu.addMenuListener(new MenuListener() + { + + @Override + public void menuSelected(MenuEvent e) { - StructureSelectionManager.getStructureSelectionManager() - .setMapping(seq, chains, alreadyMapped, - AppletFormatAdapter.FILE); - if (ap.seqPanel.seqCanvas.fr != null) - { - ap.seqPanel.seqCanvas.fr.featuresAdded(); - ap.paintAlignment(true); - } + handler.itemStateChanged(null); + } - // Now this AppJmol is mapped to new sequences. We must add them to - // the exisiting array - JInternalFrame[] frames = Desktop.instance.getAllFrames(); + @Override + public void menuDeselected(MenuEvent e) + { + // TODO Auto-generated method stub - 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; - } - } - } + } + + @Override + public void menuCanceled(MenuEvent e) + { + // TODO Auto-generated method stub - return; } + }); + } + + IProgressIndicator progressBar = null; + + /** + * add a single PDB structure to a new or existing Jmol view + * + * @param pdbentry + * @param seq + * @param chains + * @param ap + */ + public AppJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains, + final AlignmentPanel ap) + { + progressBar = ap.alignFrame; + String pdbId = pdbentry.getId(); + + /* + * If the PDB file is already loaded, the user may just choose to add to an + * existing viewer (or cancel) + */ + if (addAlreadyLoadedFile(seq, chains, ap, pdbId)) + { + return; } - // ///////////////////////////////// - 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); + /* + * Check if there are other Jmol views involving this alignment and prompt + * user about adding this molecule to one of them + */ + if (addToExistingViewer(pdbentry, seq, chains, ap, pdbId)) + { + return; + } + + /* + * If the options above are declined or do not apply, open a new viewer + */ + openNewJmol(ap, new PDBEntry[] { pdbentry }, new SequenceI[][] { seq }); + } - if (pdbentry.getFile() != null) + /** + * Answers true if this viewer already involves the given PDB ID + */ + @Override + protected boolean hasPdbId(String pdbId) + { + return jmb.hasPdbId(pdbId); + } + + private void openNewJmol(AlignmentPanel ap, PDBEntry[] pdbentrys, + SequenceI[][] seqs) + { + progressBar = ap.alignFrame; + jmb = new AppJmolBinding(this, ap.getStructureSelectionManager(), + pdbentrys, seqs, null, null); + addAlignmentPanel(ap); + useAlignmentPanelForColourbyseq(ap); + if (pdbentrys.length > 1) { - initJmol("load \"" + pdbentry.getFile() + "\""); + alignAddedStructures = true; + useAlignmentPanelForSuperposition(ap); } - else + jmb.setColourBySequence(true); + setSize(400, 400); // probably should be a configurable/dynamic default here + initMenus(); + worker = null; { - Thread worker = new Thread(this); + addingStructures = false; + worker = new Thread(this); worker.start(); } - this.addInternalFrameListener(new InternalFrameAdapter() { + @Override public void internalFrameClosing(InternalFrameEvent internalFrameEvent) { - closeViewer(); + closeViewer(false); } }); + } - void initJmol(String command) + /** + * create a new Jmol containing several structures superimposed using the + * given alignPanel. + * + * @param ap + * @param pe + * @param seqs + */ + public AppJmol(AlignmentPanel ap, PDBEntry[] pe, SequenceI[][] seqs) { - renderPanel = new RenderPanel(); - - this.getContentPane().add(renderPanel, java.awt.BorderLayout.CENTER); + openNewJmol(ap, pe, seqs); + } - StringBuffer title = new StringBuffer(sequence[0].getName() + ":" - + pdbentry.getId()); + /** + * Returns a list of any Jmol viewers. The list is restricted to those linked + * to the given alignment panel if it is not null. + */ + @Override + protected List getViewersFor(AlignmentPanel apanel) + { + List result = new ArrayList(); + JInternalFrame[] frames = Desktop.instance.getAllFrames(); - if (pdbentry.getProperty() != null) + for (JInternalFrame frame : frames) { - if (pdbentry.getProperty().get("method") != null) + if (frame instanceof AppJmol) { - title.append(" Method: "); - title.append(pdbentry.getProperty().get("method")); - } - if (pdbentry.getProperty().get("chains") != null) - { - title.append(" Chain:"); - title.append(pdbentry.getProperty().get("chains")); + if (apanel == null + || ((StructureViewerBase) frame).isLinkedWith(apanel)) + { + result.add((StructureViewerBase) frame); + } } } + return result; + } - this.setTitle(title.toString()); - jalview.gui.Desktop.addInternalFrame(this, title.toString(), + 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); + jalview.gui.Desktop.addInternalFrame(this, jmb.getViewerTitle(), getBounds().width, getBounds().height); + if (scriptWindow == null) + { + BorderLayout bl = new BorderLayout(); + bl.setHgap(0); + bl.setVgap(0); + scriptWindow = new JPanel(bl); + scriptWindow.setVisible(false); + } - viewer = org.jmol.api.JmolViewer.allocateViewer(renderPanel, - new SmarterJmolAdapter()); - - viewer.setAppletContext("", null, null, ""); - - viewer.setJmolStatusListener(this); - - jmolpopup = JmolPopup.newJmolPopup(viewer); - - viewer.evalStringQuiet(command); + jmb.allocateViewer(renderPanel, true, "", null, null, "", scriptWindow, + null); + // jmb.newJmolPopup("Jmol"); + if (command == null) + { + command = ""; + } + jmb.evalStateCommand(command); + jmb.evalStateCommand("set hoverDelay=0.1"); + jmb.setFinishedInit(true); } - void setChainMenuItems(Vector chains) + void setChainMenuItems(Vector chains) { chainMenu.removeAll(); - - JMenuItem menuItem = new JMenuItem("All"); + if (chains == null) + { + return; + } + JMenuItem menuItem = new JMenuItem( + MessageManager.getString("label.all")); menuItem.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent evt) @@ -253,7 +404,9 @@ public class AppJmol extends GStructureViewer implements StructureListener, for (int i = 0; i < chainMenu.getItemCount(); i++) { if (chainMenu.getItem(i) instanceof JCheckBoxMenuItem) + { ((JCheckBoxMenuItem) chainMenu.getItem(i)).setSelected(true); + } } centerViewer(); allChainsSelected = false; @@ -262,15 +415,17 @@ public class AppJmol extends GStructureViewer implements StructureListener, chainMenu.add(menuItem); - for (int c = 0; c < chains.size(); c++) + for (String chain : chains) { - menuItem = new JCheckBoxMenuItem(chains.elementAt(c).toString(), true); + menuItem = new JCheckBoxMenuItem(chain, true); menuItem.addItemListener(new ItemListener() { public void itemStateChanged(ItemEvent evt) { if (!allChainsSelected) + { centerViewer(); + } } }); @@ -282,87 +437,248 @@ public class AppJmol extends GStructureViewer implements StructureListener, void centerViewer() { - StringBuffer cmd = new StringBuffer(); + Vector 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() + 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; } public void run() { + _started = true; + String pdbid = ""; + // todo - record which pdbids were successfuly imported. + StringBuffer errormsgs = new StringBuffer(), files = new StringBuffer(); try { - // TODO: replace with reference fetching/transfer code (validate PDBentry as a DBRef?) + String[] curfiles = jmb.getPdbFile(); // files currently in viewer + // 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) + for (int pi = 0; pi < jmb.getPdbCount(); pi++) { - // 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()); - } - else - { - JOptionPane - .showInternalMessageDialog( - Desktop.desktop, - pdbentry.getId() - + " could not be retrieved. Please try downloading the file manually.", - "Couldn't load file", JOptionPane.ERROR_MESSAGE); + String file = jmb.getPdbEntry(pi).getFile(); + if (file == null) + { + // retrieve the pdb and store it locally + AlignmentI pdbseq = null; + pdbid = jmb.getPdbEntry(pi).getId(); + long hdl = pdbid.hashCode() - System.currentTimeMillis(); + if (progressBar != null) + { + 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("'" + pdbid + "'"); + } + if (progressBar != null) + { + progressBar.setProgressBar( + MessageManager.getString("label.state_completed"), hdl); + } + 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.append(" \"" + Platform.escapeString(file) + "\""); + } + else + { + errormsgs.append("'" + pdbid + "' "); + } + } + else + { + if (curfiles != null && curfiles.length > 0) + { + addingStructures = true; // already files loaded. + for (int c = 0; c < curfiles.length; c++) + { + if (curfiles[c].equals(file)) + { + file = null; + break; + } + } + } + if (file != null) + { + files.append(" \"" + Platform.escapeString(file) + "\""); + } + } } } catch (OutOfMemoryError oomerror) { - new OOMWarning("Retrieving PDB id " + pdbentry.getId() + " from MSD", - oomerror); + new OOMWarning("Retrieving PDB files: " + pdbid, oomerror); } catch (Exception ex) { ex.printStackTrace(); + errormsgs.append("When retrieving pdbfiles : current was: '" + pdbid + + "'"); + } + if (errormsgs.length() > 0) + { + + 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(); + if (files.length() > 0) + { + if (!addingStructures) + { + + try + { + initJmol("load FILES " + files.toString()); + } catch (OutOfMemoryError oomerror) + { + new OOMWarning("When trying to open the Jmol viewer!", oomerror); + Cache.log.debug("File locations are " + files); + } catch (Exception ex) + { + Cache.log.error("Couldn't open Jmol viewer!", ex); + } + } + else + { + StringBuffer cmd = new StringBuffer(); + cmd.append("loadingJalviewdata=true\nload APPEND "); + cmd.append(files.toString()); + cmd.append("\nloadingJalviewdata=null"); + final String command = cmd.toString(); + cmd = null; + lastnotify = jmb.getLoadNotifiesHandled(); + + 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 " + files); + } catch (Exception ex) + { + 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() != null && jmb + .getPdbFile().length != jmb.getPdbCount())) + { + try + { + Cache.log.debug("Waiting around for jmb notify."); + Thread.sleep(35); + } catch (Exception e) + { + } + } + + // refresh the sequence colours for the new structure(s) + for (AlignmentPanel ap : _colourwith) + { + jmb.updateColours(ap); + } + // do superposition if asked to + if (Cache.getDefault("AUTOSUPERIMPOSE", true) && alignAddedStructures) + { + javax.swing.SwingUtilities.invokeLater(new Runnable() + { + public void run() + { + if (jmb.viewer.isScriptExecuting()) + { + javax.swing.SwingUtilities.invokeLater(this); + try + { + Thread.sleep(5); + } catch (InterruptedException q) + { + } + ; + return; + } + else + { + alignStructs_withAllAlignPanels(); + } + } + }); + alignAddedStructures = false; + } + addingStructures = false; + } + _started = false; + worker = null; } + @Override public void pdbFile_actionPerformed(ActionEvent actionEvent) { - JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache - .getProperty("LAST_DIRECTORY")); + JalviewFileChooser chooser = new JalviewFileChooser( + jalview.bin.Cache.getProperty("LAST_DIRECTORY")); chooser.setFileView(new JalviewFileView()); - chooser.setDialogTitle("Save PDB File"); - chooser.setToolTipText("Save"); + chooser.setDialogTitle(MessageManager.getString("label.save_pdb_file")); + chooser.setToolTipText(MessageManager.getString("action.save")); int value = chooser.showSaveDialog(this); if (value == JalviewFileChooser.APPROVE_OPTION) { + BufferedReader in = null; try { - BufferedReader in = new BufferedReader(new FileReader(pdbentry - .getFile())); + // TODO: cope with multiple PDB files in view + in = new BufferedReader(new FileReader(jmb.getPdbFile()[0])); File outFile = chooser.getSelectedFile(); PrintWriter out = new PrintWriter(new FileOutputStream(outFile)); @@ -378,173 +694,214 @@ public class AppJmol extends GStructureViewer implements StructureListener, } catch (Exception ex) { ex.printStackTrace(); + } finally + { + if (in != null) + { + try + { + in.close(); + } catch (IOException e) + { + // ignore + } + } } } } + @Override 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())); + try + { + cap.appendText(jmb.printMappings()); + } catch (OutOfMemoryError e) + { + new OOMWarning( + "composing sequence-structure alignments for display in text box.", + e); + cap.dispose(); + return; + } + jalview.gui.Desktop.addInternalFrame(cap, + MessageManager.getString("label.pdb_sequence_mapping"), 550, + 600); } - /** - * DOCUMENT ME! - * - * @param e - * DOCUMENT ME! - */ + @Override public void eps_actionPerformed(ActionEvent e) { - makePDBImage(jalview.util.ImageMaker.EPS); + makePDBImage(jalview.util.ImageMaker.TYPE.EPS); } - /** - * DOCUMENT ME! - * - * @param e - * DOCUMENT ME! - */ + @Override public void png_actionPerformed(ActionEvent e) { - makePDBImage(jalview.util.ImageMaker.PNG); + makePDBImage(jalview.util.ImageMaker.TYPE.PNG); } - void makePDBImage(int type) + void makePDBImage(jalview.util.ImageMaker.TYPE type) { int width = getWidth(); int height = getHeight(); jalview.util.ImageMaker im; - if (type == jalview.util.ImageMaker.PNG) + if (type == jalview.util.ImageMaker.TYPE.PNG) { - im = new jalview.util.ImageMaker(this, jalview.util.ImageMaker.PNG, - "Make PNG image from view", width, height, null, null); + im = new jalview.util.ImageMaker(this, + jalview.util.ImageMaker.TYPE.PNG, "Make PNG image from view", + width, height, null, null); + } + else if (type == jalview.util.ImageMaker.TYPE.EPS) + { + im = new jalview.util.ImageMaker(this, + jalview.util.ImageMaker.TYPE.EPS, "Make EPS file from view", + width, height, null, this.getTitle()); } else { - im = new jalview.util.ImageMaker(this, jalview.util.ImageMaker.EPS, - "Make EPS file from view", width, height, null, this - .getTitle()); + + im = new jalview.util.ImageMaker(this, + jalview.util.ImageMaker.TYPE.SVG, "Make SVG file from PCA", + width, height, null, this.getTitle()); } if (im.getGraphics() != null) { - Rectangle rect = new Rectangle(width, height); - viewer.renderScreenImage(im.getGraphics(), rect.getSize(), rect); + jmb.viewer.renderScreenImage(im.getGraphics(), width, height); im.writeImage(); } } + @Override + public void viewerColour_actionPerformed(ActionEvent actionEvent) + { + if (viewerColour.isSelected()) + { + // disable automatic sequence colouring. + jmb.setColourBySequence(false); + } + } + + @Override public void seqColour_actionPerformed(ActionEvent actionEvent) { - lastCommand = null; - colourBySequence = seqColour.isSelected(); - colourBySequence(ap.alignFrame.alignPanel); + jmb.setColourBySequence(seqColour.isSelected()); + if (_colourwith == null) + { + _colourwith = new Vector(); + } + if (jmb.isColourBySequence()) + { + if (!jmb.isLoadingFromArchive()) + { + if (_colourwith.size() == 0 && getAlignmentPanel() != null) + { + // Make the currently displayed alignment panel the associated view + _colourwith.add(getAlignmentPanel().alignFrame.alignPanel); + } + } + // Set the colour using the current view for the associated alignframe + for (AlignmentPanel ap : _colourwith) + { + jmb.colourBySequence(ap); + } + } } + @Override public void chainColour_actionPerformed(ActionEvent actionEvent) { - colourBySequence = false; - seqColour.setSelected(false); - viewer.evalStringQuiet("select *;color chain"); + chainColour.setSelected(true); + jmb.colourByChain(); } + @Override 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"); + chargeColour.setSelected(true); + jmb.colourByCharge(); } + @Override public void zappoColour_actionPerformed(ActionEvent actionEvent) { - setJalviewColourScheme(new ZappoColourScheme()); + zappoColour.setSelected(true); + jmb.setJalviewColourScheme(new ZappoColourScheme()); } + @Override public void taylorColour_actionPerformed(ActionEvent actionEvent) { - setJalviewColourScheme(new TaylorColourScheme()); + taylorColour.setSelected(true); + jmb.setJalviewColourScheme(new TaylorColourScheme()); } + @Override public void hydroColour_actionPerformed(ActionEvent actionEvent) { - setJalviewColourScheme(new HydrophobicColourScheme()); + hydroColour.setSelected(true); + jmb.setJalviewColourScheme(new HydrophobicColourScheme()); } + @Override public void helixColour_actionPerformed(ActionEvent actionEvent) { - setJalviewColourScheme(new HelixColourScheme()); + helixColour.setSelected(true); + jmb.setJalviewColourScheme(new HelixColourScheme()); } + @Override public void strandColour_actionPerformed(ActionEvent actionEvent) { - setJalviewColourScheme(new StrandColourScheme()); + strandColour.setSelected(true); + jmb.setJalviewColourScheme(new StrandColourScheme()); } + @Override public void turnColour_actionPerformed(ActionEvent actionEvent) { - setJalviewColourScheme(new TurnColourScheme()); + turnColour.setSelected(true); + jmb.setJalviewColourScheme(new TurnColourScheme()); } + @Override public void buriedColour_actionPerformed(ActionEvent actionEvent) { - setJalviewColourScheme(new BuriedColourScheme()); + buriedColour.setSelected(true); + jmb.setJalviewColourScheme(new BuriedColourScheme()); } - public void setJalviewColourScheme(ColourSchemeI cs) + @Override + public void purinePyrimidineColour_actionPerformed(ActionEvent actionEvent) { - 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()); + setJalviewColourScheme(new PurinePyrimidineColourScheme()); } + @Override public void userColour_actionPerformed(ActionEvent actionEvent) { + userColour.setSelected(true); new UserDefinedColours(this, null); } + @Override public void backGround_actionPerformed(ActionEvent actionEvent) { - java.awt.Color col = JColorChooser.showDialog(this, - "Select Background Colour", null); - + java.awt.Color col = JColorChooser + .showDialog(this, MessageManager + .getString("label.select_backgroud_colour"), null); if (col != null) { - viewer.evalStringQuiet("background [" + col.getRed() + "," - + col.getGreen() + "," + col.getBlue() + "];"); + jmb.setBackgroundColour(col); } } - public void jmolHelp_actionPerformed(ActionEvent actionEvent) + @Override + public void showHelp_actionPerformed(ActionEvent actionEvent) { try { @@ -555,454 +912,210 @@ public class AppJmol extends GStructureViewer implements StructureListener, } } - // //////////////////////////////// - // /StructureListener - public String getPdbFile() - { - return pdbentry.getFile(); - } - - Pattern pattern = Pattern - .compile("\\[(.*)\\]([0-9]+)(:[a-zA-Z]*)?\\.([a-zA-Z]+)(/[0-9]*)?"); - - String lastMessage; - - public void mouseOverStructure(int atomIndex, String strInfo) + public void showConsole(boolean showConsole) { - 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 + if (showConsole) { - chainId = " "; - } + if (splitPane == null) + { + splitPane = new JSplitPane(JSplitPane.VERTICAL_SPLIT); + splitPane.setTopComponent(renderPanel); + splitPane.setBottomComponent(scriptWindow); + this.getContentPane().add(splitPane, BorderLayout.CENTER); + splitPane.setDividerLocation(getHeight() - 200); + scriptWindow.setVisible(true); + scriptWindow.validate(); + splitPane.validate(); + } - if (lastMessage == null || !lastMessage.equals(strInfo)) - { - ssm.mouseOverStructure(pdbResNum, chainId, pdbentry.getFile()); } - 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) + else { - viewer.evalStringQuiet(resetLastRes.toString()); - } - - eval.setLength(0); - eval.append("select " + pdbResNum); + if (splitPane != null) + { + splitPane.setVisible(false); + } - resetLastRes.setLength(0); - resetLastRes.append("select " + pdbResNum); + splitPane = null; - eval.append(":"); - resetLastRes.append(":"); - if (!chain.equals(" ")) - { - eval.append(chain); - resetLastRes.append(chain); + this.getContentPane().add(renderPanel, BorderLayout.CENTER); } - 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)); - } - - public void updateColours(Object source) - { - colourBySequence((AlignmentPanel) source); + validate(); } - // End StructureListener - // ////////////////////////// - - String lastCommand; - - FeatureRenderer fr = null; - - public void colourBySequence(AlignmentPanel sourceap) + class RenderPanel extends JPanel { - 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; + final Dimension currentSize = new Dimension(); - if (ap.av.showSequenceFeatures) + @Override + public void paintComponent(Graphics g) { - showFeatures = true; - if (fr == null) - { - fr = new jalview.gui.FeatureRenderer(ap); - } - - fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer()); - } - - StringBuffer command = new StringBuffer(); + getSize(currentSize); - int lastPos = -1; - for (int sp, s = 0; s < sequence.length; s++) - { - for (int m = 0; m < mapping.length; m++) + if (jmb != null && jmb.fileLoadingError != null) { - if (mapping[m].getSequence() == sequence[s] - && (sp = ap.av.alignment.findIndex(sequence[s])) > -1) + 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(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++) { - SequenceI asp = ap.av.alignment.getSequenceAt(sp); - for (int r = 0; r < asp.getLength(); r++) + sb.append(jmb.getPdbEntry(e).getId()); + if (e < jmb.getPdbCount() - 1) { - // 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() - + "]")) - { - command = condenseCommand(command, pos); - continue; - } - - command.append(";select " + pos); - - if (!mapping[m].getChain().equals(" ")) - { - command.append(":" + mapping[m].getChain()); - } - - command.append(";color[" + col.getRed() + "," + col.getGreen() - + "," + col.getBlue() + "]"); + sb.append(","); + } + if (e == jmb.getPdbCount() - 1 || sb.length() > 20) + { + lines++; + g.drawString(sb.toString(), 20, currentSize.height / 2 - lines + * g.getFontMetrics().getHeight()); } - break; } } + 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(MessageManager.getString("label.retrieving_pdb_data"), + 20, currentSize.height / 2); + } + else + { + jmb.viewer.renderScreenImage(g, currentSize.width, + currentSize.height); + } } - - if (lastCommand == null || !lastCommand.equals(command.toString())) - { - viewer.evalStringQuiet(command.toString()); - } - lastCommand = command.toString(); } - StringBuffer condenseCommand(StringBuffer command, int pos) + public void updateTitleAndMenus() { - StringBuffer sb = new StringBuffer(command.substring(0, command - .lastIndexOf("select") + 7)); - - command.delete(0, sb.length()); - - String start; + if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0) + { + repaint(); + return; + } + setChainMenuItems(jmb.chainNames); - if (command.indexOf("-") > -1) + this.setTitle(jmb.getViewerTitle()); + if (jmb.getPdbFile().length > 1 && jmb.getSequence().length > 1) { - start = command.substring(0, command.indexOf("-")); + viewerActionMenu.setVisible(true); } - else + if (!jmb.isLoadingFromArchive()) { - start = command.substring(0, command.indexOf(":")); + seqColour_actionPerformed(null); } - - sb.append(start + "-" + pos + command.substring(command.indexOf(":"))); - - return sb; } - // /////////////////////////////// - // 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 setCallbackFunction(String callbackType, - String callbackFunction) + /* + * (non-Javadoc) + * + * @see + * jalview.jbgui.GStructureViewer#alignStructs_actionPerformed(java.awt.event + * .ActionEvent) + */ + @Override + protected void alignStructs_actionPerformed(ActionEvent actionEvent) { + alignStructs_withAllAlignPanels(); } - public void notifyFileLoaded(String fullPathName, String fileName, - String modelName, Object clientFile, String errorMsg) + private void alignStructs_withAllAlignPanels() { - if (errorMsg != null) + if (getAlignmentPanel() == null) { - fileLoadingError = errorMsg; - repaint(); return; } - - fileLoadingError = null; - - if (fileName != null) + ; + if (_alignwith.size() == 0) { + _alignwith.add(getAlignmentPanel()); + } + ; + try + { + AlignmentI[] als = new Alignment[_alignwith.size()]; + ColumnSelection[] alc = new ColumnSelection[_alignwith.size()]; + int[] alm = new int[_alignwith.size()]; + int a = 0; - // 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++) + for (AlignmentPanel ap : _alignwith) { - chains - .addElement(((MCview.PDBChain) pdbFile.chains.elementAt(i)).id); + als[a] = ap.av.getAlignment(); + alm[a] = -1; + alc[a++] = ap.av.getColumnSelection(); } - setChainMenuItems(chains); - - jmolpopup.updateComputedMenus(); - - if (!loadingFromArchive) + jmb.superposeStructures(als, alm, alc); + } catch (Exception e) + { + StringBuffer sp = new StringBuffer(); + for (AlignmentPanel ap : _alignwith) { - viewer - .evalStringQuiet("select backbone;restrict;cartoon;wireframe off;spacefill off"); - - colourBySequence(ap); + sp.append("'" + ap.alignFrame.getTitle() + "' "); } - if (fr != null) - fr.featuresAdded(); + Cache.log.info("Couldn't align structures with the " + sp.toString() + + "associated alignment panels.", e); - loadingFromArchive = false; } - else - return; - } - - public void notifyFrameChanged(int frameNo) - { - boolean isAnimationRunning = (frameNo <= -2); - } - - public void notifyScriptStart(String statusMessage, String additionalInfo) - { - } - public void sendConsoleEcho(String strEcho) - { - if (scriptWindow != null) - scriptWindow.sendConsoleEcho(strEcho); } - public void sendConsoleMessage(String strStatus) + public void setJalviewColourScheme(ColourSchemeI ucs) { - if (scriptWindow != null) - scriptWindow.sendConsoleMessage(strStatus); - } + jmb.setJalviewColourScheme(ucs); - public void notifyScriptTermination(String strStatus, int msWalltime) - { - if (scriptWindow != null) - scriptWindow.notifyScriptTermination(strStatus, msWalltime); - } - - public void handlePopupMenu(int x, int y) - { - jmolpopup.show(x, y); - } - - public void notifyNewPickingModeMeasurement(int iatom, String strMeasure) - { - notifyAtomPicked(iatom, strMeasure); - } - - public void notifyNewDefaultModeMeasurement(int count, String strInfo) - { - } - - public void notifyAtomPicked(int atomIndex, String strInfo) - { - 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 += ".CA"; - - if (!atomsPicked.contains(picked)) - { - if (chainId != null) - viewer.evalString("select " + picked + ";label %n %r:%c"); - else - viewer.evalString("select " + picked + ";label %n %r"); - atomsPicked.addElement(picked); - } - else - { - viewer.evalString("select " + picked + ";label off"); - atomsPicked.removeElement(picked); - } - - if (scriptWindow != null) - { - scriptWindow.sendConsoleMessage(strInfo); - scriptWindow.sendConsoleMessage("\n"); - } - } - - public void notifyAtomHovered(int atomIndex, String strInfo) - { - mouseOverStructure(atomIndex, strInfo); - } - - public void sendSyncScript(String script, String appletName) - { } - public void showUrl(String url) - { - } - - public void showConsole(boolean showConsole) + /** + * + * @param alignment + * @return first alignment panel displaying given alignment, or the default + * alignment panel + */ + public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment) { - if (scriptWindow == null) - scriptWindow = new ScriptWindow(this); - - if (showConsole) + for (AlignmentPanel ap : getAllAlignmentPanels()) { - if (splitPane == null) + if (ap.av.getAlignment() == alignment) { - splitPane = new JSplitPane(JSplitPane.VERTICAL_SPLIT); - splitPane.setTopComponent(renderPanel); - splitPane.setBottomComponent(scriptWindow); - this.getContentPane().add(splitPane, BorderLayout.CENTER); + return ap; } - - splitPane.setDividerLocation(getHeight() - 200); - splitPane.validate(); - } - else - { - if (splitPane != null) - splitPane.setVisible(false); - - splitPane = null; - - this.getContentPane().add(renderPanel, BorderLayout.CENTER); } - - validate(); + return getAlignmentPanel(); } - public float functionXY(String functionName, int x, int y) + @Override + public AAStructureBindingModel getBinding() { - return 0; + return this.jmb; } - // /End JmolStatusListener - // ///////////////////////////// - - class RenderPanel extends JPanel + @Override + public String getStateInfo() { - final Dimension currentSize = new Dimension(); - - final Rectangle rectClip = new Rectangle(); - - public void paintComponent(Graphics g) - { - getSize(currentSize); - g.getClipBounds(rectClip); - - if (viewer == null) - { - 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); - } - else if (fileLoadingError != null) - { - 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); - } - else - { - viewer.renderScreenImage(g, currentSize, rectClip); - } - } + return jmb == null ? null : jmb.viewer.getStateInfo(); } - String viewId = null; + @Override + public ViewerType getViewerType() + { + return ViewerType.JMOL; + } - public String getViewId() + @Override + protected AAStructureBindingModel getBindingModel() { - if (viewId == null) - { - viewId = System.currentTimeMillis() + "." + this.hashCode(); - } - return viewId; + return jmb; } }