JAL-1860 house keeping
[jalview.git] / src / jalview / jbgui / GStructureChooser.java
index 080fce9..1334021 100644 (file)
@@ -24,7 +24,11 @@ package jalview.jbgui;
 import jalview.datamodel.SequenceI;
 import jalview.gui.AlignmentPanel;
 import jalview.gui.Desktop;
+import jalview.gui.JvSwingUtils;
+import jalview.jbgui.PDBDocFieldPreferences.PreferenceSource;
 import jalview.util.MessageManager;
+import jalview.ws.dbsources.PDBRestClient;
+import jalview.ws.dbsources.PDBRestClient.PDBDocField;
 
 import java.awt.BorderLayout;
 import java.awt.CardLayout;
@@ -33,6 +37,11 @@ import java.awt.FlowLayout;
 import java.awt.event.ActionEvent;
 import java.awt.event.ItemEvent;
 import java.awt.event.ItemListener;
+import java.awt.event.KeyAdapter;
+import java.awt.event.KeyEvent;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.util.Arrays;
 
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
@@ -43,8 +52,11 @@ import javax.swing.JInternalFrame;
 import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
+import javax.swing.JTabbedPane;
 import javax.swing.JTable;
 import javax.swing.JTextField;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
 
@@ -64,9 +76,10 @@ public abstract class GStructureChooser extends JPanel implements
 
   protected JComboBox<FilterOption> cmb_filterOption = new JComboBox<FilterOption>();
 
-
   protected AlignmentPanel ap;
 
+  protected StringBuilder errorWarning = new StringBuilder();
+
   protected JLabel lbl_result = new JLabel(
           MessageManager.getString("label.select"));
 
@@ -80,7 +93,7 @@ public abstract class GStructureChooser extends JPanel implements
 
   private JPanel pnl_actions = new JPanel();
 
-  private JPanel pnl_filter = new JPanel();
+  private JPanel pnl_main = new JPanel();
 
   private JPanel pnl_idInput = new JPanel(new FlowLayout());
 
@@ -90,6 +103,8 @@ public abstract class GStructureChooser extends JPanel implements
 
   private JPanel pnl_fileChooserBL = new JPanel(new BorderLayout());
 
+  private JPanel pnl_locPDB = new JPanel(new BorderLayout());
+
   protected JPanel pnl_switchableViews = new JPanel(new CardLayout());
 
   protected CardLayout layout_switchableViews = (CardLayout) (pnl_switchableViews
@@ -112,6 +127,11 @@ public abstract class GStructureChooser extends JPanel implements
   protected ImageIcon errorImage = new ImageIcon(getClass().getResource(
           "/images/error.png"));
 
+  protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
+          "/images/warning.gif"));
+
+  protected JLabel lbl_warning = new JLabel(warningImage);
+
   protected JLabel lbl_loading = new JLabel(loadingImage);
 
   protected JLabel lbl_pdbManualFetchStatus = new JLabel(errorImage);
@@ -128,13 +148,45 @@ public abstract class GStructureChooser extends JPanel implements
 
   protected static final String VIEWS_ENTER_ID = "VIEWS_ENTER_ID";
 
-  // protected JList<PDBResponseSummary> jList_FoundStructures = new
-  // JList<PDBResponseSummary>();
+  protected static final String VIEWS_LOCAL_PDB = "VIEWS_LOCAL_PDB";
+
+  protected JTable tbl_summary = new JTable()
+  {
+    public String getToolTipText(MouseEvent evt)
+    {
+      String toolTipText = null;
+      java.awt.Point pnt = evt.getPoint();
+      int rowIndex = rowAtPoint(pnt);
+      int colIndex = columnAtPoint(pnt);
+
+      try
+      {
+        toolTipText = getValueAt(rowIndex, colIndex).toString();
+      } catch (Exception e)
+      {
+        e.printStackTrace();
+      }
+      toolTipText = (toolTipText == null ? null
+              : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
+                      true, "\"" + toolTipText.subSequence(0, 500)
+                              + "...\"") : JvSwingUtils.wrapTooltip(true,
+                      toolTipText)));
+      return toolTipText;
+    }
+  };
+
+  protected JScrollPane scrl_foundStructures = new JScrollPane(tbl_summary);
+
+  protected JTable tbl_local_pdb = new JTable();
+
+  protected JScrollPane scrl_localPDB = new JScrollPane(tbl_local_pdb);
+
+  private JTabbedPane pnl_filter = new JTabbedPane();
 
