Merge branch 'Jalview-BH/JAL-3026-JAL-3063-JAXB' into trialMerge
[jalview.git] / src / jalview / gui / AlignFrame.java
index 145653a..56ef63b 100644 (file)
@@ -26,7 +26,7 @@ import jalview.analysis.CrossRef;
 import jalview.analysis.Dna;
 import jalview.analysis.ParseProperties;
 import jalview.analysis.SequenceIdMatcher;
-import jalview.api.AlignExportSettingI;
+import jalview.api.AlignExportSettingsI;
 import jalview.api.AlignViewControllerGuiI;
 import jalview.api.AlignViewControllerI;
 import jalview.api.AlignViewportI;
@@ -45,7 +45,7 @@ import jalview.commands.RemoveGapColCommand;
 import jalview.commands.RemoveGapsCommand;
 import jalview.commands.SlideSequencesCommand;
 import jalview.commands.TrimRegionCommand;
-import jalview.datamodel.AlignExportSettingBeanI;
+import jalview.datamodel.AlignExportSettingsAdapter;
 import jalview.datamodel.AlignedCodonFrame;
 import jalview.datamodel.Alignment;
 import jalview.datamodel.AlignmentAnnotation;
@@ -125,7 +125,6 @@ import java.awt.event.MouseEvent;
 import java.awt.print.PageFormat;
 import java.awt.print.PrinterJob;
 import java.beans.PropertyChangeEvent;
-import java.beans.PropertyChangeListener;
 import java.io.File;
 import java.io.FileWriter;
 import java.io.PrintWriter;
@@ -157,8 +156,7 @@ import javax.swing.SwingUtilities;
  * @version $Revision$
  */
 public class AlignFrame extends GAlignFrame implements DropTargetListener,
-        IProgressIndicator, AlignViewControllerGuiI, ColourChangeListener,
-        PropertyChangeListener
+        IProgressIndicator, AlignViewControllerGuiI, ColourChangeListener
 {
 
   public static final int DEFAULT_WIDTH = 700;
@@ -334,34 +332,6 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     init();
   }
 
-  @Override
-  public void propertyChange(PropertyChangeEvent evt)
-  {
-    Desktop.getDesktop().propertyChange(evt);
-  }
-
-  /**
-   * BH 2018
-   * 
-   * @return true if we have any features
-   */
-  @Override
-  protected boolean haveAlignmentFeatures()
-  {
-    AlignmentI alignment = getViewport().getAlignment();
-
-    for (int i = 0; i < alignment.getHeight(); i++)
-    {
-      SequenceI seq = alignment.getSequenceAt(i);
-      for (String group : seq.getFeatures().getFeatureGroups(true))
-      {
-        if (group != null)
-          return true;
-      }
-    }
-    return false;
-  }
-
   /**
    * initalise the alignframe from the underlying viewport data and the
    * configurations
@@ -704,7 +674,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
         case KeyEvent.VK_F2:
           viewport.cursorMode = !viewport.cursorMode;
-          statusBar.setText(MessageManager
+          setStatus(MessageManager
                   .formatMessage("label.keyboard_editing_mode", new String[]
                   { (viewport.cursorMode ? "on" : "off") }));
           if (viewport.cursorMode)
@@ -790,9 +760,9 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
     int aSize = alignPanels.size();
 
-    tabbedPane.setVisible(aSize > 1 || ap.av.viewName != null);
+    tabbedPane.setVisible(aSize > 1 || ap.av.getViewName() != null);
 
-    if (aSize == 1 && ap.av.viewName == null)
+    if (aSize == 1 && ap.av.getViewName() == null)
     {
       this.getContentPane().add(ap, BorderLayout.CENTER);
     }
@@ -805,7 +775,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
       expandViews.setEnabled(true);
       gatherViews.setEnabled(true);
-      tabbedPane.addTab(ap.av.viewName, ap);
+      tabbedPane.addTab(ap.av.getViewName(), ap);
 
       ap.setVisible(false);
     }
@@ -828,7 +798,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     gatherViews.setEnabled(true);
     tabbedPane.setVisible(true);
     AlignmentPanel first = alignPanels.get(0);
-    tabbedPane.addTab(first.av.viewName, first);
+    tabbedPane.addTab(first.av.getViewName(), first);
     this.getContentPane().add(tabbedPane, BorderLayout.CENTER);
   }
 
@@ -929,7 +899,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
    * @param av
    *          AlignViewport
    */
