src/jalview/gui/ChimeraViewFrame.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.api.AlignmentViewPanel;
  24 import jalview.api.FeatureRenderer;
  25 import jalview.bin.Cache;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.PDBEntry;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.ext.rbvi.chimera.ChimeraCommands;
  30 import jalview.ext.rbvi.chimera.JalviewChimeraBinding;
  31 import jalview.gui.StructureViewer.ViewerType;
  32 import jalview.io.DataSourceType;
  33 import jalview.io.StructureFile;
  34 import jalview.structures.models.AAStructureBindingModel;
  35 import jalview.util.BrowserLauncher;
  36 import jalview.util.MessageManager;
  37 import jalview.util.Platform;
  38 import jalview.ws.dbsources.Pdb;
  39
  40 import java.awt.event.ActionEvent;
  41 import java.awt.event.ActionListener;
  42 import java.awt.event.MouseAdapter;
  43 import java.awt.event.MouseEvent;
  44 import java.io.File;
  45 import java.io.FileInputStream;
  46 import java.io.IOException;
  47 import java.io.InputStream;
  48 import java.util.ArrayList;
  49 import java.util.Collections;
  50 import java.util.List;
  51 import java.util.Random;
  52
  53 import javax.swing.JInternalFrame;
  54 import javax.swing.JMenu;
  55 import javax.swing.JMenuItem;
  56 import javax.swing.event.InternalFrameAdapter;
  57 import javax.swing.event.InternalFrameEvent;
  58
  59 /**
  60  * GUI elements for handling an external chimera display
  61  *
  62  * @author jprocter
  63  *
  64  */
  65 public class ChimeraViewFrame extends StructureViewerBase
  66 {
  67   private JalviewChimeraBinding jmb;
  68
  69   private IProgressIndicator progressBar = null;
  70
  71   /*
  72    * Path to Chimera session file. This is set when an open Jalview/Chimera
  73    * session is saved, or on restore from a Jalview project (if it holds the
  74    * filename of any saved Chimera sessions).
  75    */
  76   private String chimeraSessionFile = null;
  77
  78   private Random random = new Random();
  79
  80   private int myWidth = 500;
  81
  82   private int myHeight = 150;
  83
  84   /**
  85    * Initialise menu options.
  86    */
  87   @Override
  88   protected void initMenus()
  89   {
  90     super.initMenus();
  91
  92     viewerActionMenu.setText(MessageManager.getString("label.chimera"));
  93
  94     viewerColour
  95             .setText(MessageManager.getString("label.colour_with_chimera"));
  96     viewerColour.setToolTipText(MessageManager
  97             .getString("label.let_chimera_manage_structure_colours"));
  98
  99     helpItem.setText(MessageManager.getString("label.chimera_help"));
 100     savemenu.setVisible(false); // not yet implemented
 101     viewMenu.add(fitToWindow);
 102
 103     JMenuItem writeFeatures = new JMenuItem(
 104             MessageManager.getString("label.create_chimera_attributes"));
 105     writeFeatures.setToolTipText(MessageManager
 106             .getString("label.create_chimera_attributes_tip"));
 107     writeFeatures.addActionListener(new ActionListener()
 108     {
 109       @Override
 110       public void actionPerformed(ActionEvent e)
 111       {
 112         sendFeaturesToChimera();
 113       }
 114     });
 115     viewerActionMenu.add(writeFeatures);
 116
 117     final JMenu fetchAttributes = new JMenu(
 118             MessageManager.getString("label.fetch_chimera_attributes"));
 119     fetchAttributes.setToolTipText(
 120             MessageManager.getString("label.fetch_chimera_attributes_tip"));
 121     fetchAttributes.addMouseListener(new MouseAdapter()
 122     {
 123
 124       @Override
 125       public void mouseEntered(MouseEvent e)
 126       {
 127         buildAttributesMenu(fetchAttributes);
 128       }
 129     });
 130     viewerActionMenu.add(fetchAttributes);
 131   }
 132
 133   /**
 134    * Query Chimera for its residue attribute names and add them as items off the
 135    * attributes menu
 136    *
 137    * @param attributesMenu
 138    */
 139   protected void buildAttributesMenu(JMenu attributesMenu)
 140   {
 141     List<String> atts = jmb.sendChimeraCommand("list resattr", true);
 142     if (atts == null)
 143     {
 144       return;
 145     }
 146     attributesMenu.removeAll();
 147     Collections.sort(atts);
 148     for (String att : atts)
 149     {
 150       final String attName = att.split(" ")[1];
 151
 152       /*
 153        * ignore 'jv_*' attributes, as these are Jalview features that have
 154        * been transferred to residue attributes in Chimera!
 155        */
 156       if (!attName.startsWith(ChimeraCommands.NAMESPACE_PREFIX))
 157       {
 158         JMenuItem menuItem = new JMenuItem(attName);
 159         menuItem.addActionListener(new ActionListener()
 160         {
 161           @Override
 162           public void actionPerformed(ActionEvent e)
 163           {
 164             getChimeraAttributes(attName);
 165           }
 166         });
 167         attributesMenu.add(menuItem);
 168       }
 169     }
 170   }
 171
 172   /**
 173    * Read residues in Chimera with the given attribute name, and set as features
 174    * on the corresponding sequence positions (if any)
 175    *
 176    * @param attName
 177    */
 178   protected void getChimeraAttributes(String attName)
 179   {
 180     jmb.copyStructureAttributesToFeatures(attName, getAlignmentPanel());
 181   }
 182
 183   /**
 184    * Send a command to Chimera to create residue attributes for Jalview features
 185    * <p>
 186    * The syntax is: setattr r <attName> <attValue> <atomSpec>
 187    * <p>
 188    * For example: setattr r jv:chain "Ferredoxin-1, Chloroplastic" #0:94.A
 189    */
 190   protected void sendFeaturesToChimera()
 191   {
 192     int count = jmb.sendFeaturesToViewer(getAlignmentPanel());
 193     statusBar.setText(
 194             MessageManager.formatMessage("label.attributes_set", count));
 195   }
 196
 197   /**
 198    * open a single PDB structure in a new Chimera view
 199    *
 200    * @param pdbentry
 201    * @param seq
 202    * @param chains
 203    * @param ap
 204    */
 205   public ChimeraViewFrame(PDBEntry pdbentry, SequenceI[] seq,
 206           String[] chains, final AlignmentPanel ap)
 207   {
 208     this();
 209
 210     openNewChimera(ap, new PDBEntry[] { pdbentry },
 211             new SequenceI[][]
 212             { seq });
 213   }
 214
 215   /**
 216    * Create a helper to manage progress bar display
 217    */
 218   protected void createProgressBar()
 219   {
 220     if (progressBar == null)
 221     {
 222       progressBar = new ProgressBar(statusPanel, statusBar);
 223     }
 224   }
 225
 226   private void openNewChimera(AlignmentPanel ap, PDBEntry[] pdbentrys,
 227           SequenceI[][] seqs)
 228   {
 229     createProgressBar();
 230     jmb = new JalviewChimeraBindingModel(this,
 231             ap.getStructureSelectionManager(), pdbentrys, seqs, null);
 232     addAlignmentPanel(ap);
 233     useAlignmentPanelForColourbyseq(ap);
 234
 235     if (pdbentrys.length > 1)
 236     {
 237       useAlignmentPanelForSuperposition(ap);
 238     }
 239     jmb.setColourBySequence(true);
 240     setSize(myWidth, myHeight);
 241     initMenus();
 242
 243     addingStructures = false;
 244     worker = new Thread(this);
 245     worker.start();
 246
 247     this.addInternalFrameListener(new InternalFrameAdapter()
 248     {
 249       @Override
 250       public void internalFrameClosing(
 251               InternalFrameEvent internalFrameEvent)
 252       {
 253         closeViewer(false);
 254       }
 255     });
 256
 257   }
 258
 259   /**
 260    * Create a new viewer from saved session state data including Chimera session
 261    * file
 262    *
 263    * @param chimeraSessionFile
 264    * @param alignPanel
 265    * @param pdbArray
 266    * @param seqsArray
 267    * @param colourByChimera
 268    * @param colourBySequence
 269    * @param newViewId
 270    */
 271   public ChimeraViewFrame(String chimeraSessionFile,
 272           AlignmentPanel alignPanel, PDBEntry[] pdbArray,
 273           SequenceI[][] seqsArray, boolean colourByChimera,
 274           boolean colourBySequence, String newViewId)
 275   {
 276     this();
 277     setViewId(newViewId);
 278     this.chimeraSessionFile = chimeraSessionFile;
 279     openNewChimera(alignPanel, pdbArray, seqsArray);
 280     if (colourByChimera)
 281     {
 282       jmb.setColourBySequence(false);
 283       seqColour.setSelected(false);
 284       viewerColour.setSelected(true);
 285     }
 286     else if (colourBySequence)
 287     {
 288       jmb.setColourBySequence(true);
 289       seqColour.setSelected(true);
 290       viewerColour.setSelected(false);
 291     }
 292   }
 293
 294   /**
 295    * create a new viewer containing several structures, optionally superimposed
 296    * using the given alignPanel.
 297    *
 298    * @param pe
 299    * @param seqs
 300    * @param ap
 301    */
 302   public ChimeraViewFrame(PDBEntry[] pe, boolean alignAdded,
 303           SequenceI[][] seqs,
 304           AlignmentPanel ap)
 305   {
 306     this();
 307     setAlignAddedStructures(alignAdded);
 308     openNewChimera(ap, pe, seqs);
 309   }
 310
 311   /**
 312    * Default constructor
 313    */
 314   public ChimeraViewFrame()
 315   {
 316     super();
 317
 318     /*
 319      * closeViewer will decide whether or not to close this frame
 320      * depending on whether user chooses to Cancel or not
 321      */
 322     setDefaultCloseOperation(JInternalFrame.DO_NOTHING_ON_CLOSE);
 323   }
 324
 325   /**
 326    * Launch Chimera. If we have a chimera session file name, send Chimera the
 327    * command to open its saved session file.
 328    */
 329   void initChimera()
 330   {
 331     jmb.setFinishedInit(false);
 332     Desktop.addInternalFrame(this,
 333             jmb.getViewerTitle(getViewerName(), true), getBounds().width,
 334             getBounds().height);
 335
 336     if (!jmb.launchChimera())
 337     {
 338       JvOptionPane.showMessageDialog(Desktop.desktop,
 339               MessageManager.getString("label.chimera_failed"),
 340               MessageManager.getString("label.error_loading_file"),
 341               JvOptionPane.ERROR_MESSAGE);
 342       this.dispose();
 343       return;
 344     }
 345
 346     if (this.chimeraSessionFile != null)
 347     {
 348       boolean opened = jmb.openSession(chimeraSessionFile);
 349       if (!opened)
 350       {
 351         System.err.println("An error occurred opening Chimera session file "
 352                 + chimeraSessionFile);
 353       }
 354     }
 355
 356     jmb.startChimeraListener();
 357   }
 358
 359   /**
 360    * Show only the selected chain(s) in the viewer
 361    */
 362   @Override
 363   void showSelectedChains()
 364   {
 365     setSelectedChains();
 366
 367     /*
 368      * refresh display without resizing - easier to see what changed
 369      */
 370     jmb.showStructures(getAlignmentPanel().getAlignViewport(), false);
 371   }
 372
 373   /**
 374    * Close down this instance of Jalview's Chimera viewer, giving the user the
 375    * option to close the associated Chimera window (process). They may wish to
 376    * keep it open until they have had an opportunity to save any work.
 377    *
 378    * @param closeChimera
 379    *          if true, close any linked Chimera process; if false, prompt first
 380    */
 381   @Override
 382   public void closeViewer(boolean closeChimera)
 383   {
 384     if (jmb != null && jmb.isChimeraRunning())
 385     {
 386       if (!closeChimera)
 387       {
 388         String prompt = MessageManager
 389                 .formatMessage("label.confirm_close_chimera", new Object[]
 390                 { jmb.getViewerTitle(getViewerName(), false) });
 391         prompt = JvSwingUtils.wrapTooltip(true, prompt);
 392         int confirm = JvOptionPane.showConfirmDialog(this, prompt,
 393                 MessageManager.getString("label.close_viewer"),
 394                 JvOptionPane.YES_NO_CANCEL_OPTION);
 395         /*
 396          * abort closure if user hits escape or Cancel
 397          */
 398         if (confirm == JvOptionPane.CANCEL_OPTION
 399                 || confirm == JvOptionPane.CLOSED_OPTION)
 400         {
 401           return;
 402         }
 403         closeChimera = confirm == JvOptionPane.YES_OPTION;
 404       }
 405       jmb.closeViewer(closeChimera);
 406     }
 407     setAlignmentPanel(null);
 408     _aps.clear();
 409     _alignwith.clear();
 410     _colourwith.clear();
 411     // TODO: check for memory leaks where instance isn't finalised because jmb
 412     // holds a reference to the window
 413     jmb = null;
 414     dispose();
 415   }
 416
 417   /**
 418    * Open any newly added PDB structures in Chimera, having first fetched data
 419    * from PDB (if not already saved).
 420    */
 421   @Override
 422   public void run()
 423   {
 424     _started = true;
 425     // todo - record which pdbids were successfully imported.
 426     StringBuilder errormsgs = new StringBuilder(128);
 427     StringBuilder files = new StringBuilder(128);
 428     List<PDBEntry> filePDB = new ArrayList<>();
 429     List<Integer> filePDBpos = new ArrayList<>();
 430     PDBEntry thePdbEntry = null;
 431     StructureFile pdb = null;
 432     try
 433     {
 434       String[] curfiles = jmb.getStructureFiles(); // files currently in viewer
 435       // TODO: replace with reference fetching/transfer code (validate PDBentry
 436       // as a DBRef?)
 437       for (int pi = 0; pi < jmb.getPdbCount(); pi++)
 438       {
 439         String file = null;
 440         thePdbEntry = jmb.getPdbEntry(pi);
 441         if (thePdbEntry.getFile() == null)
 442         {
 443           /*
 444            * Retrieve PDB data, save to file, attach to PDBEntry
 445            */
 446           file = fetchPdbFile(thePdbEntry);
 447           if (file == null)
 448           {
 449             errormsgs.append("'" + thePdbEntry.getId() + "' ");
 450           }
 451         }
 452         else
 453         {
 454           /*
 455            * Got file already - ignore if already loaded in Chimera.
 456            */
 457           file = new File(thePdbEntry.getFile()).getAbsoluteFile()
 458                   .getPath();
 459           if (curfiles != null && curfiles.length > 0)
 460           {
 461             addingStructures = true; // already files loaded.
 462             for (int c = 0; c < curfiles.length; c++)
 463             {
 464               if (curfiles[c].equals(file))
 465               {
 466                 file = null;
 467                 break;
 468               }
 469             }
 470           }
 471         }
 472         if (file != null)
 473         {
 474           filePDB.add(thePdbEntry);
 475           filePDBpos.add(Integer.valueOf(pi));
 476           files.append(" \"" + Platform.escapeBackslashes(file) + "\"");
 477         }
 478       }
 479     } catch (OutOfMemoryError oomerror)
 480     {
 481       new OOMWarning("Retrieving PDB files: " + thePdbEntry.getId(),
 482               oomerror);
 483     } catch (Exception ex)
 484     {
 485       ex.printStackTrace();
 486       errormsgs.append(
 487               "When retrieving pdbfiles for '" + thePdbEntry.getId() + "'");
 488     }
 489     if (errormsgs.length() > 0)
 490     {
 491
 492       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 493               MessageManager.formatMessage(
 494                       "label.pdb_entries_couldnt_be_retrieved", new Object[]
 495                       { errormsgs.toString() }),
 496               MessageManager.getString("label.couldnt_load_file"),
 497               JvOptionPane.ERROR_MESSAGE);
 498     }
 499
 500     if (files.length() > 0)
 501     {
 502       jmb.setFinishedInit(false);
 503       if (!addingStructures)
 504       {
 505         try
 506         {
 507           initChimera();
 508         } catch (Exception ex)
 509         {
 510           Cache.log.error("Couldn't open Chimera viewer!", ex);
 511         }
 512       }
 513       int num = -1;
 514       for (PDBEntry pe : filePDB)
 515       {
 516         num++;
 517         if (pe.getFile() != null)
 518         {
 519           try
 520           {
 521             int pos = filePDBpos.get(num).intValue();
 522             long startTime = startProgressBar(getViewerName() + " "
 523                     + MessageManager.getString("status.opening_file_for")
 524                     + " " + pe.getId());
 525             jmb.openFile(pe);
 526             jmb.addSequence(pos, jmb.getSequence()[pos]);
 527             File fl = new File(pe.getFile());
 528             DataSourceType protocol = DataSourceType.URL;
 529             try
 530             {
 531               if (fl.exists())
 532               {
 533                 protocol = DataSourceType.FILE;
 534               }
 535             } catch (Throwable e)
 536             {
 537             } finally
 538             {
 539               stopProgressBar("", startTime);
 540             }
 541             // Explicitly map to the filename used by Chimera ;
 542
 543             pdb = jmb.getSsm().setMapping(jmb.getSequence()[pos],
 544                     jmb.getChains()[pos], pe.getFile(), protocol,
 545                     progressBar);
 546             stashFoundChains(pdb, pe.getFile());
 547
 548           } catch (OutOfMemoryError oomerror)
 549           {
 550             new OOMWarning(
 551                     "When trying to open and map structures from Chimera!",
 552                     oomerror);
 553           } catch (Exception ex)
 554           {
 555             Cache.log.error(
 556                     "Couldn't open " + pe.getFile() + " in Chimera viewer!",
 557                     ex);
 558           } finally
 559           {
 560             Cache.log.debug("File locations are " + files);
 561           }
 562         }
 563       }
 564
 565       jmb.refreshGUI();
 566       jmb.setFinishedInit(true);
 567       jmb.setLoadingFromArchive(false);
 568
 569       /*
 570        * ensure that any newly discovered features (e.g. RESNUM)
 571        * are added to any open feature settings dialog
 572        */
 573       FeatureRenderer fr = getBinding().getFeatureRenderer(null);
 574       if (fr != null)
 575       {
 576         fr.featuresAdded();
 577       }
 578
 579       // refresh the sequence colours for the new structure(s)
 580       for (AlignmentViewPanel avp : _colourwith)
 581       {
 582         jmb.updateColours(avp);
 583       }
 584       // do superposition if asked to
 585       if (alignAddedStructures)
 586       {
 587         new Thread(new Runnable()
 588         {
 589           @Override
 590           public void run()
 591           {
 592             alignStructs_withAllAlignPanels();
 593           }
 594         }).start();
 595       }
 596       addingStructures = false;
 597     }
 598     _started = false;
 599     worker = null;
 600   }
 601
 602   /**
 603    * Fetch PDB data and save to a local file. Returns the full path to the file,
 604    * or null if fetch fails. TODO: refactor to common with Jmol ? duplication
 605    *
 606    * @param processingEntry
 607    * @return
 608    * @throws Exception
 609    */
 610
 611   private void stashFoundChains(StructureFile pdb, String file)
 612   {
 613     for (int i = 0; i < pdb.getChains().size(); i++)
 614     {
 615       String chid = new String(
 616               pdb.getId() + ":" + pdb.getChains().elementAt(i).id);
 617       jmb.getChainNames().add(chid);
 618       jmb.getChainFile().put(chid, file);
 619     }
 620   }
 621
 622   private String fetchPdbFile(PDBEntry processingEntry) throws Exception
 623   {
 624     String filePath = null;
 625     Pdb pdbclient = new Pdb();
 626     AlignmentI pdbseq = null;
 627     String pdbid = processingEntry.getId();
 628     long handle = System.currentTimeMillis()
 629             + Thread.currentThread().hashCode();
 630
 631     /*
 632      * Write 'fetching PDB' progress on AlignFrame as we are not yet visible
 633      */
 634     String msg = MessageManager.formatMessage("status.fetching_pdb",
 635             new Object[]
 636             { pdbid });
 637     getAlignmentPanel().alignFrame.setProgressBar(msg, handle);
 638     // long hdl = startProgressBar(MessageManager.formatMessage(
 639     // "status.fetching_pdb", new Object[]
 640     // { pdbid }));
 641     try
 642     {
 643       pdbseq = pdbclient.getSequenceRecords(pdbid);
 644     } catch (OutOfMemoryError oomerror)
 645     {
 646       new OOMWarning("Retrieving PDB id " + pdbid, oomerror);
 647     } finally
 648     {
 649       msg = pdbid + " " + MessageManager.getString("label.state_completed");
 650       getAlignmentPanel().alignFrame.setProgressBar(msg, handle);
 651       // stopProgressBar(msg, hdl);
 652     }
 653     /*
 654      * If PDB data were saved and are not invalid (empty alignment), return the
 655      * file path.
 656      */
 657     if (pdbseq != null && pdbseq.getHeight() > 0)
 658     {
 659       // just use the file name from the first sequence's first PDBEntry
 660       filePath = new File(pdbseq.getSequenceAt(0).getAllPDBEntries()
 661               .elementAt(0).getFile()).getAbsolutePath();
 662       processingEntry.setFile(filePath);
 663     }
 664     return filePath;
 665   }
 666
 667   /**
 668    * Convenience method to update the progress bar if there is one. Be sure to
 669    * call stopProgressBar with the returned handle to remove the message.
 670    *
 671    * @param msg
 672    * @param handle
 673    */
 674   public long startProgressBar(String msg)
 675   {
 676     // TODO would rather have startProgress/stopProgress as the
 677     // IProgressIndicator interface
 678     long tm = random.nextLong();
 679     if (progressBar != null)
 680     {
 681       progressBar.setProgressBar(msg, tm);
 682     }
 683     return tm;
 684   }
 685
 686   /**
 687    * End the progress bar with the specified handle, leaving a message (if not
 688    * null) on the status bar
 689    *
 690    * @param msg
 691    * @param handle
 692    */
 693   public void stopProgressBar(String msg, long handle)
 694   {
 695     if (progressBar != null)
 696     {
 697       progressBar.setProgressBar(msg, handle);
 698     }
 699   }
 700
 701   @Override
 702   public void eps_actionPerformed(ActionEvent e)
 703   {
 704     throw new Error(MessageManager
 705             .getString("error.eps_generation_not_implemented"));
 706   }
 707
 708   @Override
 709   public void png_actionPerformed(ActionEvent e)
 710   {
 711     throw new Error(MessageManager
 712             .getString("error.png_generation_not_implemented"));
 713   }
 714
 715   @Override
 716   public void showHelp_actionPerformed(ActionEvent actionEvent)
 717   {
 718     try
 719     {
 720       BrowserLauncher
 721               .openURL("https://www.cgl.ucsf.edu/chimera/docs/UsersGuide");
 722     } catch (IOException ex)
 723     {
 724     }
 725   }
 726
 727   @Override
 728   public AAStructureBindingModel getBinding()
 729   {
 730     return jmb;
 731   }
 732
 733   /**
 734    * Ask Chimera to save its session to the designated file path, or to a
 735    * temporary file if the path is null. Returns the file path if successful,
 736    * else null.
 737    *
 738    * @param filepath
 739    * @see getStateInfo
 740    */
 741   protected String saveSession(String filepath)
 742   {
 743     String pathUsed = filepath;
 744     try
 745     {
 746       if (pathUsed == null)
 747       {
 748         File tempFile = File.createTempFile("chimera", ".py");
 749         tempFile.deleteOnExit();
 750         pathUsed = tempFile.getPath();
 751       }
 752       boolean result = jmb.saveSession(pathUsed);
 753       if (result)
 754       {
 755         this.chimeraSessionFile = pathUsed;
 756         return pathUsed;
 757       }
 758     } catch (IOException e)
 759     {
 760     }
 761     return null;
 762   }
 763
 764   /**
 765    * Returns a string representing the state of the Chimera session. This is
 766    * done by requesting Chimera to save its session to a temporary file, then
 767    * reading the file contents. Returns an empty string on any error.
 768    */
 769   @Override
 770   public String getStateInfo()
 771   {
 772     String sessionFile = saveSession(null);
 773     if (sessionFile == null)
 774     {
 775       return "";
 776     }
 777     InputStream is = null;
 778     try
 779     {
 780       File f = new File(sessionFile);
 781       byte[] bytes = new byte[(int) f.length()];
 782       is = new FileInputStream(sessionFile);
 783       is.read(bytes);
 784       return new String(bytes);
 785     } catch (IOException e)
 786     {
 787       return "";
 788     } finally
 789     {
 790       if (is != null)
 791       {
 792         try
 793         {
 794           is.close();
 795         } catch (IOException e)
 796         {
 797           // ignore
 798         }
 799       }
 800     }
 801   }
 802
 803   @Override
 804   protected void fitToWindow_actionPerformed()
 805   {
 806     jmb.focusView();
 807   }
 808
 809   @Override
 810   public ViewerType getViewerType()
 811   {
 812     return ViewerType.CHIMERA;
 813   }
 814
 815   @Override
 816   protected String getViewerName()
 817   {
 818     return "Chimera";
 819   }
 820
 821   /**
 822    * Sends commands to align structures according to associated alignment(s).
 823    *
 824    * @return
 825    */
 826   @Override
 827   protected String alignStructs_withAllAlignPanels()
 828   {
 829     String reply = super.alignStructs_withAllAlignPanels();
 830     statusBar.setText(
 831             reply == null ? " " : "Superposition failed: " + reply);
 832     return reply;
 833   }
 834
 835   @Override
 836   protected IProgressIndicator getIProgressIndicator()
 837   {
 838     return progressBar;
 839   }
 840 }