-  protected JTable tbl_summary = new JTable();
+  private PDBDocFieldPreferences pdbDocFieldPrefs = new PDBDocFieldPreferences(
+          PreferenceSource.STRUCTURE_CHOOSER);
 
-  protected JScrollPane scrl_foundStructures = new JScrollPane(
-          tbl_summary);
+  protected PDBDocField[] previousWantedFields;
 
   public GStructureChooser()
   {
@@ -157,6 +209,106 @@ public abstract class GStructureChooser extends JPanel implements
    */
   private void jbInit() throws Exception
   {
+    tbl_summary.setAutoCreateRowSorter(true);
+    tbl_summary.getTableHeader().setReorderingAllowed(false);
+    tbl_summary.addMouseListener(new MouseAdapter()
+    {
+      public void mouseClicked(MouseEvent e)
+      {
+        validateSelections();
+      }
+
+      public void mouseReleased(MouseEvent e)
+      {
+        validateSelections();
+      }
+    });
+    tbl_summary.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        validateSelections();
+        switch (evt.getKeyCode())
+        {
+        case KeyEvent.VK_ESCAPE: // escape key
+          mainFrame.dispose();
+          break;
+        case KeyEvent.VK_ENTER: // enter key
+          if (btn_view.isEnabled())
+          {
+            ok_ActionPerformed();
+          }
+          break;
+        case KeyEvent.VK_TAB: // tab key
+          if (evt.isShiftDown())
+          {
+            pnl_filter.requestFocus();
+          }
+          else
+          {
+            btn_view.requestFocus();
+          }
+          evt.consume();
+          break;
+        default:
+          return;
+        }
+      }
+    });
+    tbl_local_pdb.setAutoCreateRowSorter(true);
+    tbl_local_pdb.getTableHeader().setReorderingAllowed(false);
+    tbl_local_pdb.addMouseListener(new MouseAdapter()
+    {
+      public void mouseClicked(MouseEvent e)
+      {
+        validateSelections();
+      }
+
+      public void mouseReleased(MouseEvent e)
+      {
+        validateSelections();
+      }
+    });
+    tbl_local_pdb.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        validateSelections();
+        switch (evt.getKeyCode())
+        {
+        case KeyEvent.VK_ESCAPE: // escape key
+          mainFrame.dispose();
+          break;
+        case KeyEvent.VK_ENTER: // enter key
+          if (btn_view.isEnabled())
+          {
+            ok_ActionPerformed();
+          }
+          break;
+        case KeyEvent.VK_TAB: // tab key
+          if (evt.isShiftDown())
+          {
+            cmb_filterOption.requestFocus();
+          }
+          else
+          {
+            if (btn_view.isEnabled())
+            {
+            btn_view.requestFocus();
+            }
+            else
+            {
+              btn_cancel.requestFocus();
+            }
+          }
+          evt.consume();
+        default:
+          return;
+        }
+      }
+    });
     btn_view.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_view.setText(MessageManager.getString("action.view"));
     btn_view.addActionListener(new java.awt.event.ActionListener()
@@ -166,6 +318,18 @@ public abstract class GStructureChooser extends JPanel implements
         ok_ActionPerformed();
       }
     });
+    btn_view.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        if (evt.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          ok_ActionPerformed();
+        }
+      }
+    });
+
     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
     btn_cancel.setText(MessageManager.getString("action.cancel"));
     btn_cancel.addActionListener(new java.awt.event.ActionListener()
@@ -175,6 +339,17 @@ public abstract class GStructureChooser extends JPanel implements
         mainFrame.dispose();
       }
     });
