Merge branch 'develop' into features/JAL-4134_use_annotation_row_for_colours_and_groups
[jalview.git] / src / jalview / jbgui / GStructureChooser.java
index a30be66..8cb5b3c 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
 
 package jalview.jbgui;
 
-import jalview.datamodel.SequenceI;
-import jalview.fts.api.FTSDataColumnI;
-import jalview.fts.core.FTSDataColumnPreferences;
-import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
-import jalview.fts.service.pdb.PDBFTSRestClient;
-import jalview.gui.AlignmentPanel;
-import jalview.gui.Desktop;
-import jalview.gui.JvSwingUtils;
-import jalview.gui.StructureViewer;
-import jalview.util.MessageManager;
-
 import java.awt.BorderLayout;
 import java.awt.CardLayout;
 import java.awt.Component;
 import java.awt.Dimension;
 import java.awt.FlowLayout;
 import java.awt.Font;
+import java.awt.GridBagConstraints;
+import java.awt.GridBagLayout;
 import java.awt.GridLayout;
+import java.awt.Insets;
+import java.awt.Point;
 import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
 import java.awt.event.ItemEvent;
 import java.awt.event.ItemListener;
 import java.awt.event.KeyAdapter;
@@ -65,6 +59,8 @@ import javax.swing.JTabbedPane;
 import javax.swing.JTable;
 import javax.swing.JTextField;
 import javax.swing.ListCellRenderer;
+import javax.swing.SwingConstants;
+import javax.swing.Timer;
 import javax.swing.event.ChangeEvent;
 import javax.swing.event.ChangeListener;
 import javax.swing.event.DocumentEvent;
@@ -72,6 +68,17 @@ import javax.swing.event.DocumentListener;
 import javax.swing.event.InternalFrameEvent;
 import javax.swing.table.TableColumn;
 
+import jalview.datamodel.SequenceI;
+import jalview.fts.api.FTSDataColumnI;
+import jalview.fts.core.FTSDataColumnPreferences;
+import jalview.gui.AlignmentPanel;
+import jalview.gui.Desktop;
+import jalview.gui.JvSwingUtils;
+import jalview.gui.StructureViewer;
+import jalview.structure.StructureImportSettings;
+import jalview.structure.StructureImportSettings.TFType;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
 import net.miginfocom.swing.MigLayout;
 
 @SuppressWarnings("serial")