-  void setMenusFromViewport(AlignViewport av)
+  public void setMenusFromViewport(AlignViewport av)
   {
     padGapsMenuitem.setSelected(av.isPadGaps());
     colourTextMenuItem.setSelected(av.isShowColourText());
@@ -1040,9 +1010,9 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
   }
 
   @Override
-  public void fetchSequence_actionPerformed(ActionEvent e)
+  public void fetchSequence_actionPerformed()
   {
-    new jalview.gui.SequenceFetcher(this);
+    new SequenceFetcher(this);
   }
 
   @Override
@@ -1180,37 +1150,39 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
     int value = chooser.showSaveDialog(this);
 
-    if (value == JalviewFileChooser.APPROVE_OPTION)
+    if (value != JalviewFileChooser.APPROVE_OPTION)
     {
+      return;
+    }
+    currentFileFormat = chooser.getSelectedFormat();
+    // todo is this (2005) test now obsolete - value is never null?
+    while (currentFileFormat == null)
+    {
+      JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+              MessageManager
+                      .getString("label.select_file_format_before_saving"),
+              MessageManager.getString("label.file_format_not_specified"),
+              JvOptionPane.WARNING_MESSAGE);
       currentFileFormat = chooser.getSelectedFormat();
-      while (currentFileFormat == null)
+      value = chooser.showSaveDialog(this);
+      if (value != JalviewFileChooser.APPROVE_OPTION)
       {
-        JvOptionPane.showInternalMessageDialog(Desktop.desktop,
-                MessageManager.getString(
-                        "label.select_file_format_before_saving"),
-                MessageManager.getString("label.file_format_not_specified"),
-                JvOptionPane.WARNING_MESSAGE);
-        currentFileFormat = chooser.getSelectedFormat();
-        value = chooser.showSaveDialog(this);
-        if (value != JalviewFileChooser.APPROVE_OPTION)
-        {
-          return;
-        }
+        return;
       }
+    }
 
-      fileName = chooser.getSelectedFile().getPath();
+    fileName = chooser.getSelectedFile().getPath();
 
-      Cache.setProperty("DEFAULT_FILE_FORMAT", currentFileFormat.getName());
-      Cache.setProperty("LAST_DIRECTORY", fileName);
-      saveAlignment(fileName, currentFileFormat);
-    }
+    Cache.setProperty("DEFAULT_FILE_FORMAT", currentFileFormat.getName());
+    Cache.setProperty("LAST_DIRECTORY", fileName);
+    saveAlignment(fileName, currentFileFormat);
   }
 
-  private boolean lastSaveSuccessful = false;
+  boolean lastSaveSuccessful = false;
 
-  private FileFormatI lastFormatSaved;
+  FileFormatI lastFormatSaved;
 