+    btn_cancel.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        if (evt.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          mainFrame.dispose();
+        }
+      }
+    });
 
     btn_pdbFromFile.setFont(new java.awt.Font("Verdana", 0, 12));
     String btn_title = MessageManager.getString("label.select_pdb_file");
@@ -186,27 +361,30 @@ public abstract class GStructureChooser extends JPanel implements
         pdbFromFile_actionPerformed();
       }
     });
+    btn_pdbFromFile.addKeyListener(new KeyAdapter()
+    {
+      @Override
+      public void keyPressed(KeyEvent evt)
+      {
+        if (evt.getKeyCode() == KeyEvent.VK_ENTER)
+        {
+          pdbFromFile_actionPerformed();
+        }
+      }
+    });
 
     scrl_foundStructures.setPreferredSize(new Dimension(500, 300));
     scrl_foundStructures
             .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 
+    scrl_localPDB.setPreferredSize(new Dimension(500, 300));
+    scrl_localPDB
+            .setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
+
     cmb_filterOption.setFont(new java.awt.Font("Verdana", 0, 12));
     chk_invertFilter.setFont(new java.awt.Font("Verdana", 0, 12));
     chk_rememberSettings.setFont(new java.awt.Font("Verdana", 0, 12));
-
-    cmb_filterOption.addItemListener(this);
-    chk_invertFilter.addItemListener(this);
-
-    pnl_actions.add(chk_rememberSettings);
-    pnl_actions.add(btn_view);
-    pnl_actions.add(btn_cancel);
-
-    // pnl_filter.add(lbl_result);
-    pnl_filter.add(cmb_filterOption);
-    pnl_filter.add(lbl_loading);
-    pnl_filter.add(chk_invertFilter);
-    lbl_loading.setVisible(false);
+    chk_rememberSettings.setVisible(false);
 
     txt_search.setToolTipText(MessageManager
             .getString("label.enter_pdb_id"));
@@ -232,24 +410,78 @@ public abstract class GStructureChooser extends JPanel implements
         txt_search_ActionPerformed();
       }
     });
-    pnl_idInput.add(txt_search);
-    pnl_idInput.add(lbl_pdbManualFetchStatus);
+
+    cmb_filterOption.addItemListener(this);
+    chk_invertFilter.addItemListener(this);
+
+    pnl_actions.add(chk_rememberSettings);
+    pnl_actions.add(btn_view);
+    pnl_actions.add(btn_cancel);
+
+    // pnl_filter.add(lbl_result);
+    pnl_main.add(cmb_filterOption);
+    pnl_main.add(lbl_loading);
+    pnl_main.add(chk_invertFilter);
+    lbl_loading.setVisible(false);
 
     pnl_fileChooser.add(btn_pdbFromFile);
     pnl_fileChooser.add(lbl_fromFileStatus);
-
     pnl_fileChooserBL.add(fileChooserAssSeqPanel, BorderLayout.NORTH);
     pnl_fileChooserBL.add(pnl_fileChooser, BorderLayout.CENTER);
 
+    pnl_idInput.add(txt_search);
+    pnl_idInput.add(lbl_pdbManualFetchStatus);
     pnl_idInputBL.add(idInputAssSeqPanel, BorderLayout.NORTH);
     pnl_idInputBL.add(pnl_idInput, BorderLayout.CENTER);
 