@@ -86,7 +93,9 @@ public abstract class GStructureChooser extends JPanel
 {
   private static final Font VERDANA_12 = new Font("Verdana", 0, 12);
 
-  protected static final String VIEWS_FILTER = "VIEWS_FILTER";
+  private static final Font VERDANA_10 = new Font("Verdana", 0, 10);
+
+  public static final String VIEWS_FILTER = "VIEWS_FILTER";
 
   protected static final String VIEWS_FROM_FILE = "VIEWS_FROM_FILE";
 
@@ -97,6 +106,8 @@ public abstract class GStructureChooser extends JPanel
    */
   protected static final String VIEWS_LOCAL_PDB = "VIEWS_LOCAL_PDB";
 
+  protected JPanel actionsPanel;
+
   protected JPanel statusPanel = new JPanel();
 
   public JLabel statusBar = new JLabel();
@@ -112,12 +123,31 @@ public abstract class GStructureChooser extends JPanel
 
   protected StringBuilder errorWarning = new StringBuilder();
 
+  protected JButton btn_cancel;
+
   protected JButton btn_add;
 
   protected JButton btn_newView;
 
   protected JButton btn_pdbFromFile = new JButton();
 
+  protected JLabel lbl_pdbFile = new JLabel();
+
+  protected JLabel lbl_chooseTempFacType = new JLabel();
+
+  protected JComboBox<StructureImportSettings.TFType> combo_tempFacAs = new JComboBox<>();
+
+  protected boolean tempFacAsChanged = false;
+
+  protected JButton btn_paeMatrixFile = new JButton();
+
+  protected JLabel lbl_paeFile = new JLabel();
+
+  // holder for icon and button
+  protected JPanel pnl_queryTDB;
+
+  protected JButton btn_queryTDB = new JButton();
+
   protected JCheckBox chk_superpose = new JCheckBox(
           MessageManager.getString("label.superpose_structures"));
 
@@ -143,11 +173,14 @@ public abstract class GStructureChooser extends JPanel
   protected ImageIcon warningImage = new ImageIcon(
           getClass().getResource("/images/warning.gif"));
 
+  protected ImageIcon tdbImage = new ImageIcon(getClass()
+          .getResource("/images/3d-beacons-logo-transparent.png"));
+
   protected JLabel lbl_loading = new JLabel(loadingImage);
 
   protected JLabel lbl_pdbManualFetchStatus = new JLabel(errorImage);
 
-  protected JLabel lbl_fromFileStatus = new JLabel(errorImage);
+  // protected JLabel lbl_fromFileStatus = new JLabel(errorImage);
 
   protected AssociateSeqPanel idInputAssSeqPanel = new AssociateSeqPanel();
 
@@ -159,9 +192,10 @@ public abstract class GStructureChooser extends JPanel
 
   protected JTabbedPane pnl_filter = new JTabbedPane();
 
-  protected FTSDataColumnPreferences pdbDocFieldPrefs = new FTSDataColumnPreferences(
-          PreferenceSource.STRUCTURE_CHOOSER,
-          PDBFTSRestClient.getInstance());
+  protected abstract FTSDataColumnPreferences getFTSDocFieldPrefs();
+
+  protected abstract void setFTSDocFieldPrefs(
+          FTSDataColumnPreferences newPrefs);
 
   protected FTSDataColumnI[] previousWantedFields;
 
@@ -247,18 +281,51 @@ public abstract class GStructureChooser extends JPanel
 
   public GStructureChooser()
   {
+  }
+
+  protected void initDialog()
+  {
+
     try
     {
       jbInit();
+      mainFrame.setFrameIcon(null);
       mainFrame.setVisible(false);
       mainFrame.invalidate();
       mainFrame.pack();
     } catch (Exception e)
     {
+      System.out.println(e); // for JavaScript TypeError
       e.printStackTrace();
     }
   }
 
+  // BH SwingJS optimization
+  // (a) 100-ms interruptable timer for text entry -- BH 1/10/2019
+  // (b) two-character minimum, at least for JavaScript.
+
+  private Timer timer;
+
+  protected void txt_search_ActionPerformedDelayed()
+  {
+    if (timer != null)
+    {
+      timer.stop();
+    }
+    timer = new Timer(300, new ActionListener()
+    {
+
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        txt_search_ActionPerformed();
+      }
+    });
+    timer.setRepeats(false);
+    timer.start();
+  }
+  //
+
   /**
    * Initializes the GUI default properties
    * 
@@ -277,15 +344,44 @@ public abstract class GStructureChooser extends JPanel
     tbl_summary.addMouseListener(new MouseAdapter()
     {
       @Override
+      public void mousePressed(MouseEvent e)
+      {
+        if (!popupAction(e))
+        {
+          super.mousePressed(e);
+        }
+      }
+
+      @Override
       public void mouseClicked(MouseEvent e)
       {
-        validateSelections();
+        if (!popupAction(e))
+        {
+          validateSelections();
+        }
       }
 
       @Override
       public void mouseReleased(MouseEvent e)
       {
-        validateSelections();
+        if (!popupAction(e))
+        {
+          validateSelections();
+        }
+      }
+
+      boolean popupAction(MouseEvent e)
+      {
+        if (e.isPopupTrigger())
+        {
+          Point pt = e.getPoint();
+          int selectedRow = tbl_summary.rowAtPoint(pt);
+          if (showPopupFor(selectedRow, pt.x, pt.y))
+          {
+            return true;
+          }
+        }
+        return false;
       }
     });
     tbl_summary.addKeyListener(new KeyAdapter()
@@ -322,10 +418,9 @@ public abstract class GStructureChooser extends JPanel
       }
     });
 
-    JButton btn_cancel = new JButton(
-            MessageManager.getString("action.cancel"));
+    btn_cancel = new JButton(MessageManager.getString("action.cancel"));
     btn_cancel.setFont(VERDANA_12);
-    btn_cancel.addActionListener(new java.awt.event.ActionListener()
+    btn_cancel.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
@@ -402,9 +497,11 @@ public abstract class GStructureChooser extends JPanel
       }
     });
 
-    btn_newView = new JButton(MessageManager.getString("action.new_view"));
+    btn_newView = new JButton(
+            MessageManager.formatMessage("action.new_structure_view_with",
+                    StructureViewer.getViewerType().toString()));
     btn_newView.setFont(VERDANA_12);
-    btn_newView.addActionListener(new java.awt.event.ActionListener()
+    btn_newView.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
@@ -424,9 +521,12 @@ public abstract class GStructureChooser extends JPanel
       }
     });
 
+    // TODO: JAL-3898 - get list of available external programs to view
+    // structures with
+
     btn_add = new JButton(MessageManager.getString("action.add"));
     btn_add.setFont(VERDANA_12);
-    btn_add.addActionListener(new java.awt.event.ActionListener()
+    btn_add.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
@@ -449,7 +549,7 @@ public abstract class GStructureChooser extends JPanel
     btn_pdbFromFile.setFont(VERDANA_12);
     String btn_title = MessageManager.getString("label.select_pdb_file");
     btn_pdbFromFile.setText(btn_title + "              ");
-    btn_pdbFromFile.addActionListener(new java.awt.event.ActionListener()
+    btn_pdbFromFile.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
@@ -468,6 +568,51 @@ public abstract class GStructureChooser extends JPanel
         }
       }
     });
+    lbl_pdbFile.setFont(VERDANA_10);
+    lbl_pdbFile.setFont(VERDANA_10);
+
+    lbl_chooseTempFacType.setFont(VERDANA_12);
+    lbl_chooseTempFacType.setText(
+            MessageManager.getString("label.interpret_tempfac_as"));
+
+    combo_tempFacAs.setFont(VERDANA_12);
+    for (TFType t : TFType.values())
+    {
+      combo_tempFacAs.addItem(t);
+    }
+    combo_tempFacAs.addItemListener(new ItemListener()
+    {
+      @Override
+      public void itemStateChanged(ItemEvent e)
+      {
+        // used to determine if we should guess pLDDT or leave a user-choice
+        tempFacAsChanged = true;
+      }
+    });
+
+    btn_paeMatrixFile.setFont(VERDANA_12);
+    btn_paeMatrixFile
+            .setText(MessageManager.getString("label.add_pae_matrix_file"));
+    btn_paeMatrixFile.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        paeMatrixFile_actionPerformed();
+      }
+    });
+    btn_paeMatrixFile.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        if (evt.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          paeMatrixFile_actionPerformed();
+        }
+      }
+    });
+    lbl_paeFile.setFont(VERDANA_10);
 
     JScrollPane scrl_foundStructures = new JScrollPane(tbl_summary);
     scrl_foundStructures.setPreferredSize(new Dimension(width, height));
@@ -485,19 +630,19 @@ public abstract class GStructureChooser extends JPanel
       @Override
       public void insertUpdate(DocumentEvent e)
       {
-        txt_search_ActionPerformed();
+        txt_search_ActionPerformedDelayed();
       }
 
       @Override
       public void removeUpdate(DocumentEvent e)
       {
-        txt_search_ActionPerformed();
+        txt_search_ActionPerformedDelayed();
       }
 
       @Override
       public void changedUpdate(DocumentEvent e)
       {
-        txt_search_ActionPerformed();
+        txt_search_ActionPerformedDelayed();
       }
     });
 
@@ -518,28 +663,92 @@ public abstract class GStructureChooser extends JPanel
     });
 
     chk_invertFilter.addItemListener(this);
+    btn_queryTDB = new JButton();
+    if (Platform.isMac())
+    {
+      // needed to make icon button have round corners in vaqua
+      btn_queryTDB.putClientProperty("JButton.buttonType", "bevel");
+    }
+    btn_queryTDB.setMargin(new Insets(0, 16, 0, 20));
+    btn_queryTDB
+            .setText(MessageManager.getString("label.search_3dbeacons"));
+    btn_queryTDB.setIconTextGap(12);
+    btn_queryTDB.setIcon(tdbImage);
+    btn_queryTDB.setVerticalTextPosition(SwingConstants.CENTER);
+    btn_queryTDB.setHorizontalTextPosition(SwingConstants.TRAILING);
+    btn_queryTDB.setFont(VERDANA_12);
+    btn_queryTDB.setToolTipText(
+            MessageManager.getString("label.find_models_from_3dbeacons"));
+    // btn_queryTDB.setPreferredSize(new Dimension(200, 32));
+    btn_queryTDB.setVisible(false);
 
     targetView.setVisible(false);
 
-    JPanel actionsPanel = new JPanel(new MigLayout());
+    actionsPanel = new JPanel(new MigLayout());
     actionsPanel.add(targetView, "left");
     actionsPanel.add(btn_add, "wrap");
     actionsPanel.add(chk_superpose, "left");
     actionsPanel.add(btn_newView);
     actionsPanel.add(btn_cancel, "right");
 
-    JPanel pnl_main = new JPanel();
-    pnl_main.add(cmb_filterOption);
-    pnl_main.add(lbl_loading);
-    pnl_main.add(chk_invertFilter);
+    JPanel pnl_main = new JPanel(new BorderLayout());
+    JPanel pnl_controls = new JPanel();
+    pnl_queryTDB = new JPanel();
+    pnl_queryTDB.setLayout(new FlowLayout(FlowLayout.CENTER, 4, 4));
+    pnl_queryTDB.setBackground(getBackground());
+    pnl_queryTDB.add(btn_queryTDB);
+
+    pnl_queryTDB.setVisible(false);
+    pnl_main.add(pnl_queryTDB, BorderLayout.NORTH);
+    pnl_controls.add(cmb_filterOption);
+    pnl_controls.add(lbl_loading);
+    pnl_controls.add(chk_invertFilter);
+    pnl_main.add(pnl_controls, BorderLayout.CENTER);
     lbl_loading.setVisible(false);
 
-    JPanel pnl_fileChooser = new JPanel(new FlowLayout());
-    pnl_fileChooser.add(btn_pdbFromFile);
-    pnl_fileChooser.add(lbl_fromFileStatus);
+    // JPanel pnl_fileChooser = new JPanel(new FlowLayout());
+    // pnl_fileChooser.add(btn_pdbFromFile);
+    // pnl_fileChooser.add(lbl_fromFileStatus);
+
+    JPanel pnl_fileOptions = new JPanel();
+    pnl_fileOptions.setLayout(new GridBagLayout());
+    GridBagConstraints gbc = new GridBagConstraints();
+    gbc.gridx = 0;
+    gbc.gridy = 0;
+    gbc.weightx = 0.0;
+    gbc.weighty = 0.0;
+    gbc.insets = new Insets(0, 0, 2, 0);
+    gbc.fill = GridBagConstraints.NONE;
+    gbc.anchor = GridBagConstraints.FIRST_LINE_START;
+    // pnl_fileOptions.add(pnl_fileChooser, gbc);
+    pnl_fileOptions.add(btn_pdbFromFile, gbc);
+    gbc.gridy++;
+    gbc.insets = new Insets(0, 0, 18, 0);
+    pnl_fileOptions.add(lbl_pdbFile, gbc);
+    gbc.gridy++;
+
+    gbc.insets = new Insets(0, 0, 2, 0);
+    pnl_fileOptions.add(new JLabel(
+            MessageManager.getString("label.structure_import_options")),
+            gbc);
+    gbc.gridy++;
+
+    gbc.insets = new Insets(0, 0, 6, 0);
+    pnl_fileOptions.add(lbl_chooseTempFacType, gbc);
+    gbc.gridy++;
+    gbc.insets = new Insets(0, 0, 18, 0);
+    pnl_fileOptions.add(combo_tempFacAs, gbc);
+    gbc.gridy++;
+    gbc.insets = new Insets(0, 0, 6, 0);
+    pnl_fileOptions.add(btn_paeMatrixFile, gbc);
+    gbc.gridy++;
+    gbc.insets = new Insets(0, 0, 2, 0);
+    gbc.weighty = 1.0;
+    pnl_fileOptions.add(lbl_paeFile, gbc);
+
     JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
-    pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
-    pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
+    pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.PAGE_START);
+    pnl_fileChooserBL.add(pnl_fileOptions, BorderLayout.CENTER);
 
     JPanel pnl_idInput = new JPanel(new FlowLayout());
     pnl_idInput.add(txt_search);
@@ -571,7 +780,7 @@ public abstract class GStructureChooser extends JPanel
           btn_add.setVisible(false);
           btn_newView.setEnabled(false);
           btn_cancel.setVisible(false);
-          previousWantedFields = pdbDocFieldPrefs
+          previousWantedFields = getFTSDocFieldPrefs()
                   .getStructureSummaryFields()
                   .toArray(new FTSDataColumnI[0]);
         }
@@ -593,7 +802,7 @@ public abstract class GStructureChooser extends JPanel
     pnl_filter.addChangeListener(changeListener);
     pnl_filter.setPreferredSize(new Dimension(width, height));
     pnl_filter.add(foundStructureSummary, scrl_foundStructures);
-    pnl_filter.add(configureCols, pdbDocFieldPrefs);
+    pnl_filter.add(configureCols, getFTSDocFieldPrefs());
 
     JPanel pnl_locPDB = new JPanel(new BorderLayout());
     pnl_locPDB.add(scrl_localPDB);
@@ -636,6 +845,8 @@ public abstract class GStructureChooser extends JPanel
     Desktop.addInternalFrame(mainFrame, frameTitle, width, height);
   }
 
+  protected abstract boolean showPopupFor(int selectedRow, int x, int y);
+
   protected void closeAction(int preferredHeight)
   {
     // System.out.println(">>>>>>>>>> closing internal frame!!!");
@@ -657,7 +868,7 @@ public abstract class GStructureChooser extends JPanel
       return true;
     }
 
-    FTSDataColumnI[] currentWantedFields = pdbDocFieldPrefs
+    FTSDataColumnI[] currentWantedFields = getFTSDocFieldPrefs()
             .getStructureSummaryFields().toArray(new FTSDataColumnI[0]);
     return Arrays.equals(currentWantedFields, previousWantedFields) ? false
             : true;
@@ -674,91 +885,6 @@ public abstract class GStructureChooser extends JPanel
   }
 
   /**
-   * This inner class provides the data model for the structure filter combo-box
-   * 
-   * @author tcnofoegbu
-   *
-   */
-  public class FilterOption
-  {
-    private String name;
-
-    private String value;
-
-    private String view;
-
-    private boolean addSeparatorAfter;
-
-    /**
-     * Model for structure filter option
-     * 
-     * @param name
-     *          - the name of the Option
-     * @param value
-     *          - the value of the option
-     * @param view
-     *          - the category of the filter option
-     * @param addSeparatorAfter
-     *          - if true, a horizontal separator is rendered immediately after
-     *          this filter option, otherwise
-     */
-    public FilterOption(String name, String value, String view,
-            boolean addSeparatorAfter)
-    {
-      this.name = name;
-      this.value = value;
-      this.view = view;
-      this.addSeparatorAfter = addSeparatorAfter;
-    }
-
-    public String getName()
-    {
-      return name;
-    }
-
-    public void setName(String name)
-    {
-      this.name = name;
-    }
-
-    public String getValue()
-    {
-      return value;
-    }
-
-    public void setValue(String value)
-    {
-      this.value = value;
-    }
-
-    public String getView()
-    {
-      return view;
-    }
-
-    public void setView(String view)
-    {
-      this.view = view;
-    }
-
-    @Override
-    public String toString()
-    {
-      return this.name;
-    }
-
-    public boolean isAddSeparatorAfter()
-    {
-      return addSeparatorAfter;
-    }
-
-    public void setAddSeparatorAfter(boolean addSeparatorAfter)
-    {
-      this.addSeparatorAfter = addSeparatorAfter;
-    }
-  }
-
-  /**
    * This inner class provides the provides the data model for associate
    * sequence combo-box - cmb_assSeq
    * 
@@ -927,6 +1053,8 @@ public abstract class GStructureChooser extends JPanel
 
   protected abstract void pdbFromFile_actionPerformed();
 
+  protected abstract void paeMatrixFile_actionPerformed();
+
   protected abstract void txt_search_ActionPerformed();
 
   protected abstract void populateCmbAssociateSeqOptions(
@@ -938,4 +1066,17 @@ public abstract class GStructureChooser extends JPanel
   protected abstract void tabRefresh();
 
   protected abstract void validateSelections();
-}
\ No newline at end of file
+
+  public JInternalFrame getFrame()
+  {
+    return mainFrame;
+  }
+
+  public void setPdbOptionsEnabled(boolean b)
+  {
+    lbl_chooseTempFacType.setEnabled(b);
+    combo_tempFacAs.setEnabled(b);
+    btn_paeMatrixFile.setEnabled(b);
+    lbl_paeFile.setEnabled(b);
+  }
+}