-  private String lastFilenameSaved;
+  String lastFilenameSaved;
 
   /**
    * Raise a dialog or status message for the last call to saveAlignment.
@@ -1231,7 +1203,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     else
     {
 
-      statusBar.setText(MessageManager.formatMessage(
+      setStatus(MessageManager.formatMessage(
               "label.successfully_saved_to_file_in_format", new Object[]
               { lastFilenameSaved, lastFormatSaved }));
 
@@ -1239,113 +1211,131 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     return lastSaveSuccessful;
   }
 
+  /**
+   * Saves the alignment to the specified file path, in the specified format,
+   * which may be an alignment format, or Jalview project format. If the
+   * alignment has hidden regions, or the format is one capable of including
+   * non-sequence data (features, annotations, groups), then the user may be
+   * prompted to specify what to include in the output.
+   * 
+   * @param file
+   * @param format
+   */
   public void saveAlignment(String file, FileFormatI format)
   {
     lastSaveSuccessful = false;
     lastFilenameSaved = file;
     lastFormatSaved = format;
-    AlignFrame us = this;
+
     if (FileFormat.Jalview.equals(format))
     {
       String shortName = title;
-
-      if (shortName.indexOf(java.io.File.separatorChar) > -1)
+      if (shortName.indexOf(File.separatorChar) > -1)
       {
         shortName = shortName.substring(
-                shortName.lastIndexOf(java.io.File.separatorChar) + 1);
+                shortName.lastIndexOf(File.separatorChar) + 1);
       }
-
-      lastSaveSuccessful = new Jalview2XML().saveAlignment(this, file,
+      lastSaveSuccessful = new jalview.project.Jalview2XML().saveAlignment(this, file,
               shortName);
+      
+      statusBar.setText(MessageManager.formatMessage(
+              "label.successfully_saved_to_file_in_format", new Object[]
+              { fileName, format }));
+      
+      return;
     }
-    else
+
+    AlignExportSettingsI options = new AlignExportSettingsAdapter(false);
+    RunResponse cancelAction = new RunResponse(JvOptionPane.CANCEL_OPTION)
     {
-      AlignExportSettingI settings = getAlignmentForExport(format,
-              alignPanel, null);
-      settings.addActionListener(new ActionListener()
+      @Override
+      public void run()
       {
-        @Override
-        public void actionPerformed(ActionEvent e)
+        lastSaveSuccessful = false;
+      }
+    };
+    RunResponse outputAction = new RunResponse(JvOptionPane.OK_OPTION)
+    {
+      @Override
+      public void run()
+      {
+        // todo defer this to inside formatSequences (or later)
+        AlignmentExportData exportData = viewport
+                .getAlignExportData(options);
+        String output = new FormatAdapter(alignPanel, options)
+                .formatSequences(format, exportData.getAlignment(),
+                        exportData.getOmitHidden(),
+                        exportData.getStartEndPostions(),
+                        viewport.getAlignment().getHiddenColumns());
+        if (output == null)
         {
-
-          if (settings.isCancelled())
+          lastSaveSuccessful = false;
+        }
+        else
+        {
+          try
           {
-            lastSaveSuccessful = false;
-            return;
-          }
-          AlignmentExportData exportData = settings.getAlignExportData();
-          FormatAdapter f = new FormatAdapter(alignPanel,
-                  exportData.getSettings());
-          String output = f.formatSequences(format,
-                  exportData.getAlignment(), // class
-                                             // cast
-                                             // exceptions
-                                             // will
-                  // occur in the distant future
-                  exportData.getOmitHidden(),
-                  exportData.getStartEndPostions(),
-                  f.getCacheSuffixDefault(format),
-                  viewport.getAlignment().getHiddenColumns());
-
-          if (output == null)
+            PrintWriter out = new PrintWriter(new FileWriter(file));
+            out.print(output);
+            out.close();
+            AlignFrame.this.setTitle(file);
+            setStatus(MessageManager.formatMessage(
+                    "label.successfully_saved_to_file_in_format",
+                    new Object[]
+                    { fileName, format.getName() }));
+          } catch (Exception ex)
           {
             lastSaveSuccessful = false;
-          }
-          else
-          {
-            try
-            {
-              PrintWriter out = new PrintWriter(new FileWriter(file));
-
-              out.print(output);
-              out.close();
-              us.setTitle(file);
-              statusBar.setText(MessageManager.formatMessage(
-                      "label.successfully_saved_to_file_in_format",
-                      new Object[]
-                      { fileName, format.getName() }));
-            } catch (Exception ex)
-            {
-              lastSaveSuccessful = false;
-              ex.printStackTrace();
-            }
+            ex.printStackTrace();
           }
         }
-      });
+      }
+    };
 
-      settings.doShowSettings();
+    /*
+     * show dialog with export options if applicable; else just do it
+     */
+    if (AlignExportOptions.isNeeded(viewport, format))
+    {
+      AlignExportOptions choices = new AlignExportOptions(
+              alignPanel.getAlignViewport(), format, options);
+      choices.setResponseAction(outputAction);
+      choices.setResponseAction(cancelAction);
+      choices.showDialog();
+    }
+    else
+    {
+      outputAction.run();
     }
   }
 
   /**
-   * DOCUMENT ME!
+   * Outputs the alignment to textbox in the requested format, if necessary
+   * first prompting the user for whether to include hidden regions or
+   * non-sequence data
    * 
-   * @param e
-   *          DOCUMENT ME!
+   * @param fileFormatName
    */
   @Override