+    final String foundStructureSummary = MessageManager
+            .getString("label.found_structures_summary");
+    final String configureCols = MessageManager
+            .getString("label.configure_displayed_columns");
+    ChangeListener changeListener = new ChangeListener()
+    {
+      public void stateChanged(ChangeEvent changeEvent)
+      {
+        JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
+                .getSource();
+        int index = sourceTabbedPane.getSelectedIndex();
+        if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
+        {
+          btn_view.setEnabled(false);
+          btn_cancel.setEnabled(false);
+          previousWantedFields = PDBDocFieldPreferences
+                  .getStructureSummaryFields().toArray(
+                          new PDBRestClient.PDBDocField[0]);
+        }
+        if (sourceTabbedPane.getTitleAt(index)
+                .equals(foundStructureSummary))
+        {
+          btn_cancel.setEnabled(true);
+          if (wantedFieldsUpdated())
+          {
+            tabRefresh();
+          }
+          else
+          {
+            validateSelections();
+          }
+        }
+      }
+    };
+    pnl_filter.addChangeListener(changeListener);
+    pnl_filter.setPreferredSize(new Dimension(500, 300));
+    pnl_filter.add(foundStructureSummary, scrl_foundStructures);
+    pnl_filter.add(configureCols, pdbDocFieldPrefs);
+
+    pnl_locPDB.add(scrl_localPDB);
+
     pnl_switchableViews.add(pnl_fileChooserBL, VIEWS_FROM_FILE);
     pnl_switchableViews.add(pnl_idInputBL, VIEWS_ENTER_ID);
-    pnl_switchableViews.add(scrl_foundStructures, VIEWS_FILTER);
-    
+    pnl_switchableViews.add(pnl_filter, VIEWS_FILTER);
+    pnl_switchableViews.add(pnl_locPDB, VIEWS_LOCAL_PDB);
+
     this.setLayout(mainLayout);
-    this.add(pnl_filter, java.awt.BorderLayout.NORTH);
+    this.add(pnl_main, java.awt.BorderLayout.NORTH);
     this.add(pnl_switchableViews, java.awt.BorderLayout.CENTER);
     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 
@@ -259,7 +491,19 @@ public abstract class GStructureChooser extends JPanel implements
     Desktop.addInternalFrame(mainFrame, frameTitle, 800, 400);
   }
 
-  
+  public boolean wantedFieldsUpdated()
+  {
+    if (previousWantedFields == null)
+    {
+      return true;
+    }
+
+    return Arrays.equals(PDBDocFieldPreferences.getStructureSummaryFields()
+            .toArray(new PDBRestClient.PDBDocField[0]),
+            previousWantedFields) ? false : true;
+
+  }
+
   @Override
   /**
    * Event listener for the 'filter' combo-box and 'invert' check-box
@@ -336,6 +580,7 @@ public abstract class GStructureChooser extends JPanel implements
   public class AssociateSeqOptions
   {
     private SequenceI sequence;
+
     private String name;
 
     public AssociateSeqOptions(SequenceI seq)
@@ -389,10 +634,14 @@ public abstract class GStructureChooser extends JPanel implements
   public class AssciateSeqPanel extends JPanel implements ItemListener
   {
     private JComboBox<AssociateSeqOptions> cmb_assSeq = new JComboBox<AssociateSeqOptions>();
+
+    private JLabel lbl_associateSeq = new JLabel();
+
     public AssciateSeqPanel()
     {
       this.setLayout(new FlowLayout());
       this.add(cmb_assSeq);
+      this.add(lbl_associateSeq);
       cmb_assSeq.setToolTipText(MessageManager
               .getString("info.associate_wit_sequence"));
       cmb_assSeq.addItemListener(this);
@@ -400,7 +649,7 @@ public abstract class GStructureChooser extends JPanel implements
 
     public void loadCmbAssSeq()
     {
-      populateCmbAssociateSeqOptions(cmb_assSeq);
+      populateCmbAssociateSeqOptions(cmb_assSeq, lbl_associateSeq);
     }
 
     public JComboBox<AssociateSeqOptions> getCmb_assSeq()
@@ -441,7 +690,11 @@ public abstract class GStructureChooser extends JPanel implements
   protected abstract void txt_search_ActionPerformed();
 
   public abstract void populateCmbAssociateSeqOptions(
-          JComboBox<AssociateSeqOptions> cmb_assSeq);
+          JComboBox<AssociateSeqOptions> cmb_assSeq, JLabel lbl_associateSeq);
 
   public abstract void cmbAssSeqStateChanged();
+
+  public abstract void tabRefresh();
+
+  public abstract void validateSelections();
 }