src/jalview/gui/StructureViewerBase.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.bin.Cache;
  25 import jalview.datamodel.Alignment;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.HiddenColumns;
  28 import jalview.datamodel.PDBEntry;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.gui.StructureViewer.ViewerType;
  31 import jalview.gui.ViewSelectionMenu.ViewSetProvider;
  32 import jalview.io.DataSourceType;
  33 import jalview.io.JalviewFileChooser;
  34 import jalview.io.JalviewFileView;
  35 import jalview.jbgui.GStructureViewer;
  36 import jalview.schemes.ColourSchemeI;
  37 import jalview.schemes.ColourSchemes;
  38 import jalview.structure.StructureMapping;
  39 import jalview.structures.models.AAStructureBindingModel;
  40 import jalview.util.MessageManager;
  41
  42 import java.awt.Color;
  43 import java.awt.Component;
  44 import java.awt.event.ActionEvent;
  45 import java.awt.event.ActionListener;
  46 import java.awt.event.ItemEvent;
  47 import java.awt.event.ItemListener;
  48 import java.io.BufferedReader;
  49 import java.io.File;
  50 import java.io.FileOutputStream;
  51 import java.io.FileReader;
  52 import java.io.IOException;
  53 import java.io.PrintWriter;
  54 import java.util.ArrayList;
  55 import java.util.List;
  56 import java.util.Vector;
  57
  58 import javax.swing.ButtonGroup;
  59 import javax.swing.JCheckBoxMenuItem;
  60 import javax.swing.JColorChooser;
  61 import javax.swing.JMenu;
  62 import javax.swing.JMenuItem;
  63 import javax.swing.JRadioButtonMenuItem;
  64 import javax.swing.event.MenuEvent;
  65 import javax.swing.event.MenuListener;
  66
  67 /**
  68  * Base class with common functionality for JMol, Chimera or other structure
  69  * viewers.
  70  *
  71  * @author gmcarstairs
  72  *
  73  */
  74 public abstract class StructureViewerBase extends GStructureViewer
  75         implements Runnable, ViewSetProvider
  76 {
  77   /*
  78    * names for colour options (additional to Jalview colour schemes)
  79    */
  80   enum ViewerColour
  81   {
  82     BySequence, ByChain, ChargeCysteine, ByViewer
  83   }
  84
  85   /**
  86    * list of sequenceSet ids associated with the view
  87    */
  88   protected List<String> _aps = new ArrayList<>();
  89
  90   /**
  91    * list of alignment panels to use for superposition
  92    */
  93   protected Vector<AlignmentPanel> _alignwith = new Vector<>();
  94
  95   /**
  96    * list of alignment panels that are used for colouring structures by aligned
  97    * sequences
  98    */
  99   protected Vector<AlignmentPanel> _colourwith = new Vector<>();
 100
 101   private String viewId = null;
 102
 103   private AlignmentPanel ap;
 104
 105   protected boolean alignAddedStructures = false;
 106
 107   protected volatile boolean _started = false;
 108
 109   protected volatile boolean addingStructures = false;
 110
 111   protected Thread worker = null;
 112
 113   protected boolean allChainsSelected = false;
 114
 115   protected JMenu viewSelectionMenu;
 116
 117   /**
 118    * set after sequence colouring has been applied for this structure viewer.
 119    * used to determine if the final sequence/structure mapping has been
 120    * determined
 121    */
 122   protected volatile boolean seqColoursApplied = false;
 123
 124   /**
 125    * Default constructor
 126    */
 127   public StructureViewerBase()
 128   {
 129     super();
 130   }
 131
 132   /**
 133    * @return true if added structures should be aligned to existing one(s)
 134    */
 135   @Override
 136   public boolean isAlignAddedStructures()
 137   {
 138     return alignAddedStructures;
 139   }
 140
 141   /**
 142    *
 143    * @param true
 144    *          if added structures should be aligned to existing one(s)
 145    */
 146   @Override
 147   public void setAlignAddedStructures(boolean alignAdded)
 148   {
 149     alignAddedStructures = alignAdded;
 150   }
 151
 152   /**
 153    *
 154    * @param ap2
 155    * @return true if this Jmol instance is linked with the given alignPanel
 156    */
 157   public boolean isLinkedWith(AlignmentPanel ap2)
 158   {
 159     return _aps.contains(ap2.av.getSequenceSetId());
 160   }
 161
 162   public boolean isUsedforaligment(AlignmentPanel ap2)
 163   {
 164
 165     return (_alignwith != null) && _alignwith.contains(ap2);
 166   }
 167
 168   public boolean isUsedforcolourby(AlignmentPanel ap2)
 169   {
 170     return (_colourwith != null) && _colourwith.contains(ap2);
 171   }
 172
 173   /**
 174    *
 175    * @return TRUE if the view is NOT being coloured by the alignment colours.
 176    */
 177   public boolean isColouredByViewer()
 178   {
 179     return !getBinding().isColourBySequence();
 180   }
 181
 182   public String getViewId()
 183   {
 184     if (viewId == null)
 185     {
 186       viewId = System.currentTimeMillis() + "." + this.hashCode();
 187     }
 188     return viewId;
 189   }
 190
 191   protected void setViewId(String viewId)
 192   {
 193     this.viewId = viewId;
 194   }
 195
 196   public abstract String getStateInfo();
 197
 198   protected void buildActionMenu()
 199   {
 200     if (_alignwith == null)
 201     {
 202       _alignwith = new Vector<>();
 203     }
 204     if (_alignwith.size() == 0 && ap != null)
 205     {
 206       _alignwith.add(ap);
 207     }
 208     ;
 209     for (Component c : viewerActionMenu.getMenuComponents())
 210     {
 211       if (c != alignStructs)
 212       {
 213         viewerActionMenu.remove((JMenuItem) c);
 214       }
 215     }
 216   }
 217
 218   public AlignmentPanel getAlignmentPanel()
 219   {
 220     return ap;
 221   }
 222
 223   protected void setAlignmentPanel(AlignmentPanel alp)
 224   {
 225     this.ap = alp;
 226   }
 227
 228   @Override
 229   public AlignmentPanel[] getAllAlignmentPanels()
 230   {
 231     AlignmentPanel[] t, list = new AlignmentPanel[0];
 232     for (String setid : _aps)
 233     {
 234       AlignmentPanel[] panels = PaintRefresher.getAssociatedPanels(setid);
 235       if (panels != null)
 236       {
 237         t = new AlignmentPanel[list.length + panels.length];
 238         System.arraycopy(list, 0, t, 0, list.length);
 239         System.arraycopy(panels, 0, t, list.length, panels.length);
 240         list = t;
 241       }
 242     }
 243
 244     return list;
 245   }
 246
 247   /**
 248    * set the primary alignmentPanel reference and add another alignPanel to the
 249    * list of ones to use for colouring and aligning
 250    *
 251    * @param nap
 252    */
 253   public void addAlignmentPanel(AlignmentPanel nap)
 254   {
 255     if (getAlignmentPanel() == null)
 256     {
 257       setAlignmentPanel(nap);
 258     }
 259     if (!_aps.contains(nap.av.getSequenceSetId()))
 260     {
 261       _aps.add(nap.av.getSequenceSetId());
 262     }
 263   }
 264
 265   /**
 266    * remove any references held to the given alignment panel
 267    *
 268    * @param nap
 269    */
 270   public void removeAlignmentPanel(AlignmentPanel nap)
 271   {
 272     try
 273     {
 274       _alignwith.remove(nap);
 275       _colourwith.remove(nap);
 276       if (getAlignmentPanel() == nap)
 277       {
 278         setAlignmentPanel(null);
 279         for (AlignmentPanel aps : getAllAlignmentPanels())
 280         {
 281           if (aps != nap)
 282           {
 283             setAlignmentPanel(aps);
 284             break;
 285           }
 286         }
 287       }
 288     } catch (Exception ex)
 289     {
 290     }
 291     if (getAlignmentPanel() != null)
 292     {
 293       buildActionMenu();
 294     }
 295   }
 296
 297   public void useAlignmentPanelForSuperposition(AlignmentPanel nap)
 298   {
 299     addAlignmentPanel(nap);
 300     if (!_alignwith.contains(nap))
 301     {
 302       _alignwith.add(nap);
 303     }
 304   }
 305
 306   public void excludeAlignmentPanelForSuperposition(AlignmentPanel nap)
 307   {
 308     if (_alignwith.contains(nap))
 309     {
 310       _alignwith.remove(nap);
 311     }
 312   }
 313
 314   public void useAlignmentPanelForColourbyseq(AlignmentPanel nap,
 315           boolean enableColourBySeq)
 316   {
 317     useAlignmentPanelForColourbyseq(nap);
 318     getBinding().setColourBySequence(enableColourBySeq);
 319     seqColour.setSelected(enableColourBySeq);
 320     viewerColour.setSelected(!enableColourBySeq);
 321   }
 322
 323   public void useAlignmentPanelForColourbyseq(AlignmentPanel nap)
 324   {
 325     addAlignmentPanel(nap);
 326     if (!_colourwith.contains(nap))
 327     {
 328       _colourwith.add(nap);
 329     }
 330   }
 331
 332   public void excludeAlignmentPanelForColourbyseq(AlignmentPanel nap)
 333   {
 334     if (_colourwith.contains(nap))
 335     {
 336       _colourwith.remove(nap);
 337     }
 338   }
 339
 340   public abstract ViewerType getViewerType();
 341
 342   protected abstract IProgressIndicator getIProgressIndicator();
 343
 344   /**
 345    * add a new structure (with associated sequences and chains) to this viewer,
 346    * retrieving it if necessary first.
 347    *
 348    * @param pdbentry
 349    * @param seqs
 350    * @param chains
 351    * @param align
 352    *          if true, new structure(s) will be aligned using associated
 353    *          alignment
 354    * @param alignFrame
 355    */
 356   protected void addStructure(final PDBEntry pdbentry,
 357           final SequenceI[] seqs, final String[] chains,
 358           final IProgressIndicator alignFrame)
 359   {
 360     if (pdbentry.getFile() == null)
 361     {
 362       if (worker != null && worker.isAlive())
 363       {
 364         // a retrieval is in progress, wait around and add ourselves to the
 365         // queue.
 366         new Thread(new Runnable()
 367         {
 368           @Override
 369           public void run()
 370           {
 371             while (worker != null && worker.isAlive() && _started)
 372             {
 373               try
 374               {
 375                 Thread.sleep(100 + ((int) Math.random() * 100));
 376
 377               } catch (Exception e)
 378               {
 379               }
 380             }
 381             // and call ourselves again.
 382             addStructure(pdbentry, seqs, chains, alignFrame);
 383           }
 384         }).start();
 385         return;
 386       }
 387     }
 388     // otherwise, start adding the structure.
 389     getBinding().addSequenceAndChain(new PDBEntry[] { pdbentry },
 390             new SequenceI[][]
 391             { seqs }, new String[][] { chains });
 392     addingStructures = true;
 393     _started = false;
 394     worker = new Thread(this);
 395     worker.start();
 396     return;
 397   }
 398
 399   protected boolean hasPdbId(String pdbId)
 400   {
 401     return getBinding().hasPdbId(pdbId);
 402   }
 403
 404   /**
 405    * Returns a list of any viewer of the instantiated type. The list is
 406    * restricted to those linked to the given alignment panel if it is not null.
 407    */
 408   protected List<StructureViewerBase> getViewersFor(AlignmentPanel alp)
 409   {
 410     return Desktop.instance.getStructureViewers(alp, this.getClass());
 411   }
 412
 413   @Override
 414   public void addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
 415           String[] chains, final AlignmentViewPanel apanel, String pdbId)
 416   {
 417     /*
 418      * JAL-1742 exclude view with this structure already mapped (don't offer
 419      * to align chain B to chain A of the same structure); code may defend
 420      * against this possibility before we reach here
 421      */
 422     if (hasPdbId(pdbId))
 423     {
 424       return;
 425     }
 426     AlignmentPanel alignPanel = (AlignmentPanel) apanel; // Implementation error if this
 427                                                  // cast fails
 428     useAlignmentPanelForSuperposition(alignPanel);
 429     addStructure(pdbentry, seq, chains, alignPanel.alignFrame);
 430   }
 431
 432   /**
 433    * Adds mappings for the given sequences to an already opened PDB structure,
 434    * and updates any viewers that have the PDB file
 435    *
 436    * @param seq
 437    * @param chains
 438    * @param apanel
 439    * @param pdbFilename
 440    */
 441   public void addSequenceMappingsToStructure(SequenceI[] seq,
 442           String[] chains, final AlignmentViewPanel alpanel,
 443           String pdbFilename)
 444   {
 445     AlignmentPanel apanel = (AlignmentPanel) alpanel;
 446
 447     // TODO : Fix multiple seq to one chain issue here.
 448     /*
 449      * create the mappings
 450      */
 451     apanel.getStructureSelectionManager().setMapping(seq, chains,
 452             pdbFilename, DataSourceType.FILE, getIProgressIndicator());
 453
 454     /*
 455      * alert the FeatureRenderer to show new (PDB RESNUM) features
 456      */
 457     if (apanel.getSeqPanel().seqCanvas.fr != null)
 458     {
 459       apanel.getSeqPanel().seqCanvas.fr.featuresAdded();
 460       // note - we don't do a refresh for structure here because we do it
 461       // explicitly for all panels later on
 462       apanel.paintAlignment(true, false);
 463     }
 464
 465     /*
 466      * add the sequences to any other viewers (of the same type) for this pdb
 467      * file
 468      */
 469     // JBPNOTE: this looks like a binding routine, rather than a gui routine
 470     for (StructureViewerBase viewer : getViewersFor(null))
 471     {
 472       AAStructureBindingModel bindingModel = viewer.getBinding();
 473       for (int pe = 0; pe < bindingModel.getPdbCount(); pe++)
 474       {
 475         if (bindingModel.getPdbEntry(pe).getFile().equals(pdbFilename))
 476         {
 477           bindingModel.addSequence(pe, seq);
 478           viewer.addAlignmentPanel(apanel);
 479           /*
 480            * add it to the set of alignments used for colouring structure by
 481            * sequence
 482            */
 483           viewer.useAlignmentPanelForColourbyseq(apanel);
 484           viewer.buildActionMenu();
 485           apanel.getStructureSelectionManager()
 486                   .sequenceColoursChanged(apanel);
 487           break;
 488         }
 489       }
 490     }
 491   }
 492
 493   @Override
 494   public boolean addAlreadyLoadedFile(SequenceI[] seq, String[] chains,
 495           final AlignmentViewPanel apanel, String pdbId)
 496   {
 497     String alreadyMapped = apanel.getStructureSelectionManager()
 498             .alreadyMappedToFile(pdbId);
 499
 500     if (alreadyMapped == null)
 501     {
 502       return false;
 503     }
 504
 505     addSequenceMappingsToStructure(seq, chains, apanel, alreadyMapped);
 506     return true;
 507   }
 508
 509   void setChainMenuItems(List<String> chainNames)
 510   {
 511     chainMenu.removeAll();
 512     if (chainNames == null || chainNames.isEmpty())
 513     {
 514       return;
 515     }
 516     JMenuItem menuItem = new JMenuItem(
 517             MessageManager.getString("label.all"));
 518     menuItem.addActionListener(new ActionListener()
 519     {
 520       @Override
 521       public void actionPerformed(ActionEvent evt)
 522       {
 523         allChainsSelected = true;
 524         for (int i = 0; i < chainMenu.getItemCount(); i++)
 525         {
 526           if (chainMenu.getItem(i) instanceof JCheckBoxMenuItem)
 527           {
 528             ((JCheckBoxMenuItem) chainMenu.getItem(i)).setSelected(true);
 529           }
 530         }
 531         showSelectedChains();
 532         allChainsSelected = false;
 533       }
 534     });
 535
 536     chainMenu.add(menuItem);
 537
 538     for (String chain : chainNames)
 539     {
 540       menuItem = new JCheckBoxMenuItem(chain, true);
 541       menuItem.addItemListener(new ItemListener()
 542       {
 543         @Override
 544         public void itemStateChanged(ItemEvent evt)
 545         {
 546           if (!allChainsSelected)
 547           {
 548             showSelectedChains();
 549           }
 550         }
 551       });
 552
 553       chainMenu.add(menuItem);
 554     }
 555   }
 556
 557   abstract void showSelectedChains();
 558
 559   /**
 560    * Action on selecting one of Jalview's registered colour schemes
 561    */
 562   @Override
 563   public void changeColour_actionPerformed(String colourSchemeName)
 564   {
 565     AlignmentI al = getAlignmentPanel().av.getAlignment();
 566     ColourSchemeI cs = ColourSchemes.getInstance()
 567             .getColourScheme(colourSchemeName, al, null);
 568     getBinding().setJalviewColourScheme(cs);
 569   }
 570
 571   /**
 572    * Builds the colour menu
 573    */
 574   protected void buildColourMenu()
 575   {
 576     colourMenu.removeAll();
 577     AlignmentI al = getAlignmentPanel().av.getAlignment();
 578
 579     /*
 580      * add colour by sequence, by chain, by charge and cysteine
 581      */
 582     colourMenu.add(seqColour);
 583     colourMenu.add(chainColour);
 584     colourMenu.add(chargeColour);
 585     chargeColour.setEnabled(!al.isNucleotide());
 586
 587     /*
 588      * add all 'simple' (per-residue) colour schemes registered to Jalview
 589      */
 590     ButtonGroup itemGroup = ColourMenuHelper.addMenuItems(colourMenu, this,
 591             al, true);
 592
 593     /*
 594      * add 'colour by viewer' (menu item text is set in subclasses)
 595      */
 596     viewerColour.setSelected(false);
 597     viewerColour.addActionListener(new ActionListener()
 598     {
 599       @Override
 600       public void actionPerformed(ActionEvent actionEvent)
 601       {
 602         viewerColour_actionPerformed(actionEvent);
 603       }
 604     });
 605     colourMenu.add(viewerColour);
 606
 607     /*
 608      * add 'set background colour'
 609      */
 610     JMenuItem backGround = new JMenuItem();
 611     backGround
 612             .setText(MessageManager.getString("action.background_colour"));
 613     backGround.addActionListener(new ActionListener()
 614     {
 615       @Override
 616       public void actionPerformed(ActionEvent actionEvent)
 617       {
 618         background_actionPerformed(actionEvent);
 619       }
 620     });
 621     colourMenu.add(backGround);
 622
 623     /*
 624      * add colour buttons to a group so their selection is
 625      * mutually exclusive (background colour is a separate option)
 626      */
 627     itemGroup.add(seqColour);
 628     itemGroup.add(chainColour);
 629     itemGroup.add(chargeColour);
 630     itemGroup.add(viewerColour);
 631   }
 632
 633   /**
 634    * Construct menu items
 635    */
 636   protected void initMenus()
 637   {
 638     AAStructureBindingModel binding = getBinding();
 639
 640     seqColour = new JRadioButtonMenuItem();
 641     seqColour.setText(MessageManager.getString("action.by_sequence"));
 642     seqColour.setName(ViewerColour.BySequence.name());
 643     seqColour.setSelected(binding.isColourBySequence());
 644     seqColour.addActionListener(new ActionListener()
 645     {
 646       @Override
 647       public void actionPerformed(ActionEvent actionEvent)
 648       {
 649         seqColour_actionPerformed(actionEvent);
 650       }
 651     });
 652
 653     chainColour = new JRadioButtonMenuItem();
 654     chainColour.setText(MessageManager.getString("action.by_chain"));
 655     chainColour.setName(ViewerColour.ByChain.name());
 656     chainColour.addActionListener(new ActionListener()
 657     {
 658       @Override
 659       public void actionPerformed(ActionEvent actionEvent)
 660       {
 661         chainColour_actionPerformed(actionEvent);
 662       }
 663     });
 664
 665     chargeColour = new JRadioButtonMenuItem();
 666     chargeColour.setText(MessageManager.getString("label.charge_cysteine"));
 667     chargeColour.setName(ViewerColour.ChargeCysteine.name());
 668     chargeColour.addActionListener(new ActionListener()
 669     {
 670       @Override
 671       public void actionPerformed(ActionEvent actionEvent)
 672       {
 673         chargeColour_actionPerformed(actionEvent);
 674       }
 675     });
 676
 677     viewerColour = new JRadioButtonMenuItem();
 678     // text is set in overrides of this method
 679     viewerColour.setName(ViewerColour.ByViewer.name());
 680     viewerColour.setSelected(!binding.isColourBySequence());
 681
 682     if (_colourwith == null)
 683     {
 684       _colourwith = new Vector<>();
 685     }
 686     if (_alignwith == null)
 687     {
 688       _alignwith = new Vector<>();
 689     }
 690
 691     ViewSelectionMenu seqColourBy = new ViewSelectionMenu(
 692             MessageManager.getString("label.colour_by"), this, _colourwith,
 693             new ItemListener()
 694             {
 695               @Override
 696               public void itemStateChanged(ItemEvent e)
 697               {
 698                 if (!seqColour.isSelected())
 699                 {
 700                   seqColour.doClick();
 701                 }
 702                 else
 703                 {
 704                   // update the Chimera display now.
 705                   seqColour_actionPerformed(null);
 706                 }
 707               }
 708             });
 709     viewMenu.add(seqColourBy);
 710
 711     final ItemListener handler = new ItemListener()
 712     {
 713       @Override
 714       public void itemStateChanged(ItemEvent e)
 715       {
 716         alignStructs.setEnabled(!_alignwith.isEmpty());
 717         alignStructs.setToolTipText(MessageManager.formatMessage(
 718                 "label.align_structures_using_linked_alignment_views",
 719                 _alignwith.size()));
 720       }
 721     };
 722     viewSelectionMenu = new ViewSelectionMenu(
 723             MessageManager.getString("label.superpose_with"), this,
 724             _alignwith, handler);
 725     handler.itemStateChanged(null);
 726     viewerActionMenu.add(viewSelectionMenu, 0);
 727     viewerActionMenu.addMenuListener(new MenuListener()
 728     {
 729       @Override
 730       public void menuSelected(MenuEvent e)
 731       {
 732         handler.itemStateChanged(null);
 733       }
 734
 735       @Override
 736       public void menuDeselected(MenuEvent e)
 737       {
 738       }
 739
 740       @Override
 741       public void menuCanceled(MenuEvent e)
 742       {
 743       }
 744     });
 745
 746     buildColourMenu();
 747   }
 748
 749   @Override
 750   public void setJalviewColourScheme(ColourSchemeI cs)
 751   {
 752     getBinding().setJalviewColourScheme(cs);
 753   }
 754
 755   /**
 756    * Sends commands to the structure viewer to superimpose structures based on
 757    * currently associated alignments. May optionally return an error message for
 758    * the operation.
 759    */
 760   @Override
 761   protected String alignStructs_actionPerformed(ActionEvent actionEvent)
 762   {
 763     return alignStructs_withAllAlignPanels();
 764   }
 765
 766   protected String alignStructs_withAllAlignPanels()
 767   {
 768     if (getAlignmentPanel() == null)
 769     {
 770       return null;
 771     }
 772
 773     if (_alignwith.size() == 0)
 774     {
 775       _alignwith.add(getAlignmentPanel());
 776     }
 777
 778     String reply = null;
 779     try
 780     {
 781       AlignmentI[] als = new Alignment[_alignwith.size()];
 782       HiddenColumns[] alc = new HiddenColumns[_alignwith.size()];
 783       int[] alm = new int[_alignwith.size()];
 784       int a = 0;
 785
 786       for (AlignmentPanel alignPanel : _alignwith)
 787       {
 788         als[a] = alignPanel.av.getAlignment();
 789         alm[a] = -1;
 790         alc[a++] = alignPanel.av.getAlignment().getHiddenColumns();
 791       }
 792       reply = getBinding().superposeStructures(als, alm, alc);
 793       if (reply != null)
 794       {
 795         String text = MessageManager
 796                 .formatMessage("error.superposition_failed", reply);
 797         statusBar.setText(text);
 798       }
 799     } catch (Exception e)
 800     {
 801       StringBuffer sp = new StringBuffer();
 802       for (AlignmentPanel alignPanel : _alignwith)
 803       {
 804         sp.append("'" + alignPanel.alignFrame.getTitle() + "' ");
 805       }
 806       Cache.log.info("Couldn't align structures with the " + sp.toString()
 807               + "associated alignment panels.", e);
 808     }
 809     return reply;
 810   }
 811
 812   @Override
 813   public void background_actionPerformed(ActionEvent actionEvent)
 814   {
 815     Color col = JColorChooser.showDialog(this,
 816             MessageManager.getString("label.select_background_colour"),
 817             null);
 818     if (col != null)
 819     {
 820       getBinding().setBackgroundColour(col);
 821     }
 822   }
 823
 824   @Override
 825   public void viewerColour_actionPerformed(ActionEvent actionEvent)
 826   {
 827     if (viewerColour.isSelected())
 828     {
 829       // disable automatic sequence colouring.
 830       getBinding().setColourBySequence(false);
 831     }
 832   }
 833
 834   @Override
 835   public void chainColour_actionPerformed(ActionEvent actionEvent)
 836   {
 837     chainColour.setSelected(true);
 838     getBinding().colourByChain();
 839   }
 840
 841   @Override
 842   public void chargeColour_actionPerformed(ActionEvent actionEvent)
 843   {
 844     chargeColour.setSelected(true);
 845     getBinding().colourByCharge();
 846   }
 847
 848   @Override
 849   public void seqColour_actionPerformed(ActionEvent actionEvent)
 850   {
 851     AAStructureBindingModel binding = getBinding();
 852     binding.setColourBySequence(seqColour.isSelected());
 853     if (_colourwith == null)
 854     {
 855       _colourwith = new Vector<>();
 856     }
 857     if (binding.isColourBySequence())
 858     {
 859       if (!binding.isLoadingFromArchive())
 860       {
 861         if (_colourwith.size() == 0 && getAlignmentPanel() != null)
 862         {
 863           // Make the currently displayed alignment panel the associated view
 864           _colourwith.add(getAlignmentPanel().alignFrame.alignPanel);
 865         }
 866       }
 867       // Set the colour using the current view for the associated alignframe
 868       for (AlignmentPanel alignPanel : _colourwith)
 869       {
 870         binding.colourBySequence(alignPanel);
 871       }
 872       seqColoursApplied = true;
 873     }
 874   }
 875
 876   @Override
 877   public void pdbFile_actionPerformed(ActionEvent actionEvent)
 878   {
 879     JalviewFileChooser chooser = new JalviewFileChooser(
 880             Cache.getProperty("LAST_DIRECTORY"));
 881
 882     chooser.setFileView(new JalviewFileView());
 883     chooser.setDialogTitle(MessageManager.getString("label.save_pdb_file"));
 884     chooser.setToolTipText(MessageManager.getString("action.save"));
 885
 886     int value = chooser.showSaveDialog(this);
 887
 888     if (value == JalviewFileChooser.APPROVE_OPTION)
 889     {
 890       BufferedReader in = null;
 891       try
 892       {
 893         // TODO: cope with multiple PDB files in view
 894         in = new BufferedReader(
 895                 new FileReader(getBinding().getStructureFiles()[0]));
 896         File outFile = chooser.getSelectedFile();
 897
 898         PrintWriter out = new PrintWriter(new FileOutputStream(outFile));
 899         String data;
 900         while ((data = in.readLine()) != null)
 901         {
 902           if (!(data.indexOf("<PRE>") > -1 || data.indexOf("</PRE>") > -1))
 903           {
 904             out.println(data);
 905           }
 906         }
 907         out.close();
 908       } catch (Exception ex)
 909       {
 910         ex.printStackTrace();
 911       } finally
 912       {
 913         if (in != null)
 914         {
 915           try
 916           {
 917             in.close();
 918           } catch (IOException e)
 919           {
 920             // ignore
 921           }
 922         }
 923       }
 924     }
 925   }
 926
 927   @Override
 928   public void viewMapping_actionPerformed(ActionEvent actionEvent)
 929   {
 930     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 931     try
 932     {
 933       cap.appendText(getBinding().printMappings());
 934     } catch (OutOfMemoryError e)
 935     {
 936       new OOMWarning(
 937               "composing sequence-structure alignments for display in text box.",
 938               e);
 939       cap.dispose();
 940       return;
 941     }
 942     Desktop.addInternalFrame(cap,
 943             MessageManager.getString("label.pdb_sequence_mapping"), 550,
 944             600);
 945   }
 946
 947   protected abstract String getViewerName();
 948
 949   /**
 950    * Configures the title and menu items of the viewer panel.
 951    */
 952   @Override
 953   public void updateTitleAndMenus()
 954   {
 955     AAStructureBindingModel binding = getBinding();
 956     if (binding.hasFileLoadingError())
 957     {
 958       repaint();
 959       return;
 960     }
 961     setChainMenuItems(binding.getChainNames());
 962
 963     this.setTitle(binding.getViewerTitle(getViewerName(), true));
 964
 965     /*
 966      * enable 'Superpose with' if more than one mapped structure
 967      */
 968     viewSelectionMenu.setEnabled(false);
 969     if (getBinding().getStructureFiles().length > 1
 970             && getBinding().getSequence().length > 1)
 971     {
 972       viewSelectionMenu.setEnabled(true);
 973     }
 974
 975     /*
 976      * Show action menu if it has any enabled items
 977      */
 978     viewerActionMenu.setVisible(false);
 979     for (int i = 0; i < viewerActionMenu.getItemCount(); i++)
 980     {
 981       if (viewerActionMenu.getItem(i).isEnabled())
 982       {
 983         viewerActionMenu.setVisible(true);
 984         break;
 985       }
 986     }
 987
 988     if (!binding.isLoadingFromArchive())
 989     {
 990       seqColour_actionPerformed(null);
 991     }
 992   }
 993
 994   @Override
 995   public String toString()
 996   {
 997     return getTitle();
 998   }
 999
1000   @Override
1001   public boolean hasMapping()
1002   {
1003     if (worker != null && (addingStructures || _started))
1004     {
1005       return false;
1006     }
1007     if (getBinding() == null)
1008     {
1009       if (_aps == null || _aps.size() == 0)
1010       {
1011         // viewer has been closed, but we did at some point run.
1012         return true;
1013       }
1014       return false;
1015     }
1016     String[] pdbids = getBinding().getStructureFiles();
1017     if (pdbids == null)
1018     {
1019       return false;
1020     }
1021     int p=0;
1022     for (String pdbid:pdbids) {
1023       StructureMapping sm[] = getBinding().getSsm().getMapping(pdbid);
1024       if (sm!=null && sm.length>0 && sm[0]!=null) {
1025         p++;
1026       }
1027     }
1028     // only return true if there is a mapping for every structure file we have loaded
1029     if (p == 0 || p != pdbids.length)
1030     {
1031       return false;
1032     }
1033     // and that coloring has been applied
1034     return seqColoursApplied;
1035   }
1036
1037 }