-  protected void outputText_actionPerformed(ActionEvent e)
+  protected void outputText_actionPerformed(String fileFormatName)
   {
     FileFormatI fileFormat = FileFormats.getInstance()
-            .forName(e.getActionCommand());
-    AlignExportSettingI settings = getAlignmentForExport(fileFormat,
-            alignPanel, null);
-    settings.addActionListener(new ActionListener()
+            .forName(fileFormatName);
+    AlignExportSettingsI options = new AlignExportSettingsAdapter(false);
+    RunResponse outputAction = new RunResponse(JvOptionPane.OK_OPTION)
     {
       @Override
-      public void actionPerformed(ActionEvent e)
+      public void run()
       {
-        if (settings.isCancelled())
-        {
-          return;
-        }
-        AlignmentExportData exportData = settings.getAlignExportData();
+        // todo defer this to inside formatSequences (or later)
+        AlignmentExportData exportData = viewport
+                .getAlignExportData(options);
         CutAndPasteTransfer cap = new CutAndPasteTransfer();
         cap.setForInput(null);
         try
         {
           FileFormatI format = fileFormat;
-          cap.setText(new FormatAdapter(alignPanel, settings)
+          cap.setText(new FormatAdapter(alignPanel, options)
                   .formatSequences(format, exportData.getAlignment(),
                           exportData.getOmitHidden(),
                           exportData.getStartEndPostions(),
@@ -1359,19 +1349,23 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
                   oom);
           cap.dispose();
         }
-        // TODO Auto-generated method stub
-
       }
-    });
-    settings.doShowSettings();
-  }
+    };
 
-  public static AlignExportSettingI getAlignmentForExport(
-          FileFormatI format, AlignmentPanel alignPanel,
-          AlignExportSettingBeanI exportSettings)
-  {
-
-    return new AlignExportSettings(alignPanel, format, exportSettings);
+    /*
+     * show dialog with export options if applicable; else just do it
+     */
+    if (AlignExportOptions.isNeeded(viewport, fileFormat))
+    {
+      AlignExportOptions choices = new AlignExportOptions(
+              alignPanel.getAlignViewport(), fileFormat, options);
+      choices.setResponseAction(outputAction);
+      choices.showDialog();
+    }
+    else
+    {
+      outputAction.run();
+    }
   }
 
   /**
@@ -1948,7 +1942,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
     Desktop.jalviewClipboard = new Object[] { seqs,
         viewport.getAlignment().getDataset(), hiddenColumns };
-    statusBar.setText(MessageManager.formatMessage(
+    setStatus(MessageManager.formatMessage(
             "label.copied_sequences_to_clipboard", new Object[]
             { Integer.valueOf(seqs.length).toString() }));
   }
@@ -2613,7 +2607,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
                 column, viewport.getAlignment());
       }
 
-      statusBar.setText(MessageManager
+      setStatus(MessageManager
               .formatMessage("label.removed_columns", new String[]
               { Integer.valueOf(trimRegion.getSize()).toString() }));
 
@@ -2663,7 +2657,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
     addHistoryItem(removeGapCols);
 
-    statusBar.setText(MessageManager
+    setStatus(MessageManager
             .formatMessage("label.removed_empty_columns", new Object[]
             { Integer.valueOf(removeGapCols.getSize()).toString() }));
 
@@ -2771,7 +2765,8 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     /*
      * Create a new AlignmentPanel (with its own, new Viewport)
      */
-    AlignmentPanel newap = new Jalview2XML().copyAlignPanel(alignPanel);
+    AlignmentPanel newap = new jalview.project.Jalview2XML()
+            .copyAlignPanel(alignPanel);
     if (!copyAnnotation)
     {
       /*
@@ -2783,10 +2778,10 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
     newap.av.setGatherViewsHere(false);
 
-    if (viewport.viewName == null)
+    if (viewport.getViewName() == null)
     {
-      viewport.viewName = MessageManager
-              .getString("label.view_name_original");
+      viewport.setViewName(MessageManager
+              .getString("label.view_name_original"));
     }
 
     /*
@@ -2810,7 +2805,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
       newap.refresh(true); // adjust layout of annotations
     }
 
-    newap.av.viewName = getNewViewName(viewTitle);
+    newap.av.setViewName(getNewViewName(viewTitle));
 
     addAlignmentPanel(newap, true);
     newap.alignmentChanged();
@@ -2873,9 +2868,9 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
       if (comp instanceof AlignmentPanel)
       {
         AlignmentPanel ap = (AlignmentPanel) comp;
-        if (!existingNames.contains(ap.av.viewName))
+        if (!existingNames.contains(ap.av.getViewName()))
         {
-          existingNames.add(ap.av.viewName);
+          existingNames.add(ap.av.getViewName());
         }
       }
     }
@@ -3290,8 +3285,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
             { contents.toString() });
     contents = null;
 
-    if (/** @j2sNative true || */
-    false)
+    if (Jalview.isJS())
     {
       JLabel textLabel = new JLabel();
       textLabel.setText(content);
@@ -3299,7 +3293,8 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
       
       pane = new JPanel(new BorderLayout());
       ((JPanel) pane).setOpaque(true);
-      ((JPanel) pane).add(textLabel, BorderLayout.CENTER);
+      pane.setBackground(Color.WHITE);
+      ((JPanel) pane).add(textLabel, BorderLayout.NORTH);
     }
     else
     {
@@ -3689,9 +3684,9 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
     frameTitle += " from ";
 
-    if (viewport.viewName != null)
+    if (viewport.getViewName() != null)
     {
-      frameTitle += viewport.viewName + " of ";
+      frameTitle += viewport.getViewName() + " of ";
     }
 
     frameTitle += this.title;
@@ -4593,13 +4588,13 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
                   for (SequenceI toassoc : (SequenceI[]) fm[2])
                   {
                     PDBEntry pe = new AssociatePdbFileWithSeq()
-                            .associatePdbWithSeq((String) fm[0],
+                            .associatePdbWithSeq(fm[0].toString(),
                                     (DataSourceType) fm[1], toassoc, false,
                                     Desktop.instance);
                     if (pe != null)
                     {
                       System.err.println("Associated file : "
-                              + ((String) fm[0]) + " with "
+                              + (fm[0].toString()) + " with "
                               + toassoc.getDisplayId(true));
                       assocfiles++;
                     }
@@ -4699,7 +4694,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
               changeColour(
                       new TCoffeeColourScheme(viewport.getAlignment()));
               isAnnotation = true;
-              statusBar.setText(MessageManager.getString(
+              setStatus(MessageManager.getString(
                       "label.successfully_pasted_tcoffee_scores_to_alignment"));
             }
             else
@@ -4742,7 +4737,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
                     new FileParse(file, sourceType));
             sm.parse();
             // todo: i18n this message
-            statusBar.setText(MessageManager.formatMessage(
+            setStatus(MessageManager.formatMessage(
                     "label.successfully_loaded_matrix",
                     sm.getMatrixName()));
           }
@@ -4868,12 +4863,12 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     if (e.isPopupTrigger())
     {
       String msg = MessageManager.getString("label.enter_view_name");
-      String reply = JvOptionPane.showInternalInputDialog(this, msg, msg,
-              JvOptionPane.QUESTION_MESSAGE);
+      String ttl = tabbedPane.getTitleAt(tabbedPane.getSelectedIndex());
+      String reply = JvOptionPane.showInputDialog(msg, ttl);
 
       if (reply != null)
       {
-        viewport.viewName = reply;
+        viewport.setViewName(reply);
         // TODO warn if reply is in getExistingViewNames()?
         tabbedPane.setTitleAt(tabbedPane.getSelectedIndex(), reply);
       }
@@ -5024,22 +5019,19 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
 
     });
     rfetch.add(fetchr);
-    final AlignFrame me = this;
     new Thread(new Runnable()
     {
       @Override
       public void run()
       {
         final jalview.ws.SequenceFetcher sf = jalview.gui.SequenceFetcher
-                .getSequenceFetcherSingleton(me);
+                .getSequenceFetcherSingleton();
         javax.swing.SwingUtilities.invokeLater(new Runnable()
         {
           @Override
           public void run()
           {
-            String[] dbclasses = sf.getOrderedSupportedSources();
-            // sf.getDbInstances(jalview.ws.dbsources.DasSequenceSource.class);
-            // jalview.util.QuickSort.sort(otherdb, otherdb);
+            String[] dbclasses = sf.getNonAlignmentSources();
             List<DbSourceProxy> otherdb;
             JMenu dfetch = new JMenu();
             JMenu ifetch = new JMenu();
@@ -5056,12 +5048,6 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
               {
                 continue;
               }
-              // List<DbSourceProxy> dbs=otherdb;
-              // otherdb=new ArrayList<DbSourceProxy>();
-              // for (DbSourceProxy db:dbs)
-              // {
-              // if (!db.isA(DBRefSource.ALIGNMENTDB)
-              // }
               if (mname == null)
               {
                 mname = "From " + dbclass;
@@ -5411,6 +5397,10 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
   {
     if (avc.createGroup())
     {
+      if (applyAutoAnnotationSettings.isSelected())
+      {
+        alignPanel.updateAnnotation(true, false);
+      }
       alignPanel.alignmentChanged();
     }
   }
@@ -5501,7 +5491,9 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
    */
   public List<? extends AlignmentViewPanel> getAlignPanels()
   {
-    return alignPanels == null ? Arrays.asList(alignPanel) : alignPanels;
+    // alignPanels is never null
+    // return alignPanels == null ? Arrays.asList(alignPanel) : alignPanels;
+    return alignPanels;
   }
 
   /**